翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

アクションコネクタ APIs

アクションコネクタ APIsを使用すると、Amazon Quick と外部サービス間の接続をプログラムで作成および管理できます。これらの APIs、ユーザーが Amazon Quick Chat Interface と自動ワークフローから直接サードパーティーアプリケーションでアクションを実行できるようにするアクション統合機能をサポートしています。

アクションコネクタ APIs

アクションコネクタは、ファーストパーティおよびサードパーティーアプリケーションとの統合を可能にする基本的なリソースとして機能します。これらの APIs を使用して、アプリケーションへの認証、アクセス許可の管理、Amazon Quick アプリケーション内のユーザーが使用できるアクションの制御を行うことができます。

アクションコネクタ APIsアクション統合をサポートする方法

アクションコネクタ APIs、Amazon Quick アクション統合のバックエンドインフラストラクチャを提供します。API を使用してアクションコネクタを作成する場合、以下を可能にする安全な接続を確立します。

APIs、Amazon Quick を外部サービスに安全に接続するために必要な複雑な認証フロー、認証情報管理、およびアクセス許可コントロールを処理します。

認証方法

アクションコネクタ APIs、さまざまなユースケースとセキュリティ要件に対応するために、複数の認証方法をサポートしています。

マネージド認証 (3LO)

Three-Legged OAuth は、サードパーティーのサービスへの個人アクセスのための最も簡単なセットアップを提供します。

Service-to-service認証 (2LO)

複雑なエンタープライズ統合の場合:

API キー認証

自動ワークフローの認証が簡素化されました。

基本的な認証

基本認証は、シンプルなユーザー名/パスワード認証方法を提供します。

なし

認証は必要ありません。

アクセス許可とアクセスコントロール

アクションコネクタ APIs、アクセスコントロールリスト (ACLs。

リソースレベルのアクセス許可

アクセス許可管理のための API オペレーション

サポートされているコネクタカテゴリ

多目的コネクタ

これらのコネクタは、アクション統合とナレッジベースの作成の両方をサポートします。

アクションのみのコネクタ

ナレッジベース機能のないアクション実行に特化:

ナレッジベース専用コネクタ

アクション機能のないナレッジベースの統合に焦点を当てます。

API ライフサイクル管理

認証情報管理

接続の更新

UpdateActionConnector API を使用して以下を行います。

モニタリングとトラブルシューティング

レート制限とクォータ

アクションコネクタ APIs、標準の AWS API レート制限を実装します。

クロスアカウントのサポート

Amazon S3 コネクタの場合、APIsクロスアカウントアクセスをサポートします。

エラー処理とトラブルシューティング

アクションコネクタ APIs、標準 AWS エラーレスポンスを返します。

一般的なエラータイプ

アプリケーションに適切なエラー処理を実装して、これらのシナリオを適切に管理し、ユーザーに有意義なフィードバックを提供します。

CLI での Action Connector APIs AWS

AWS CLI を使用して、アクションコネクタをプログラムで管理できます。次の例は、汎用プレースホルダー値を使用した一般的なオペレーションを示しています。

アクションコネクタの作成

create-action-connector コマンドを使用して、外部サービスと統合するための新しいアクションコネクタを作成します。

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"
            

アクションコネクタの一覧表示

list-action-connectors コマンドを使用して、アカウント内のすべてのアクションコネクタを取得します。

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

アクションコネクタの説明

describe-action-connector コマンドを使用して、特定のアクションコネクタに関する詳細情報を取得します。

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

アクションコネクタの更新

update-action-connector コマンドを使用して、既存のアクションコネクタの設定を変更します。

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"
            

アクションコネクタの検索

search-action-connectors コマンドを使用して、特定の条件に基づいてアクションコネクタを検索します。

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"
            

アクションコネクタのアクセス許可の管理

update-action-connector-permissions コマンドを使用して、アクションコネクタのアクセス許可を付与または取り消します。

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"
            

アクションコネクタのアクセス許可の表示

describe-action-connector-permissions コマンドを使用して、アクションコネクタの現在のアクセス許可を表示します。

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

アクションコネクタの削除

delete-action-connector コマンドを使用して、アカウントからアクションコネクタを削除します。

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

次の手順

アクションコネクタ APIsを理解したら、次のことができます。