As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.

APIs do conector de ação

As APIs do Action Connector permitem que você crie e gerencie programaticamente conexões entre o Amazon Quick e serviços externos. Essas APIs oferecem suporte à funcionalidade de integração de ações que permite aos usuários realizar ações em aplicativos de terceiros diretamente das interfaces de chat e fluxos de trabalho automatizados do Amazon Quick.

O que são APIs do conector de ação?

Os conectores de ação servem como recursos fundamentais que permitem a integração com aplicativos próprios e de terceiros. Por meio dessas APIs, você pode se autenticar em aplicativos, gerenciar permissões e controlar quais ações estão disponíveis para os usuários em seus aplicativos Amazon Quick.

Como as APIs do conector de ação oferecem suporte às integrações de ações

As APIs do Action Connector fornecem a infraestrutura de back-end para as integrações do Amazon Quick Action. Ao criar um conector de ação por meio da API, você estabelece uma conexão segura que permite:

As APIs lidam com os complexos fluxos de autenticação, gerenciamento de credenciais e controles de permissão necessários para conectar com segurança o Amazon Quick a serviços externos.

Métodos de autenticação

As APIs do Action Connector oferecem suporte a vários métodos de autenticação para acomodar diferentes casos de uso e requisitos de segurança:

Autenticação gerenciada (3LO)

Three-Legged O OAuth fornece a configuração mais simples para acesso pessoal a serviços de terceiros:

Service-to-service autenticação (2LO)

Para integrações corporativas complexas:

Autenticação de chave de API

Autenticação simplificada para fluxos de trabalho automatizados:

Autenticação básica

A autenticação básica fornece um método username/password de autenticação simples:

Nenhum

Nenhuma autenticação é necessária:

Permissões e controle de acesso

As APIs do conector de ação implementam controles de permissão abrangentes por meio de listas de controle de acesso (ACLs):

Resource-level permissões

Operações de API para gerenciamento de permissões

Categorias de conectores suportadas

Dual-purpose conectores

Esses conectores oferecem suporte a integrações de ações e à criação de base de conhecimento:

Action-only conectores

Especializado para execução de ações sem recursos de base de conhecimento:

Conectores somente para a base de conhecimento

Focado na integração da base de conhecimento sem recursos de ação:

Gerenciamento do ciclo de vida da API

Gerenciamento de credenciais

Atualizações de conexão

Use a UpdateActionConnector API para:

Monitoramento e solução de problemas

Limitação de tarifas e cotas

As APIs do conector de ação implementam a limitação de taxa de AWS API padrão:

Cross-account apoio

Para conectores Amazon S3, as APIs oferecem suporte ao acesso entre contas:

Tratamento de erros e solução de problemas

As APIs do conector de ação retornam respostas AWS de erro padrão:

Tipos de erro comuns

Implemente o tratamento adequado de erros em seus aplicativos para gerenciar esses cenários com elegância e fornecer feedback significativo aos usuários.

Usando APIs do Action Connector com CLI AWS

Você pode usar a AWS CLI para gerenciar os conectores de ação de forma programática. Os exemplos a seguir demonstram operações comuns usando valores genéricos de espaço reservado.

Criando um conector de ação

Use o create-action-connector comando para criar um novo conector de ação para integração com serviços externos.

aws quicksight create-action-connector \
  --aws-account-id "123456789012" \
  --name "MyS3Connector" \
  --action-connector-id "my-s3-connector-id" \
  --type "AMAZON_S3" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/MyConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" \
  --description "S3 connector for automation workflows" \
  --region "us-east-1"
            

Listando conectores de ação

Use o list-action-connectors comando para recuperar todos os conectores de ação em sua conta.

aws quicksight list-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 10 \
  --region "us-east-1"
            

Descrevendo um conector de ação

Use o describe-action-connector comando para obter informações detalhadas sobre um conector de ação específico.

aws quicksight describe-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
            

Atualizando um conector de ação

Use o update-action-connector comando para modificar a configuração de um conector de ação existente.

aws quicksight update-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --name "UpdatedS3Connector" \
  --authentication-config '{
    "AuthenticationType": "IAM",
    "AuthenticationMetadata": {
      "IamConnectionMetadata": {
        "RoleArn": "arn:aws:iam::123456789012:role/UpdatedConnectorRole"
      }
    }
  }' \
  --enabled-actions "CreateBucket" "ListBuckets" "DeleteBucket" \
  --region "us-east-1"
            

Pesquisando conectores de ação

Use o search-action-connectors comando para encontrar conectores de ação com base em critérios específicos.

aws quicksight search-action-connectors \
  --aws-account-id "123456789012" \
  --max-results 5 \
  --filters '[{
    "Name": "ACTION_CONNECTOR_NAME",
    "Operator": "StringLike",
    "Value": "S3"
  }]' \
  --region "us-east-1"
            

Gerenciando permissões do conector de ação

Use o update-action-connector-permissions comando para conceder ou revogar permissões para um conector de ação.

aws quicksight update-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --grant-permissions '[{
    "Actions": [
      "quicksight:DescribeActionConnector",
      "quicksight:UpdateActionConnector",
      "quicksight:DeleteActionConnector"
    ],
    "Principal": "arn:aws:quicksight:us-east-1:123456789012:user/default/myuser"
  }]' \
  --region "us-east-1"
            

Visualizando as permissões do conector de ação

Use o describe-action-connector-permissions comando para visualizar as permissões atuais de um conector de ação.

aws quicksight describe-action-connector-permissions \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
            

Excluindo um conector de ação

Use o delete-action-connector comando para remover um conector de ação da sua conta.

aws quicksight delete-action-connector \
  --aws-account-id "123456789012" \
  --action-connector-id "my-s3-connector-id" \
  --region "us-east-1"
            

Próximas etapas

Depois de entender as APIs do conector de ação, você pode: