blib/lib/Paws/EC2/DescribeSnapshots.pm

filter: Statementstmt 100% 17 / 17 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 19 / 19 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/DescribeSecurityGroupsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSnapshotsResult.pm »
1  
2 package Paws::EC2::DescribeSnapshots;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6 1 has MaxResults => (is => 'ro', isa => 'Int');
7 1 has NextToken => (is => 'ro', isa => 'Str');
8 1 has OwnerIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'Owner' );
9 1 has RestorableByUserIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'RestorableBy' );
10 1 has SnapshotIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SnapshotId' );
11  
12 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
13  
14 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSnapshots');
15 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSnapshotsResult');
16 1 class_has _result_key => (isa => 'Str', is => 'ro');
17 1 1;
18  
19 ### main pod documentation begin ###
20  
21 =head1 NAME
22  
23 Paws::EC2::DescribeSnapshots - Arguments for method DescribeSnapshots on L<Paws::EC2>
24  
25 =head1 DESCRIPTION
26  
27 This class represents the parameters used for calling the method DescribeSnapshots on the
28 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
29 as arguments to method DescribeSnapshots.
30  
31 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSnapshots.
32  
33 =head1 SYNOPSIS
34  
35 my $ec2 = Paws->service('EC2');
36 # To describe a snapshot
37 # This example describes a snapshot with the snapshot ID of
38 # ``snap-1234567890abcdef0``.
39 my $DescribeSnapshotsResult =
40 $ec2->DescribeSnapshots( 'SnapshotIds' => ['snap-1234567890abcdef0'] );
41  
42 # Results:
43 my $NextToken = $DescribeSnapshotsResult->NextToken;
44 my $Snapshots = $DescribeSnapshotsResult->Snapshots;
45  
46 # Returns a L<Paws::EC2::DescribeSnapshotsResult> object.
47 # To describe snapshots using filters
48 # This example describes all snapshots owned by the ID 012345678910 that are in
49 # the ``pending`` status.
50 my $DescribeSnapshotsResult = $ec2->DescribeSnapshots(
51 'Filters' => [
52  
53 {
54 'Name' => 'status',
55 'Values' => ['pending']
56 }
57 ],
58 'OwnerIds' => [012345678910]
59 );
60  
61 # Results:
62 my $NextToken = $DescribeSnapshotsResult->NextToken;
63 my $Snapshots = $DescribeSnapshotsResult->Snapshots;
64  
65 # Returns a L<Paws::EC2::DescribeSnapshotsResult> object.
66  
67 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.
68 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeSnapshots>
69  
70 =head1 ATTRIBUTES
71  
72  
73 =head2 DryRun => Bool
74  
75 Checks whether you have the required permissions for the action,
76 without actually making the request, and provides an error response. If
77 you have the required permissions, the error response is
78 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
79  
80  
81  
82 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
83  
84 The filters.
85  
86 =over
87  
88 =item *
89  
90 C<description> - A description of the snapshot.
91  
92 =item *
93  
94 C<encrypted> - Indicates whether the snapshot is encrypted (C<true> |
95 C<false>)
96  
97 =item *
98  
99 C<owner-alias> - The owner alias, from an Amazon-maintained list
100 (C<amazon>). This is not the user-configured AWS account alias set
101 using the IAM console. We recommend that you use the related parameter
102 instead of this filter.
103  
104 =item *
105  
106 C<owner-id> - The AWS account ID of the owner. We recommend that you
107 use the related parameter instead of this filter.
108  
109 =item *
110  
111 C<progress> - The progress of the snapshot, as a percentage (for
112 example, 80%).
113  
114 =item *
115  
116 C<snapshot-id> - The snapshot ID.
117  
118 =item *
119  
120 C<start-time> - The time stamp when the snapshot was initiated.
121  
122 =item *
123  
124 C<status> - The status of the snapshot (C<pending> | C<completed> |
125 C<error>).
126  
127 =item *
128  
129 C<tag>:E<lt>keyE<gt> - The key/value combination of a tag assigned to
130 the resource. Use the tag key in the filter name and the tag value as
131 the filter value. For example, to find all resources that have a tag
132 with the key C<Owner> and the value C<TeamA>, specify C<tag:Owner> for
133 the filter name and C<TeamA> for the filter value.
134  
135 =item *
136  
137 C<tag-key> - The key of a tag assigned to the resource. Use this filter
138 to find all resources assigned a tag with a specific key, regardless of
139 the tag value.
140  
141 =item *
142  
143 C<volume-id> - The ID of the volume the snapshot is for.
144  
145 =item *
146  
147 C<volume-size> - The size of the volume, in GiB.
148  
149 =back
150  
151  
152  
153  
154 =head2 MaxResults => Int
155  
156 The maximum number of snapshot results returned by C<DescribeSnapshots>
157 in paginated output. When this parameter is used, C<DescribeSnapshots>
158 only returns C<MaxResults> results in a single page along with a
159 C<NextToken> response element. The remaining results of the initial
160 request can be seen by sending another C<DescribeSnapshots> request
161 with the returned C<NextToken> value. This value can be between 5 and
162 1,000; if C<MaxResults> is given a value larger than 1,000, only 1,000
163 results are returned. If this parameter is not used, then
164 C<DescribeSnapshots> returns all results. You cannot specify this
165 parameter and the snapshot IDs parameter in the same request.
166  
167  
168  
169 =head2 NextToken => Str
170  
171 The C<NextToken> value returned from a previous paginated
172 C<DescribeSnapshots> request where C<MaxResults> was used and the
173 results exceeded the value of that parameter. Pagination continues from
174 the end of the previous results that returned the C<NextToken> value.
175 This value is C<null> when there are no more results to return.
176  
177  
178  
179 =head2 OwnerIds => ArrayRef[Str|Undef]
180  
181 Scopes the results to snapshots with the specified owners. You can
182 specify a combination of AWS account IDs, C<self>, and C<amazon>.
183  
184  
185  
186 =head2 RestorableByUserIds => ArrayRef[Str|Undef]
187  
188 The IDs of the AWS accounts that can create volumes from the snapshot.
189  
190  
191  
192 =head2 SnapshotIds => ArrayRef[Str|Undef]
193  
194 The snapshot IDs.
195  
196 Default: Describes the snapshots for which you have create volume
197 permissions.
198  
199  
200  
201  
202 =head1 SEE ALSO
203  
204 This class forms part of L<Paws>, documenting arguments for method DescribeSnapshots in L<Paws::EC2>
205  
206 =head1 BUGS and CONTRIBUTIONS
207  
208 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
209  
210 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
211  
212 =cut
213  
« blib/lib/Paws/EC2/DescribeSecurityGroupsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeSnapshotsResult.pm »