Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

API de Action Connector

Las API de Action Connector le permiten crear y gestionar mediante programación las conexiones entre Amazon Quick y los servicios externos. Estas API admiten la funcionalidad de integración de acciones que permite a los usuarios realizar acciones en aplicaciones de terceros directamente desde las interfaces de chat rápido de Amazon y los flujos de trabajo automatizados.

¿Qué son las API de Action Connector?

Los conectores de acción son los recursos fundamentales que permiten la integración con aplicaciones propias y de terceros. A través de estas API, puede autenticarse en las aplicaciones, gestionar los permisos y controlar qué acciones están disponibles para los usuarios en sus aplicaciones de Amazon Quick.

Cómo las API de Action Connector respaldan las integraciones de acciones

Las API de Action Connector proporcionan la infraestructura de backend para las integraciones de Amazon Quick Action. Cuando crea un conector de acciones a través de la API, establece una conexión segura que le permite:

Las API gestionan los complejos flujos de autenticación, la administración de credenciales y los controles de permisos necesarios para conectar Amazon Quick con servicios externos de forma segura.

Métodos de autenticación

Las API de Action Connector admiten varios métodos de autenticación para adaptarse a diferentes casos de uso y requisitos de seguridad:

Autenticación gestionada (3LO)

Three-Legged OAuth proporciona la configuración más sencilla para el acceso personal a servicios de terceros:

Service-to-service autenticación (2LO)

Para integraciones empresariales complejas:

Autenticación de la clave de API

Autenticación simplificada para flujos de trabajo automatizados:

Autenticación básica

La autenticación básica proporciona un método de username/password autenticación sencillo:

Ninguno

No se requiere autenticación:

Permisos y control de acceso

Las API de Action Connector implementan controles de permisos exhaustivos a través de listas de control de acceso (ACL):

Resource-level permisos

Operaciones de API para la administración de permisos

Categorías de conectores compatibles

Dual-purpose conectores

Estos conectores admiten tanto la integración de acciones como la creación de bases de conocimientos:

Action-only conectores

Especializados para la ejecución de acciones sin capacidades de base de conocimientos:

Conectores exclusivos para la base de conocimientos

Centrado en la integración de la base de conocimientos sin capacidades de acción:

Gestión del ciclo de vida de API

Administración de credenciales

Actualizaciones de conexión

Usa la UpdateActionConnector API para:

Supervisión y solución de problemas

Límites de velocidad y cuotas

Las API Action Connector implementan una limitación de velocidad de AWS API estándar:

Cross-account soporte

En el caso de los conectores Amazon S3, las API admiten el acceso entre cuentas:

Gestión de errores y solución de problemas

Las API de Action Connector devuelven respuestas AWS de error estándar:

Tipos de errores comunes

Implemente una gestión de errores adecuada en sus aplicaciones para gestionar estos escenarios de forma adecuada y proporcionar comentarios significativos a los usuarios.

Uso de las API de Action Connector con AWS CLI

Puede usar la AWS CLI para administrar los conectores de acciones mediante programación. Los siguientes ejemplos muestran operaciones comunes que utilizan valores de marcador de posición genéricos.

Creación de un conector de acciones

Utilice el create-action-connector comando para crear un nuevo conector de acciones para integrarlo con servicios 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"
            

Listado de conectores de acción

Usa el list-action-connectors comando para recuperar todos los conectores de acción de tu cuenta.

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

Describir un conector de acción

Utilice el describe-action-connector comando para obtener información detallada sobre un conector de acción específico.

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

Actualización de un conector de acción

Utilice el update-action-connector comando para modificar la configuración de un conector de acciones 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"
            

Búsqueda de conectores de acciones

Utilice el search-action-connectors comando para buscar conectores de acciones en función de criterios 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"
            

Administrar los permisos de los conectores de acciones

Utilice el update-action-connector-permissions comando para conceder o revocar los permisos de un conector de acciones.

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"
            

Visualización de los permisos del conector de acciones

Utilice el describe-action-connector-permissions comando para ver los permisos actuales de un conector de acciones.

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

Eliminar un conector de acciones

Usa el delete-action-connector comando para eliminar un conector de acciones de tu cuenta.

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

Siguientes pasos

Tras comprender las API de Action Connector, podrá: