Struct rusoto_cloudtrail::CloudTrailClient

pub struct CloudTrailClient { /* fields omitted */ }

A client for the CloudTrail API.

Methods

impl CloudTrailClient

pub fn new(region: Region) -> CloudTrailClient

Creates a client backed by the default tokio event loop.

The client will use the default credentials provider and tls client.

pub fn new_with<P, D>(
    request_dispatcher: D,
    credentials_provider: P,
    region: Region
) -> CloudTrailClient where
    P: ProvideAwsCredentials + Send + Sync + 'static,
    P::Future: Send,
    D: DispatchSignedRequest + Send + Sync + 'static,
    D::Future: Send, 

pub fn new_with_client(client: Client, region: Region) -> CloudTrailClient

Trait Implementations

impl CloudTrail for CloudTrailClient

fn add_tags(
    &self,
    input: AddTagsRequest
) -> RusotoFuture<AddTagsResponse, AddTagsError>

Adds one or more tags to a trail, up to a limit of 50. Tags must be unique per trail. Overwrites an existing tag's value when a new value is specified for an existing tag key. If you specify a key without a value, the tag will be created with the specified key and a value of null. You can tag a trail that applies to all regions only from the region in which the trail was created (that is, from its home region).

fn create_trail(
    &self,
    input: CreateTrailRequest
) -> RusotoFuture<CreateTrailResponse, CreateTrailError>

Creates a trail that specifies the settings for delivery of log data to an Amazon S3 bucket. A maximum of five trails can exist in a region, irrespective of the region in which they were created.

fn delete_trail(
    &self,
    input: DeleteTrailRequest
) -> RusotoFuture<DeleteTrailResponse, DeleteTrailError>

Deletes a trail. This operation must be called from the region in which the trail was created. DeleteTrail cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

fn describe_trails(
    &self,
    input: DescribeTrailsRequest
) -> RusotoFuture<DescribeTrailsResponse, DescribeTrailsError>

Retrieves settings for the trail associated with the current region for your account.

fn get_event_selectors(
    &self,
    input: GetEventSelectorsRequest
) -> RusotoFuture<GetEventSelectorsResponse, GetEventSelectorsError>

Describes the settings for the event selectors that you configured for your trail. The information returned for your event selectors includes the following:

• If your event selector includes read-only events, write-only events, or all events. This applies to both management events and data events.

• If your event selector includes management events.

• If your event selector includes data events, the Amazon S3 objects or AWS Lambda functions that you are logging for data events.

For more information, see Logging Data and Management Events for Trails in the AWS CloudTrail User Guide.

fn get_trail_status(
    &self,
    input: GetTrailStatusRequest
) -> RusotoFuture<GetTrailStatusResponse, GetTrailStatusError>

Returns a JSON-formatted list of information about the specified trail. Fields include information on delivery errors, Amazon SNS and Amazon S3 errors, and start and stop logging times for each trail. This operation returns trail status from a single region. To return trail status from all regions, you must call the operation on each region.

fn list_public_keys(
    &self,
    input: ListPublicKeysRequest
) -> RusotoFuture<ListPublicKeysResponse, ListPublicKeysError>

Returns all public keys whose private keys were used to sign the digest files within the specified time range. The public key is needed to validate digest files that were signed with its corresponding private key.

CloudTrail uses different private/public key pairs per region. Each digest file is signed with a private key unique to its region. Therefore, when you validate a digest file from a particular region, you must look in the same region for its corresponding public key.

fn list_tags(
    &self,
    input: ListTagsRequest
) -> RusotoFuture<ListTagsResponse, ListTagsError>

Lists the tags for the trail in the current region.

fn lookup_events(
    &self,
    input: LookupEventsRequest
) -> RusotoFuture<LookupEventsResponse, LookupEventsError>

Looks up management events captured by CloudTrail. Events for a region can be looked up in that region during the last 90 days. Lookup supports the following attributes:

• AWS access key

• Event ID

• Event name

• Event source

• Read only

• Resource name

• Resource type

• User name

All attributes are optional. The default number of results returned is 50, with a maximum of 50 possible. The response includes a token that you can use to get the next page of results.

The rate of lookup requests is limited to one per second per account. If this limit is exceeded, a throttling error occurs.

Events that occurred during the selected time range will not be available for lookup if CloudTrail logging was not enabled when the events occurred.

fn put_event_selectors(
    &self,
    input: PutEventSelectorsRequest
) -> RusotoFuture<PutEventSelectorsResponse, PutEventSelectorsError>

Configures an event selector for your trail. Use event selectors to further specify the management and data event settings for your trail. By default, trails created without specific event selectors will be configured to log all read and write management events, and no data events.

When an event occurs in your account, CloudTrail evaluates the event selectors in all trails. For each trail, if the event matches any event selector, the trail processes and logs the event. If the event doesn't match any event selector, the trail doesn't log the event.

Example

1. You create an event selector for a trail and specify that you want write-only events.

2. The EC2 GetConsoleOutput and RunInstances API operations occur in your account.

3. CloudTrail evaluates whether the events match your event selectors.

4. The RunInstances is a write-only event and it matches your event selector. The trail logs the event.

5. The GetConsoleOutput is a read-only event but it doesn't match your event selector. The trail doesn't log the event.

The PutEventSelectors operation must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

You can configure up to five event selectors for each trail. For more information, see Logging Data and Management Events for Trails and Limits in AWS CloudTrail in the AWS CloudTrail User Guide.

fn remove_tags(
    &self,
    input: RemoveTagsRequest
) -> RusotoFuture<RemoveTagsResponse, RemoveTagsError>

Removes the specified tags from a trail.

fn start_logging(
    &self,
    input: StartLoggingRequest
) -> RusotoFuture<StartLoggingResponse, StartLoggingError>

Starts the recording of AWS API calls and log file delivery for a trail. For a trail that is enabled in all regions, this operation must be called from the region in which the trail was created. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail that is enabled in all regions.

fn stop_logging(
    &self,
    input: StopLoggingRequest
) -> RusotoFuture<StopLoggingResponse, StopLoggingError>

Suspends the recording of AWS API calls and log file delivery for the specified trail. Under most circumstances, there is no need to use this action. You can update a trail without stopping it first. This action is the only way to stop recording. For a trail enabled in all regions, this operation must be called from the region in which the trail was created, or an InvalidHomeRegionException will occur. This operation cannot be called on the shadow trails (replicated trails in other regions) of a trail enabled in all regions.

fn update_trail(
    &self,
    input: UpdateTrailRequest
) -> RusotoFuture<UpdateTrailResponse, UpdateTrailError>

Updates the settings that specify delivery of log files. Changes to a trail do not require stopping the CloudTrail service. Use this action to designate an existing bucket for log delivery. If the existing bucket has previously been a target for CloudTrail log files, an IAM policy exists for the bucket. UpdateTrail must be called from the region in which the trail was created; otherwise, an InvalidHomeRegionException is thrown.

impl Clone for CloudTrailClient

fn clone(&self) -> CloudTrailClient

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.