Please Note: The SDK is currently in Developer Preview and is intended strictly for feedback purposes only. Do not use this SDK for production workloads.
These interfaces allow you to apply the AWS library of pre-defined controls to your organizational units, programmatically. In this context, controls are the same as AWS Control Tower guardrails.
To call these APIs, you'll need to know: - the ControlARN for the control--that is, the guardrail--you are targeting, - and the ARN associated with the target organizational unit (OU).
To get the ControlARN for your AWS Control Tower guardrail:
The ControlARN contains the control name which is specified in each guardrail. For a list of control names for Strongly recommended and Elective guardrails, see Resource identifiers for APIs and guardrails in the Automating tasks section of the AWS Control Tower User Guide. Remember that Mandatory guardrails cannot be added or removed.
To get the ARN for an OU:
In the AWS Organizations console, you can find the ARN for the OU on the Organizational unit details page associated with that OU.
Details and examples - List of resource identifiers for APIs and guardrails - Guardrail API examples (CLI) - Enable controls with AWS CloudFormation - Creating AWS Control Tower resources with AWS CloudFormation
To view the open source resource repository on GitHub, see aws-cloudformation/aws-cloudformation-resource-providers-controltower
Recording API Requests
AWS Control Tower supports AWS CloudTrail, a service that records AWS API calls for your AWS account and delivers log files to an Amazon S3 bucket. By using information collected by CloudTrail, you can determine which requests the AWS Control Tower service received, who made the request and when, and so on. For more about AWS Control Tower and its support for CloudTrail, see Logging AWS Control Tower Actions with AWS CloudTrail in the AWS Control Tower User Guide. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide.
Examples are available for many services and operations, check out the examples folder in GitHub.
The SDK provides one crate per AWS service. You must add Tokio
as a dependency within your Rust project to execute asynchronous code. To add aws-sdk-controltower to
your project, add the following to your Cargo.toml file:
toml
[dependencies]
aws-config = "0.56.1"
aws-sdk-controltower = "0.12.0"
tokio = { version = "1", features = ["full"] }
Then in code, a client can be created with the following:
```rust,norun use awssdk_controltower as controltower;
async fn main() -> Result<(), controltower::Error> { let config = awsconfig::loadfromenv().await; let client = awssdk_controltower::Client::new(&config);
// ... make some calls with the client
Ok(())
} ```
See the client documentation for information on what calls can be made, and the inputs and outputs for each of those calls.
Until the SDK is released, we will be adding information about using the SDK to the Developer Guide. Feel free to suggest additional sections for the guide by opening an issue and describing what you are trying to do.
This project is licensed under the Apache-2.0 License.