Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

APIs für Aktionskonnektoren

Mit Action Connector-APIs können Sie programmgesteuert Verbindungen zwischen Amazon Quick und externen Services erstellen und verwalten. Diese APIs unterstützen die Aktionsintegrationsfunktion, mit der Benutzer Aktionen in Drittanbieteranwendungen direkt über Amazon Quick Chat-Benutzeroberflächen und automatisierte Workflows ausführen können.

Was sind Action Connector-APIs?

Action Connectors dienen als grundlegende Ressourcen, die die Integration mit Anwendungen von Erst- und Drittanbietern ermöglichen. Über diese APIs können Sie sich bei Anwendungen authentifizieren, Berechtigungen verwalten und kontrollieren, welche Aktionen Benutzern in Ihren Amazon Quick-Anwendungen zur Verfügung stehen.

Wie Action Connector-APIs Aktionsintegrationen unterstützen

Action Connector-APIs stellen die Backend-Infrastruktur für Amazon Quick Action-Integrationen bereit. Wenn Sie über die API einen Action-Connector erstellen, stellen Sie eine sichere Verbindung her, mit der Sie:

Die APIs verarbeiten die komplexen Authentifizierungsabläufe, die Verwaltung von Anmeldeinformationen und die Berechtigungskontrollen, die für eine sichere Verbindung von Amazon Quick mit externen Diensten erforderlich sind.

Authentifizierungsmethoden

Action Connector-APIs unterstützen mehrere Authentifizierungsmethoden, um unterschiedlichen Anwendungsfällen und Sicherheitsanforderungen gerecht zu werden:

Verwaltete Authentifizierung (3LO)

Three-Legged OAuth bietet die einfachste Einrichtung für den persönlichen Zugriff auf Dienste von Drittanbietern:

Service-to-service Authentifizierung (2LO)

Für komplexe Unternehmensintegrationen:

API-Schlüsselauthentifizierung

Vereinfachte Authentifizierung für automatisierte Workflows:

Grundlegende Authentifizierung

Die Standardauthentifizierung bietet eine einfache username/password Authentifizierungsmethode:

Keine

Keine Authentifizierung erforderlich:

Berechtigungen und Zugriffskontrolle

Action Connector-APIs implementieren umfassende Berechtigungskontrollen über Zugriffskontrolllisten (ACLs):

Resource-level Berechtigungen

API-Operationen für die Rechteverwaltung

Unterstützte Connector-Kategorien

Dual-purpose Anschlüsse

Diese Konnektoren unterstützen sowohl die Integration von Aktionen als auch die Erstellung von Wissensdatenbanken:

Action-only Anschlüsse

Spezialisiert auf die Ausführung von Aktionen ohne Knowledge-Base-Funktionen:

Konnektoren, die nur für die Wissensdatenbank bestimmt sind

Konzentriert sich auf die Integration von Wissensdatenbanken ohne Handlungsmöglichkeiten:

Verwaltung des API-Lebenszyklus

Verwalten von Anmeldeinformationen

Verbindungsaktualisierungen

Verwenden Sie die UpdateActionConnector API, um:

Überwachung und Problembehandlung

Ratenbegrenzung und Kontingente

Action Connector-APIs implementieren eine standardmäßige AWS API-Ratenbegrenzung:

Cross-account Unterstützung

Für Amazon S3 S3-Konnektoren unterstützen die APIs den kontoübergreifenden Zugriff:

Fehlerbehandlung und -behebung

Action Connector-APIs geben AWS Standardfehlerantworten zurück:

Häufige Fehlertypen

Implementieren Sie eine angemessene Fehlerbehandlung in Ihren Anwendungen, um diese Szenarien ordnungsgemäß zu verwalten und den Benutzern aussagekräftiges Feedback zu geben.

Verwenden von Action Connector-APIs mit AWS CLI

Sie können die AWS CLI verwenden, um Action Connectors programmgesteuert zu verwalten. Die folgenden Beispiele veranschaulichen gängige Operationen mit generischen Platzhalterwerten.

Einen Aktionskonnektor erstellen

Verwenden Sie den create-action-connector Befehl, um einen neuen Aktionsconnector für die Integration mit externen Diensten zu erstellen.

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"
            

Aktionskonnektoren auflisten

Verwenden Sie den list-action-connectors Befehl, um alle Action-Connectors in Ihrem Konto abzurufen.

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

Beschreibung eines Action-Connectors

Verwenden Sie den describe-action-connector Befehl, um detaillierte Informationen zu einem bestimmten Aktionskonnektor abzurufen.

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

Aktualisierung eines Aktionskonnektors

Verwenden Sie den update-action-connector Befehl, um die Konfiguration eines vorhandenen Aktionskonnektors zu ändern.

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"
            

Nach Action-Konnektoren suchen

Verwenden Sie den search-action-connectors Befehl, um Aktionskonnektoren anhand bestimmter Kriterien zu finden.

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"
            

Verwaltung von Action-Connector-Berechtigungen

Verwenden Sie den update-action-connector-permissions Befehl, um Berechtigungen für einen Action Connector zu gewähren oder zu widerrufen.

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"
            

Berechtigungen für den Action Connector anzeigen

Verwenden Sie den describe-action-connector-permissions Befehl, um die aktuellen Berechtigungen für einen Action Connector anzuzeigen.

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

Löschen eines Aktionskonnektors

Verwenden Sie den delete-action-connector Befehl, um einen Action-Connector aus Ihrem Konto zu entfernen.

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

Nächste Schritte

Nachdem Sie sich mit den Action Connector-APIs vertraut gemacht haben, können Sie: