File Coverage

blib/lib/Paws/EC2/DescribeVolumes.pm
Criterion Covered Total %
statement 12 12 100.0
branch n/a
condition n/a
subroutine 4 4 100.0
pod n/a
total 16 16 100.0


line stmt bran cond sub pod time code
1              
2             package Paws::EC2::DescribeVolumes;
3 1     1   291 use Moose;
  1     1   3  
  1         5  
  1         427  
  1         3  
  1         6  
4             has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
5             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
6             has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
7             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
8             has VolumeIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'VolumeId' );
9              
10 1     1   5555 use MooseX::ClassAttribute;
  1     1   2  
  1         8  
  1         5705  
  1         2  
  1         6  
11              
12             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeVolumes');
13             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeVolumesResult');
14             class_has _result_key => (isa => 'Str', is => 'ro');
15             1;
16              
17             ### main pod documentation begin ###
18              
19             =head1 NAME
20              
21             Paws::EC2::DescribeVolumes - Arguments for method DescribeVolumes on Paws::EC2
22              
23             =head1 DESCRIPTION
24              
25             This class represents the parameters used for calling the method DescribeVolumes on the
26             Amazon Elastic Compute Cloud 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             As an example:
32              
33             $service_obj->DescribeVolumes(Att1 => $value1, Att2 => $value2, ...);
34              
35             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.
36              
37             =head1 ATTRIBUTES
38              
39              
40             =head2 DryRun => Bool
41              
42             Checks whether you have the required permissions for the action,
43             without actually making the request, and provides an error response. If
44             you have the required permissions, the error response is
45             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
46              
47              
48              
49             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
50              
51             One or more filters.
52              
53             =over
54              
55             =item *
56              
57             C<attachment.attach-time> - The time stamp when the attachment
58             initiated.
59              
60             =item *
61              
62             C<attachment.delete-on-termination> - Whether the volume is deleted on
63             instance termination.
64              
65             =item *
66              
67             C<attachment.device> - The device name that is exposed to the instance
68             (for example, C</dev/sda1>).
69              
70             =item *
71              
72             C<attachment.instance-id> - The ID of the instance the volume is
73             attached to.
74              
75             =item *
76              
77             C<attachment.status> - The attachment state (C<attaching> | C<attached>
78             | C<detaching> | C<detached>).
79              
80             =item *
81              
82             C<availability-zone> - The Availability Zone in which the volume was
83             created.
84              
85             =item *
86              
87             C<create-time> - The time stamp when the volume was created.
88              
89             =item *
90              
91             C<encrypted> - The encryption status of the volume.
92              
93             =item *
94              
95             C<size> - The size of the volume, in GiB.
96              
97             =item *
98              
99             C<snapshot-id> - The snapshot from which the volume was created.
100              
101             =item *
102              
103             C<status> - The status of the volume (C<creating> | C<available> |
104             C<in-use> | C<deleting> | C<deleted> | C<error>).
105              
106             =item *
107              
108             C<tag>:I<key>=I<value> - The key/value combination of a tag assigned to
109             the resource. Specify the key of the tag in the filter name and the
110             value of the tag in the filter value. For example, for the tag
111             Purpose=X, specify C<tag:Purpose> for the filter name and C<X> for the
112             filter value.
113              
114             =item *
115              
116             C<tag-key> - The key of a tag assigned to the resource. This filter is
117             independent of the C<tag-value> filter. For example, if you use both
118             the filter "tag-key=Purpose" and the filter "tag-value=X", you get any
119             resources assigned both the tag key Purpose (regardless of what the
120             tag's value is), and the tag value X (regardless of what the tag's key
121             is). If you want to list only resources where Purpose is X, see the
122             C<tag>:I<key>=I<value> filter.
123              
124             =item *
125              
126             C<tag-value> - The value of a tag assigned to the resource. This filter
127             is independent of the C<tag-key> filter.
128              
129             =item *
130              
131             C<volume-id> - The volume ID.
132              
133             =item *
134              
135             C<volume-type> - The Amazon EBS volume type. This can be C<gp2> for
136             General Purpose SSD, C<io1> for Provisioned IOPS SSD, C<st1> for
137             Throughput Optimized HDD, C<sc1> for Cold HDD, or C<standard> for
138             Magnetic volumes.
139              
140             =back
141              
142              
143              
144              
145             =head2 MaxResults => Int
146              
147             The maximum number of volume results returned by C<DescribeVolumes> in
148             paginated output. When this parameter is used, C<DescribeVolumes> only
149             returns C<MaxResults> results in a single page along with a
150             C<NextToken> response element. The remaining results of the initial
151             request can be seen by sending another C<DescribeVolumes> request with
152             the returned C<NextToken> value. This value can be between 5 and 500;
153             if C<MaxResults> is given a value larger than 500, only 500 results are
154             returned. If this parameter is not used, then C<DescribeVolumes>
155             returns all results. You cannot specify this parameter and the volume
156             IDs parameter in the same request.
157              
158              
159              
160             =head2 NextToken => Str
161              
162             The C<NextToken> value returned from a previous paginated
163             C<DescribeVolumes> request where C<MaxResults> was used and the results
164             exceeded the value of that parameter. Pagination continues from the end
165             of the previous results that returned the C<NextToken> value. This
166             value is C<null> when there are no more results to return.
167              
168              
169              
170             =head2 VolumeIds => ArrayRef[Str|Undef]
171              
172             One or more volume IDs.
173              
174              
175              
176              
177             =head1 SEE ALSO
178              
179             This class forms part of L<Paws>, documenting arguments for method DescribeVolumes in L<Paws::EC2>
180              
181             =head1 BUGS and CONTRIBUTIONS
182              
183             The source code is located here: https://github.com/pplu/aws-sdk-perl
184              
185             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
186              
187             =cut
188