aws-sdk-controltower

Amazon Web Services Control Tower 提供支持程序化交互这些类型资源的应用程序编程接口 (API) 操作

• 控制

  • 禁用控制
  • 启用控制
  • 获取已启用的控制
  • 列出控制操作
  • 列出已启用的控制
  • 更新已启用的控制

• 着陆区

  • 创建着陆区
  • 删除着陆区
  • 获取着陆区
  • 获取着陆区操作
  • 列出着陆区
  • 列出着陆区操作
  • 重置着陆区
  • 更新着陆区

• 基线

  • 禁用基线
  • 启用基线
  • 获取基线
  • 获取基线操作
  • 获取已启用的基线
  • 列出基线
  • 列出已启用的基线
  • 重置已启用的基线
  • 更新已启用的基线

• 标签

  • 列出资源标签
  • 标记资源
  • 取消标记资源

有关这些类型资源的更多信息，请参阅 Amazon Web Services Control Tower 用户指南。

关于控制 API

这些接口允许您以程序化的方式将 Amazon Web Services 库中预定义的 控制 应用于您的组织单元。在 Amazon Web Services Control Tower 中，“控制”和“护栏”是同义词。

要调用这些 API，您需要知道

• 目标控制（或护栏）的控制标识符。
• 与目标组织单元（OU）关联的 ARN，我们称之为目标标识符。
• 与您希望标记或取消标记的资源关联的 ARN。

要获取 Amazon Web Services Control Tower 控制的控制标识符

控制标识符是为每个控制指定的 ARN。您可以在控制台上的“控制详细信息”页面以及文档中查看控制标识符。

关于 Amazon Web Services Control Tower 标识符

每个Amazon Web Services区域的每个控制项的控制Identifier都是唯一的。您可以在《Amazon Web Services Control Tower 控制项参考指南》中的控制项元数据表或按区域查看控制项可用性表中找到每个区域和控制项的控制Identifier。

Amazon Web Services Control Tower的旧版强烈推荐和可选控制项的快速参考列表，可以在API和控制的资源标识符中找到，该链接位于Amazon Web Services Control Tower 控制项参考指南中。请记住，强制控制项不能添加或删除。

获取目标Identifier

目标Identifier是一个OU的ARN。

在Amazon Web Services Organizations控制台中，您可以在与该OU关联的组织单元详细信息页面上找到OU的ARN。

关于着陆区API

您可以使用API配置和启动Amazon Web Services Control Tower着陆区。有关介绍和步骤，请参阅使用API入门Amazon Web Services Control Tower。

有关着陆区API操作概述，请参阅Amazon Web Services Control Tower支持着陆区API。着陆区单个API操作在本文档中详细介绍，位于API参考手册的“操作”部分。

关于基线API

您可以将AWSControlTowerBaseline基线应用于组织单元（OU），作为将OU注册到Amazon Web Services Control Tower的编程方法。有关此功能的一般概述，请参阅Amazon Web Services Control Tower支持OU注册和配置的API。

您可以通过调用基线API操作来查看Amazon Web Services Control Tower在设置着陆区时为您启用的基线，这些基线是只读基线。

基线单个API操作在本文档中详细介绍，位于API参考手册的“操作”部分。有关使用示例，请参阅使用CLI的基线API输入和输出示例。

关于Amazon Web Services Control Catalog标识符

• 您可以通过指定Amazon Web Services Control Tower标识符或Amazon Web Services Control Catalog标识符来调用EnableControl和DisableControl API操作。API响应返回您调用API时指定的相同类型的标识符。
• 如果您使用Amazon Web Services Control Tower标识符调用EnableControl API，然后使用Amazon Web Services Control Catalog标识符再次调用EnableControl，Amazon Web Services Control Tower将返回一个错误消息，表明该控制项已启用。类似的行为也适用于DisableControl API操作。
• 强制控制项和着陆区级别的区域拒绝控制只有Amazon Web Services Control Tower标识符。

详细信息和示例

• 使用CLI的控制API输入和输出示例
• 使用CLI的基线API输入和输出示例
• 使用CloudFormation启用控制项
• 使用CloudFormation启动着陆区
• 控制项元数据表（大页面）
• 按区域控制可用性的表格（大页面）
• 旧版控制的标识符列表
• 控制参考指南
• 控制库分组
• 使用Amazon Web Services CloudFormation创建Amazon Web Services Control Tower资源

要查看GitHub上的开源资源存储库，请参阅aws-cloudformation/aws-cloudformation-resource-providers-controltower

记录API请求

Amazon Web Services Control Tower支持Amazon Web Services CloudTrail，这是一种记录您的Amazon Web Services账户的Amazon Web Services API调用并将日志文件发送到Amazon S3存储桶的服务。通过使用CloudTrail收集的信息，您可以确定Amazon Web Services Control Tower服务接收了哪些请求，谁发起的请求以及何时发起的请求等等。有关Amazon Web Services Control Tower及其对CloudTrail的支持的更多信息，请参阅Amazon Web Services Control Tower用户指南中的使用Amazon Web Services CloudTrail记录Amazon Web Services Control Tower操作。要了解更多关于CloudTrail的信息，包括如何启用它以及如何找到您的日志文件，请参阅Amazon Web Services CloudTrail用户指南。

入门指南

许多服务和操作都提供了示例，请查看GitHub上的示例文件夹。

SDK为每个AWS服务提供一个crate。您必须在Rust项目中将Tokio作为依赖项添加，以执行异步代码。要将aws-sdk-controltower添加到您的项目中，请将以下内容添加到您的Cargo.toml文件中

[dependencies]
aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }
aws-sdk-controltower = "1.42.0"
tokio = { version = "1", features = ["full"] }

然后在代码中，可以使用以下方式创建客户端

use aws_sdk_controltower as controltower;

#[::tokio::main]
async fn main() -> Result<(), controltower::Error> {
    let config = aws_config::load_from_env().await;
    let client = aws_sdk_controltower::Client::new(&config);

    // ... make some calls with the client

    Ok(())
}

有关可以调用的调用以及每个调用的输入和输出的信息，请参阅客户端文档。

使用SDK

在SDK发布之前，我们将向开发人员指南中添加有关使用SDK的信息。请随时通过提交问题并描述您正在尝试执行的操作来提出指南的额外部分。

获取帮助

• GitHub讨论 - 用于想法、RFC和一般问题
• GitHub问题 - 用于错误报告和功能请求
• 生成的文档（最新版本）
• 使用示例

许可协议

本项目采用Apache-2.0许可协议。