DescribeTrailsRequest Class | AWS SDK for .NET V3

Container for the parameters to the DescribeTrails operation. Retrieves settings for one or more trails associated with the current Region for your account.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudTrail.AmazonCloudTrailRequest
      Amazon.CloudTrail.Model.DescribeTrailsRequest

Namespace: Amazon.CloudTrail.Model
Assembly: AWSSDK.CloudTrail.dll
Version: 3.x.y.z

Syntax

public class DescribeTrailsRequest : AmazonCloudTrailRequest
         IAmazonWebServiceRequest

The DescribeTrailsRequest type exposes the following members

Constructors

	Name	Description
	DescribeTrailsRequest()

Properties

Name Type Description

	Name	Type	Description
	IncludeShadowTrails	System.Boolean	Gets and sets the property 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.
	TrailNameList	System.Collections.Generic.List<System.String>	Gets and sets the property 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 and current account. To return information about a trail in another Region, you must specify its trail ARN.

IncludeShadowTrails

System.Boolean

Gets and sets the property 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.

TrailNameList

System.Collections.Generic.List<System.String>

Gets and sets the property 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 and current account. To return information about a trail in another Region, you must specify its trail ARN.

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5