Expand description
Welcome to the Audit Manager API reference. This guide is for developers who need detailed information about the Audit Manager API operations, data types, and errors.
Audit Manager is a service that provides automated evidence collection so that you can continually audit your Amazon Web Services usage. You can use it to assess the effectiveness of your controls, manage risk, and simplify compliance.
Audit Manager provides prebuilt frameworks that structure and automate assessments for a given compliance standard. Frameworks include a prebuilt collection of controls with descriptions and testing procedures. These controls are grouped according to the requirements of the specified compliance standard or regulation. You can also customize frameworks and controls to support internal audits with specific requirements.
Use the following links to get started with the Audit Manager API:
- Actions: An alphabetical list of all Audit Manager API operations.
- Data types: An alphabetical list of all Audit Manager data types.
- Common parameters: Parameters that all operations can use.
- Common errors: Client and server errors that all operations can return.
If you’re new to Audit Manager, we recommend that you review theAudit Manager User Guide.
§Getting Started
Examples are available for many services and operations, check out theexamples folder in GitHub.
The SDK provides one crate per AWS service. You must addTokioas a dependency within your Rust project to execute asynchronous code. To addaws-sdk-auditmanager
toyour project, add the following to yourCargo.toml file:
[dependencies]aws-config = { version = "1.1.7", features = ["behavior-version-latest"] }aws-sdk-auditmanager = "1.65.0"tokio = { version = "1", features = ["full"] }
Then in code, a client can be created with the following:
useaws_sdk_auditmanagerasauditmanager;#[::tokio::main]async fnmain() ->Result<(), auditmanager::Error> {letconfig = aws_config::load_from_env().await;letclient = aws_sdk_auditmanager::Client::new(&config);// ... make some calls with the clientOk(())}
See theclient documentationfor information on what calls can be made, and the inputs and outputs for each of those calls.
§Using the SDK
Until the SDK is released, we will be adding information about using the SDK to theDeveloper Guide. Feel free to suggestadditional sections for the guide by opening an issue and describing what you are trying to do.
§Getting Help
- GitHub discussions - For ideas, RFCs & general questions
- GitHub issues - For bug reports & feature requests
- Generated Docs (latest version)
- Usage examples
§Crate Organization
The entry point for most customers will beClient
, which exposes one method for each APIoffered by AWS Audit Manager. The return value of each of these methods is a “fluent builder”,where the different inputs for that API are added by builder-style function call chaining,followed by callingsend()
to get aFuture
that will result ineither a successful output or aSdkError
.
Some of these API inputs may be structs or enums to provide more complex structured information.These structs and enums live intypes
. There are some simpler types forrepresenting data such as date times or binary blobs that live inprimitives
.
All types required to configure a client via theConfig
struct liveinconfig
.
Theoperation
module has a submodule for every API, and in each submoduleis the input, output, and error type for that API, as well as builders to construct each of those.
There is a top-levelError
type that encompasses all the errors that theclient can return. Any other error type can be converted to thisError
type via theFrom
trait.
The other modules within this crate are not required for normal usage.
Modules§
- client
- Client for calling AWS Audit Manager.
- config
- Configuration for AWS Audit Manager.
- error
- Common errors and error handling utilities.
- meta
- Information about this crate.
- operation
- All operations that this crate can perform.
- primitives
- Primitives such as
Blob
orDateTime
used by other types. - types
- Data structures used by operation inputs/outputs.
Structs§
Enums§
- Error
- All possible error types for this service.