/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace CloudTrail { namespace Model { /** *

Returns information about the trail.

See Also:

AWS * API Reference

*/ class AWS_CLOUDTRAIL_API DescribeTrailsRequest : public CloudTrailRequest { public: DescribeTrailsRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "DescribeTrails"; } Aws::String SerializePayload() const override; Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

*/ inline const Aws::Vector& GetTrailNameList() const{ return m_trailNameList; } /** *

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.

*/ inline bool TrailNameListHasBeenSet() const { return m_trailNameListHasBeenSet; } /** *

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.

*/ inline void SetTrailNameList(const Aws::Vector& value) { m_trailNameListHasBeenSet = true; m_trailNameList = value; } /** *

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.

*/ inline void SetTrailNameList(Aws::Vector&& value) { m_trailNameListHasBeenSet = true; m_trailNameList = std::move(value); } /** *

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.

*/ inline DescribeTrailsRequest& WithTrailNameList(const Aws::Vector& value) { SetTrailNameList(value); return *this;} /** *

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.

*/ inline DescribeTrailsRequest& WithTrailNameList(Aws::Vector&& value) { SetTrailNameList(std::move(value)); return *this;} /** *

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.

*/ inline DescribeTrailsRequest& AddTrailNameList(const Aws::String& value) { m_trailNameListHasBeenSet = true; m_trailNameList.push_back(value); return *this; } /** *

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.

*/ inline DescribeTrailsRequest& AddTrailNameList(Aws::String&& value) { m_trailNameListHasBeenSet = true; m_trailNameList.push_back(std::move(value)); return *this; } /** *

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.

*/ inline DescribeTrailsRequest& AddTrailNameList(const char* value) { m_trailNameListHasBeenSet = true; m_trailNameList.push_back(value); return *this; } /** *

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.

*/ inline bool GetIncludeShadowTrails() const{ return m_includeShadowTrails; } /** *

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.

*/ inline bool IncludeShadowTrailsHasBeenSet() const { return m_includeShadowTrailsHasBeenSet; } /** *

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.

*/ inline void SetIncludeShadowTrails(bool value) { m_includeShadowTrailsHasBeenSet = true; m_includeShadowTrails = value; } /** *

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.

*/ inline DescribeTrailsRequest& WithIncludeShadowTrails(bool value) { SetIncludeShadowTrails(value); return *this;} private: Aws::Vector m_trailNameList; bool m_trailNameListHasBeenSet; bool m_includeShadowTrails; bool m_includeShadowTrailsHasBeenSet; }; } // namespace Model } // namespace CloudTrail } // namespace Aws