Expand description

CloudTrail

This is the CloudTrail API Reference. It provides descriptions of actions, data types, common parameters, and common errors for CloudTrail.

CloudTrail is a web service that records Amazon Web Services API calls for your Amazon Web Services account and delivers log files to an Amazon S3 bucket. The recorded information includes the identity of the user, the start time of the Amazon Web Services API call, the source IP address, the request parameters, and the response elements returned by the service.

As an alternative to the API, you can use one of the Amazon Web Services SDKs, which consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .NET, iOS, Android, etc.). The SDKs provide programmatic access to CloudTrail. For example, the SDKs handle cryptographically signing requests, managing errors, and retrying requests automatically. For more information about the Amazon Web Services SDKs, including how to download and install them, see Tools to Build on Amazon Web Services.

See the CloudTrail User Guide for information about the data that is included with each Amazon Web Services API call listed in the log files.

Crate Organization

The entry point for most customers will be Client. Client exposes one method for each API offered by the service.

Some APIs require complex or nested arguments. These exist in model.

Lastly, errors that can be returned by the service are contained within error. Error defines a meta error encompassing all possible errors that can be returned by the service.

The other modules within this crate are not required for normal usage.

Modules

Client and fluent builders for calling the service.
Configuration for the service.
Endpoint resolution functionality
All error types that operations can return. Documentation on these types is copied from the model.
Input structures for operations. Documentation on these types is copied from the model.
Base Middleware Stack
Data structures used by operation inputs/outputs. Documentation on these types is copied from the model.
All operations that this crate can perform.
Output structures for operations. Documentation on these types is copied from the model.
Paginators for the service
Data primitives referenced by other data types.

Structs

App name that can be configured with an AWS SDK client to become part of the user agent string.
Client for AWS CloudTrail
Service config.
AWS SDK Credentials
EndpointDeprecated
API Endpoint
The region to send requests to.

Enums

All possible error types for this service.

Statics

Crate version number.