You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::CloudTrail::Types::DescribeTrailsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb

Overview

Note:

When making an API call, you may pass DescribeTrailsRequest data as a hash:

{
  trail_name_list: ["String"],
  include_shadow_trails: false,
}

Returns information about the trail.

Instance Attribute Summary collapse

Instance Attribute Details

#include_shadow_trailsBoolean

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. The default is true.

Returns:

  • (Boolean)


402
403
404
405
406
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 402

class DescribeTrailsRequest < Struct.new(
  :trail_name_list,
  :include_shadow_trails)
  include Aws::Structure
end

#trail_name_listArray<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-1: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.

Returns:

  • (Array<String>)


402
403
404
405
406
# File 'gems/aws-sdk-cloudtrail/lib/aws-sdk-cloudtrail/types.rb', line 402

class DescribeTrailsRequest < Struct.new(
  :trail_name_list,
  :include_shadow_trails)
  include Aws::Structure
end