File Coverage

blib/lib/Paws/CloudTrail/DescribeTrails.pm
Criterion Covered Total %
statement 6 6 100.0
branch n/a
condition n/a
subroutine 2 2 100.0
pod n/a
total 8 8 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::CloudTrail::DescribeTrails;
3 1     1   427 use Moose;
  1         2  
  1         9  
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 1     1   6328 use MooseX::ClassAttribute;
  1         4  
  1         9  
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 Paws::CloudTrail
19              
20             =head1 DESCRIPTION
21              
22             This class represents the parameters used for calling the method DescribeTrails on the
23             AWS 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             As an example:
29              
30             $service_obj->DescribeTrails(Att1 => $value1, Att2 => $value2, ...);
31              
32             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.
33              
34             =head1 ATTRIBUTES
35              
36              
37             =head2 IncludeShadowTrails => Bool
38              
39             Specifies whether to include shadow trails in the response. A shadow
40             trail is the replication in a region of a trail that was created in a
41             different region. The default is true.
42              
43              
44              
45             =head2 TrailNameList => ArrayRef[Str|Undef]
46              
47             Specifies a list of trail names, trail ARNs, or both, of the trails to
48             describe. The format of a trail ARN is:
49              
50             C<arn:aws:cloudtrail:us-east-1:123456789012:trail/MyTrail>
51              
52             If an empty list is specified, information for the trail in the current
53             region is returned.
54              
55             =over
56              
57             =item *
58              
59             If an empty list is specified and C<IncludeShadowTrails> is false, then
60             information for all trails in the current region is returned.
61              
62             =item *
63              
64             If an empty list is specified and IncludeShadowTrails is null or true,
65             then information for all trails in the current region and any
66             associated shadow trails in other regions is returned.
67              
68             =back
69              
70             If one or more trail names are specified, information is returned only
71             if the names match the names of trails belonging only to the current
72             region. To return information about a trail in another region, you must
73             specify its trail ARN.
74              
75              
76              
77              
78             =head1 SEE ALSO
79              
80             This class forms part of L<Paws>, documenting arguments for method DescribeTrails in L<Paws::CloudTrail>
81              
82             =head1 BUGS and CONTRIBUTIONS
83              
84             The source code is located here: https://github.com/pplu/aws-sdk-perl
85              
86             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
87              
88             =cut
89