本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。

動作連接器 APIs

動作連接器 APIs 可讓您以程式設計方式建立和管理 Amazon Quick 和外部服務之間的連線。這些 APIs支援動作整合功能，可讓使用者直接從 Amazon Quick Chat 介面和自動化工作流程在第三方應用程式中執行動作。

什麼是動作連接器 APIs？

動作連接器可做為與第一個和第三方應用程式整合的基礎資源。透過這些 APIs，您可以對應用程式進行身分驗證、管理許可，以及控制哪些動作可供 Amazon Quick 應用程式內的使用者使用。

動作連接器 APIs如何支援動作整合

動作連接器 APIs為 Amazon Quick 動作整合提供後端基礎設施。當您透過 API 建立動作連接器時，您可以建立安全連線，讓您：

APIs 可處理安全連接 Amazon Quick 與外部服務所需的複雜身分驗證流程、憑證管理和許可控制。

身分驗證方法

動作連接器 APIs支援多種身分驗證方法，以適應不同的使用案例和安全性需求：

受管身分驗證 (3LO)

三引號 OAuth 提供對第三方服務的個人存取最簡單的設定：

Service-to-service身分驗證 (2LO)

對於複雜的企業整合：

API 金鑰身分驗證

自動化工作流程的簡化身分驗證：

基本驗證

基本身分驗證提供簡單的使用者名稱/密碼身分驗證方法：

無

不需要身分驗證：

許可和存取控制

動作連接器 APIs 透過存取控制清單 (ACLs) 實作全面的許可控制：

資源層級許可

用於許可管理的 API 操作

支援的連接器類別

雙用途連接器

這些連接器支援動作整合和知識庫建立：

僅限動作的連接器

專門用於沒有知識庫功能的動作執行：

僅限知識庫的連接器

專注於無動作功能的知識庫整合：

API 生命週期管理

憑證管理

連線更新

使用 UpdateActionConnector API 來：

監控和疑難排解

速率限制和配額

動作連接器 APIs實作標準 AWS API 速率限制：

跨帳戶支援

對於 Amazon S3 連接器，APIs支援跨帳戶存取：

錯誤處理和疑難排解

動作連接器 APIs會傳回標準 AWS 錯誤回應：

常見錯誤類型

在應用程式中實作適當的錯誤處理，以正常管理這些案例，並向使用者提供有意義的意見回饋。

搭配 CLI AWS 使用動作連接器 APIs

您可以使用 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之後，您可以：