Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

Connecteur Action APIs

Le connecteur Action APIs vous permet de créer et de gérer par programmation des connexions entre Amazon Quick et des services externes. Ils APIs prennent en charge la fonctionnalité d'intégration des actions qui permet aux utilisateurs d'effectuer des actions dans des applications tierces directement à partir des interfaces de chat Amazon Quick et des flux de travail automatisés.

Qu'est-ce qu'un connecteur d'action APIs ?

Les connecteurs d'action constituent les ressources de base qui permettent l'intégration aux applications propriétaires et tierces. Vous pouvez ainsi vous authentifier auprès des applications, gérer les autorisations et contrôler les actions disponibles pour les utilisateurs dans vos applications Amazon Quick. APIs

Comment les connecteurs d'action APIs prennent en charge les intégrations d'actions

Le connecteur Action APIs fournit l'infrastructure principale pour les intégrations Amazon Quick Action. Lorsque vous créez un connecteur d'action via l'API, vous établissez une connexion sécurisée qui vous permet de :

Ils APIs gèrent les flux d'authentification complexes, la gestion des informations d'identification et les contrôles d'autorisation nécessaires pour connecter en toute sécurité Amazon Quick à des services externes.

Méthodes d’authentification

Le connecteur Action APIs prend en charge plusieurs méthodes d'authentification pour répondre aux différents cas d'utilisation et aux exigences de sécurité :

Authentification gérée (3LO)

Three-Legged OAuth fournit la configuration la plus simple pour un accès personnel à des services tiers :

Service-to-service authentification (2LO)

Pour les intégrations d'entreprise complexes :

Authentification par clé d'API

Authentification simplifiée pour les flux de travail automatisés :

Authentification de base

L'authentification de base fournit une méthode username/password d'authentification simple :

Aucune

Aucune authentification requise :

Autorisations et contrôle d'accès

Action Connector APIs implémente des contrôles d'autorisation complets via des listes de contrôle d'accès (ACLs) :

Autorisations de niveau ressource

Opérations d'API pour la gestion des autorisations

Catégories de connecteurs prises en charge

Connecteurs à double usage

Ces connecteurs prennent en charge à la fois les intégrations d'actions et la création de bases de connaissances :

Connecteurs actionnels uniquement

Spécialisé pour l'exécution d'actions sans fonctionnalités de base de connaissances :

Connecteurs basés uniquement sur la base de connaissances

Axé sur l'intégration de la base de connaissances sans capacités d'action :

Gestion du cycle de vie des API

Gestion des informations d’identification

mises à jour de connexion

Utilisez l'UpdateActionConnectorAPI pour :

Surveillance et résolution des problèmes

Limitation des taux et quotas

Le connecteur Action APIs implémente une limitation de débit d' AWS API standard :

Prise en charge intercompte

Pour les connecteurs Amazon S3, ils APIs prennent en charge l'accès entre comptes :

Gestion des erreurs et résolution des problèmes

Le connecteur Action APIs renvoie des réponses AWS d'erreur standard :

Types d'erreurs courants

Mettez en œuvre une gestion appropriée des erreurs dans vos applications afin de gérer ces scénarios avec élégance et de fournir des commentaires pertinents aux utilisateurs.

Utilisation d'Action Connector APIs avec une AWS CLI

Vous pouvez utiliser la AWS CLI pour gérer les connecteurs d'action par programmation. Les exemples suivants illustrent les opérations courantes utilisant des valeurs d'espace réservé génériques.

Création d'un connecteur d'action

Utilisez la create-action-connector commande pour créer un nouveau connecteur d'action à intégrer à des services externes.

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"
            

Liste des connecteurs d'action

Utilisez la list-action-connectors commande pour récupérer tous les connecteurs d'action de votre compte.

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

Décrire un connecteur d'action

Utilisez la describe-action-connector commande pour obtenir des informations détaillées sur un connecteur d'action spécifique.

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

Mettre à jour un connecteur d'action

Utilisez la update-action-connector commande pour modifier la configuration d'un connecteur d'action existant.

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"
            

Recherche de connecteurs d'action

Utilisez la search-action-connectors commande pour rechercher des connecteurs d'action en fonction de critères spécifiques.

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"
            

Gestion des autorisations du connecteur d'action

Utilisez la update-action-connector-permissions commande pour accorder ou révoquer des autorisations pour un connecteur d'action.

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"
            

Afficher les autorisations du connecteur Action

Utilisez la describe-action-connector-permissions commande pour afficher les autorisations actuelles pour un connecteur d'action.

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

Supprimer un connecteur d'action

Utilisez la delete-action-connector commande pour supprimer un connecteur d'action de votre compte.

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

Étapes suivantes

Après avoir compris Action Connector APIs, vous pouvez :