AWS SDK for C++  1.8.94
AWS SDK for C++
Public Member Functions | List of all members
Aws::CloudTrail::Model::DescribeTrailsRequest Class Reference

#include <DescribeTrailsRequest.h>

+ Inheritance diagram for Aws::CloudTrail::Model::DescribeTrailsRequest:

Public Member Functions

 DescribeTrailsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< Aws::String > & GetTrailNameList () const
 
bool TrailNameListHasBeenSet () const
 
void SetTrailNameList (const Aws::Vector< Aws::String > &value)
 
void SetTrailNameList (Aws::Vector< Aws::String > &&value)
 
DescribeTrailsRequestWithTrailNameList (const Aws::Vector< Aws::String > &value)
 
DescribeTrailsRequestWithTrailNameList (Aws::Vector< Aws::String > &&value)
 
DescribeTrailsRequestAddTrailNameList (const Aws::String &value)
 
DescribeTrailsRequestAddTrailNameList (Aws::String &&value)
 
DescribeTrailsRequestAddTrailNameList (const char *value)
 
bool GetIncludeShadowTrails () const
 
bool IncludeShadowTrailsHasBeenSet () const
 
void SetIncludeShadowTrails (bool value)
 
DescribeTrailsRequestWithIncludeShadowTrails (bool value)
 
- Public Member Functions inherited from Aws::CloudTrail::CloudTrailRequest
virtual ~CloudTrailRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Returns information about the trail.

See Also:

AWS API Reference

Definition at line 25 of file DescribeTrailsRequest.h.

Constructor & Destructor Documentation

◆ DescribeTrailsRequest()

Aws::CloudTrail::Model::DescribeTrailsRequest::DescribeTrailsRequest ( )

Member Function Documentation

◆ AddTrailNameList() [1/3]

DescribeTrailsRequest& Aws::CloudTrail::Model::DescribeTrailsRequest::AddTrailNameList ( const Aws::String value)
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 158 of file DescribeTrailsRequest.h.

◆ AddTrailNameList() [2/3]

DescribeTrailsRequest& Aws::CloudTrail::Model::DescribeTrailsRequest::AddTrailNameList ( Aws::String &&  value)
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 175 of file DescribeTrailsRequest.h.

◆ AddTrailNameList() [3/3]

DescribeTrailsRequest& Aws::CloudTrail::Model::DescribeTrailsRequest::AddTrailNameList ( const char *  value)
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 192 of file DescribeTrailsRequest.h.

◆ GetIncludeShadowTrails()

bool Aws::CloudTrail::Model::DescribeTrailsRequest::GetIncludeShadowTrails ( ) const
inline

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.

Definition at line 203 of file DescribeTrailsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CloudTrail::Model::DescribeTrailsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetServiceRequestName()

virtual const char* Aws::CloudTrail::Model::DescribeTrailsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 34 of file DescribeTrailsRequest.h.

◆ GetTrailNameList()

const Aws::Vector<Aws::String>& Aws::CloudTrail::Model::DescribeTrailsRequest::GetTrailNameList ( ) const
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 56 of file DescribeTrailsRequest.h.

◆ IncludeShadowTrailsHasBeenSet()

bool Aws::CloudTrail::Model::DescribeTrailsRequest::IncludeShadowTrailsHasBeenSet ( ) const
inline

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.

Definition at line 213 of file DescribeTrailsRequest.h.

◆ SerializePayload()

Aws::String Aws::CloudTrail::Model::DescribeTrailsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIncludeShadowTrails()

void Aws::CloudTrail::Model::DescribeTrailsRequest::SetIncludeShadowTrails ( bool  value)
inline

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.

Definition at line 223 of file DescribeTrailsRequest.h.

◆ SetTrailNameList() [1/2]

void Aws::CloudTrail::Model::DescribeTrailsRequest::SetTrailNameList ( const Aws::Vector< Aws::String > &  value)
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 90 of file DescribeTrailsRequest.h.

◆ SetTrailNameList() [2/2]

void Aws::CloudTrail::Model::DescribeTrailsRequest::SetTrailNameList ( Aws::Vector< Aws::String > &&  value)
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 107 of file DescribeTrailsRequest.h.

◆ TrailNameListHasBeenSet()

bool Aws::CloudTrail::Model::DescribeTrailsRequest::TrailNameListHasBeenSet ( ) const
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 73 of file DescribeTrailsRequest.h.

◆ WithIncludeShadowTrails()

DescribeTrailsRequest& Aws::CloudTrail::Model::DescribeTrailsRequest::WithIncludeShadowTrails ( bool  value)
inline

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.

Definition at line 233 of file DescribeTrailsRequest.h.

◆ WithTrailNameList() [1/2]

DescribeTrailsRequest& Aws::CloudTrail::Model::DescribeTrailsRequest::WithTrailNameList ( const Aws::Vector< Aws::String > &  value)
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 124 of file DescribeTrailsRequest.h.

◆ WithTrailNameList() [2/2]

DescribeTrailsRequest& Aws::CloudTrail::Model::DescribeTrailsRequest::WithTrailNameList ( Aws::Vector< Aws::String > &&  value)
inline

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. To return information about a trail in another region, you must specify its trail ARN.

Definition at line 141 of file DescribeTrailsRequest.h.


The documentation for this class was generated from the following file: