blib/lib/Paws/EC2/DescribeVolumes.pm

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