Le traduzioni sono generate tramite traduzione automatica. In caso di conflitto tra il contenuto di una traduzione e la versione originale in Inglese, quest'ultima prevarrà.

Connettore Action APIs

Action connector APIs ti consente di creare e gestire in modo programmatico connessioni tra Amazon Quick e servizi esterni. Questi APIs supportano la funzionalità di integrazione delle azioni che consente agli utenti di eseguire azioni in applicazioni di terze parti direttamente dalle interfacce di chat di Amazon Quick e dai flussi di lavoro automatizzati.

Cosa sono gli Action Connector? APIs

I connettori Action fungono da risorse fondamentali che consentono l'integrazione con applicazioni proprietarie e di terze parti. Tramite questi APIs, puoi autenticarti alle applicazioni, gestire le autorizzazioni e controllare quali azioni sono disponibili per gli utenti all'interno delle tue applicazioni Amazon Quick.

In che modo Action Connector APIs supporta le integrazioni di azioni

Action Connector APIs fornisce l'infrastruttura di backend per le integrazioni Amazon Quick action. Quando crei un connettore di azione tramite l'API, stabilisci una connessione sicura che ti consente di:

APIs Gestiscono i complessi flussi di autenticazione, la gestione delle credenziali e i controlli delle autorizzazioni necessari per connettere in modo sicuro Amazon Quick con servizi esterni.

Metodi di autenticazione

Action Connector APIs supporta diversi metodi di autenticazione per soddisfare diversi casi d'uso e requisiti di sicurezza:

Autenticazione gestita (3LO)

Three-Legged OAuth offre la configurazione più semplice per l'accesso personale a servizi di terze parti:

Service-to-service autenticazione (2LO)

Per integrazioni aziendali complesse:

Autenticazione con chiave API

Autenticazione semplificata per flussi di lavoro automatizzati:

Autenticazione di base

L'autenticazione di base fornisce un metodo di username/password autenticazione semplice:

Nessuno

Nessuna autenticazione richiesta:

Autorizzazioni e controllo degli accessi

Action Connector APIs implementa controlli completi delle autorizzazioni tramite Access Control Lists (ACLs):

Autorizzazioni a livello di risorsa

Operazioni API per la gestione delle autorizzazioni

Categorie di connettori supportate

Connettori a doppio scopo

Questi connettori supportano sia le integrazioni di azioni che la creazione di knowledge base:

Connettori che si limitano all'azione

Specializzato per l'esecuzione di azioni senza funzionalità di knowledge base:

Connettori solo per la Knowledge Base

Incentrato sull'integrazione della knowledge base senza funzionalità di azione:

Gestione del ciclo di vita delle API

Gestione delle credenziali

Aggiornamenti della connessione

Utilizza l'UpdateActionConnectorAPI per:

Monitoraggio e risoluzione dei problemi

Limitazione della velocità e quote

Action Connector APIs implementa la limitazione della velocità AWS delle API standard:

Supporto multi-account

Per i connettori Amazon S3, APIs supportano l'accesso tra account diversi:

Gestione e risoluzione degli errori

Il connettore Action APIs restituisce risposte di errore standard AWS :

Tipi di errore comuni

Implementate una corretta gestione degli errori nelle vostre applicazioni per gestire correttamente questi scenari e fornire un feedback significativo agli utenti.

Utilizzo di Action Connector APIs con AWS CLI

È possibile utilizzare la AWS CLI per gestire i connettori di azione a livello di codice. Gli esempi seguenti illustrano le operazioni comuni che utilizzano valori segnaposto generici.

Creazione di un connettore di azione

Usa il create-action-connector comando per creare un nuovo connettore di azione per l'integrazione con servizi esterni.

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"
            

Elenco dei connettori di azione

Usa il list-action-connectors comando per recuperare tutti i connettori di azione nel tuo account.

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

Descrizione di un connettore di azione

Utilizzate il describe-action-connector comando per ottenere informazioni dettagliate su un connettore di azione specifico.

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

Aggiornamento di un connettore di azione

Utilizzate il update-action-connector comando per modificare la configurazione di un connettore di azione esistente.

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"
            

Ricerca di connettori di azione

Utilizzate il search-action-connectors comando per trovare i connettori di azione in base a criteri specifici.

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"
            

Gestione delle autorizzazioni dei connettori di azione

Usa il update-action-connector-permissions comando per concedere o revocare le autorizzazioni per un connettore di azione.

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"
            

Visualizzazione delle autorizzazioni di Action Connector

Utilizzare il describe-action-connector-permissions comando per visualizzare le autorizzazioni correnti per un connettore di azione.

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

Eliminazione di un connettore di azione

Usa il delete-action-connector comando per rimuovere un connettore di azione dal tuo account.

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

Fasi successive

Dopo aver compreso Action Connector APIs, puoi: