« blib/lib/Paws/CloudTrail/DeleteTrailResponse.pm
↑ Summary
blib/lib/Paws/CloudTrail/DescribeTrailsResponse.pm »
| 1 | |||
| 2 | package Paws::CloudTrail::DescribeTrails; | ||
| 3 | use Moose; | ||
| 4 | has IncludeShadowTrails => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeShadowTrails' ); | ||
| 5 | has TrailNameList => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'trailNameList' ); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeTrails'); | ||
| 10 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudTrail::DescribeTrailsResponse'); | ||
| 11 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::CloudTrail::DescribeTrails - Arguments for method DescribeTrails on L<Paws::CloudTrail> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeTrails on the | ||
| 23 | L<AWS CloudTrail|Paws::CloudTrail> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeTrails. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeTrails. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $cloudtrail = Paws->service('CloudTrail'); | ||
| 31 | my $DescribeTrailsResponse = $cloudtrail->DescribeTrails( | ||
| 32 | IncludeShadowTrails => 1, # OPTIONAL | ||
| 33 | TrailNameList => [ 'MyString', ... ], # OPTIONAL | ||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $TrailList = $DescribeTrailsResponse->TrailList; | ||
| 38 | |||
| 39 | # Returns a L<Paws::CloudTrail::DescribeTrailsResponse> object. | ||
| 40 | |||
| 41 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 42 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudtrail/DescribeTrails> | ||
| 43 | |||
| 44 | =head1 ATTRIBUTES | ||
| 45 | |||
| 46 | |||
| 47 | =head2 IncludeShadowTrails => Bool | ||
| 48 | |||
| 49 | Specifies whether to include shadow trails in the response. A shadow | ||
| 50 | trail is the replication in a region of a trail that was created in a | ||
| 51 | different region, or in the case of an organization trail, the | ||
| 52 | replication of an organization trail in member accounts. If you do not | ||
| 53 | include shadow trails, organization trails in a member account and | ||
| 54 | region replication trails will not be returned. The default is true. | ||
| 55 | |||
| 56 | |||
| 57 | |||
| 58 | =head2 TrailNameList => ArrayRef[Str|Undef] | ||
| 59 | |||
| 60 | Specifies a list of trail names, trail ARNs, or both, of the trails to | ||
| 61 | describe. The format of a trail ARN is: | ||
| 62 | |||
| 63 | C<arn:aws:cloudtrail:us-east-2:123456789012:trail/MyTrail> | ||
| 64 | |||
| 65 | If an empty list is specified, information for the trail in the current | ||
| 66 | region is returned. | ||
| 67 | |||
| 68 | =over | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | If an empty list is specified and C<IncludeShadowTrails> is false, then | ||
| 73 | information for all trails in the current region is returned. | ||
| 74 | |||
| 75 | =item * | ||
| 76 | |||
| 77 | If an empty list is specified and IncludeShadowTrails is null or true, | ||
| 78 | then information for all trails in the current region and any | ||
| 79 | associated shadow trails in other regions is returned. | ||
| 80 | |||
| 81 | =back | ||
| 82 | |||
| 83 | If one or more trail names are specified, information is returned only | ||
| 84 | if the names match the names of trails belonging only to the current | ||
| 85 | region. To return information about a trail in another region, you must | ||
| 86 | specify its trail ARN. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method DescribeTrails in L<Paws::CloudTrail> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |