本文属于机器翻译版本。若本译文内容与英语原文存在差异，则一律以英文原文为准。

操作连接器 API

操作连接器 API 允许您以编程方式创建和管理 Amazon Quick 与外部服务之间的连接。这些 API 支持操作集成功能，允许用户直接通过 Amazon Quick 聊天界面和自动工作流程在第三方应用程序中执行操作。

什么是操作连接器 API？

操作连接器是支持与第一方和第三方应用程序集成的基础资源。通过这些 API，您可以对应用程序进行身份验证、管理权限并控制用户可以在 Amazon Quick 应用程序中执行哪些操作。

操作连接器 API 如何支持动作集成

操作连接器 API 为 Amazon 快速操作集成提供了后端基础架构。当你通过 API 创建操作连接器时，你会建立一个安全的连接，让你：

这些 API 处理安全连接 Amazon Quick 与外部服务所需的复杂身份验证流程、证书管理和权限控制。

身份验证方法

操作连接器 API 支持多种身份验证方法，以适应不同的用例和安全要求：

托管身份验证 (3LO)

Three-Legged OAuth 为个人访问第三方服务提供了最简单的设置：

Service-to-service 身份验证 (2LO)

对于复杂的企业集成：

API 密钥身份验证

简化了自动化工作流程的身份验证：

基本身份验证

基本身份验证提供了一种简单的 username/password 身份验证方法：

无

无需身份验证：

权限和访问控制

操作连接器 API 通过访问控制列表 (ACL) 实现全面的权限控制：

Resource-level 权限

用于权限管理的 API 操作

支持的连接器类别

Dual-purpose 连接器

这些连接器支持操作集成和知识库创建：

Action-only 连接器

专门用于在没有知识库功能的情况下执行动作：

仅限知识库的连接器

专注于没有操作功能的知识库集成：

API 生命周期管理

凭证管理

连接更新

使用 UpdateActionConnector API 执行以下操作：

监控和排查

速率限制和配额

操作连接器 API 实现了标准 AWS 的 API 速率限制：

Cross-account 支持

对于 Amazon S3 连接器，这些 API 支持跨账户访问：

错误处理和故障排除

操作连接器 API 返回标准 AWS 错误响应：

常见错误类型

在应用程序中实施适当的错误处理，以优雅地管理这些场景并为用户提供有意义的反馈。

将操作连接器 API 与 AWS CLI 配合使用

您可以使用 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"
            

后续步骤

了解操作连接器 API 后，您可以：