Struct aws_sdk_cloudtrail::operation::describe_trails::builders::DescribeTrailsFluentBuilder

pub struct DescribeTrailsFluentBuilder { /* private fields */ }

Fluent builder constructing a request to DescribeTrails.

Retrieves settings for one or more trails associated with the current Region for your account.

Implementations

impl DescribeTrailsFluentBuilder

pub fn as_input(&self) -> &DescribeTrailsInputBuilder

Access the DescribeTrails as a reference.

pub async fn send( self ) -> Result<DescribeTrailsOutput, SdkError<DescribeTrailsError, HttpResponse>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn customize( self ) -> CustomizableOperation<DescribeTrailsOutput, DescribeTrailsError, Self>

Consumes this builder, creating a customizable operation that can be modified before being sent.

pub fn trail_name_list(self, input: impl Into<String>) -> Self

Appends an item to trailNameList.

To override the contents of this collection use set_trail_name_list.

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

pub fn set_trail_name_list(self, input: Option<Vec<String>>) -> Self

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

pub fn get_trail_name_list(&self) -> &Option<Vec<String>>

Specifies a list of trail names, trail ARNs, or both, of the trails to describe. The format of a trail ARN is:

arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail

If an empty list is specified, information for the trail in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is false, then information for all trails in the current Region is returned.

• If an empty list is specified and IncludeShadowTrails is null or true, then information for all trails in the current Region and any associated shadow trails in other Regions is returned.

If one or more trail names are specified, information is returned only if the names match the names of trails belonging only to the current Region and current account. To return information about a trail in another Region, you must specify its trail ARN.

pub fn include_shadow_trails(self, input: bool) -> Self

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

pub fn set_include_shadow_trails(self, input: Option<bool>) -> Self

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

pub fn get_include_shadow_trails(&self) -> &Option<bool>

Specifies whether to include shadow trails in the response. A shadow trail is the replication in a Region of a trail that was created in a different Region, or in the case of an organization trail, the replication of an organization trail in member accounts. If you do not include shadow trails, organization trails in a member account and Region replication trails will not be returned. The default is true.

Trait Implementations

impl Clone for DescribeTrailsFluentBuilder

fn clone(&self) -> DescribeTrailsFluentBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DescribeTrailsFluentBuilder

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.