blib/lib/Paws/EC2/DescribeVolumeStatus.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/DescribeTagsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeVolumeStatusResult.pm »
1  
2 package Paws::EC2::DescribeVolumeStatus;
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 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 => 'DescribeVolumeStatus');
13 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeVolumeStatusResult');
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::DescribeVolumeStatus - Arguments for method DescribeVolumeStatus on L<Paws::EC2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeVolumeStatus on the
26 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
27 as arguments to method DescribeVolumeStatus.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeVolumeStatus.
30  
31 =head1 SYNOPSIS
32  
33 my $ec2 = Paws->service('EC2');
34 # To describe the status of a single volume
35 # This example describes the status for the volume ``vol-1234567890abcdef0``.
36 my $DescribeVolumeStatusResult =
37 $ec2->DescribeVolumeStatus( 'VolumeIds' => ['vol-1234567890abcdef0'] );
38  
39 # Results:
40 my $VolumeStatuses = $DescribeVolumeStatusResult->VolumeStatuses;
41  
42 # Returns a L<Paws::EC2::DescribeVolumeStatusResult> object.
43 # To describe the status of impaired volumes
44 # This example describes the status for all volumes that are impaired. In this
45 # example output, there are no impaired volumes.
46 my $DescribeVolumeStatusResult = $ec2->DescribeVolumeStatus(
47 'Filters' => [
48  
49 {
50 'Name' => 'volume-status.status',
51 'Values' => ['impaired']
52 }
53 ]
54 );
55  
56 # Results:
57 my $VolumeStatuses = $DescribeVolumeStatusResult->VolumeStatuses;
58  
59 # Returns a L<Paws::EC2::DescribeVolumeStatusResult> object.
60  
61 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.
62 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeVolumeStatus>
63  
64 =head1 ATTRIBUTES
65  
66  
67 =head2 DryRun => Bool
68  
69 Checks whether you have the required permissions for the action,
70 without actually making the request, and provides an error response. If
71 you have the required permissions, the error response is
72 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
73  
74  
75  
76 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
77  
78 The filters.
79  
80 =over
81  
82 =item *
83  
84 C<action.code> - The action code for the event (for example,
85 C<enable-volume-io>).
86  
87 =item *
88  
89 C<action.description> - A description of the action.
90  
91 =item *
92  
93 C<action.event-id> - The event ID associated with the action.
94  
95 =item *
96  
97 C<availability-zone> - The Availability Zone of the instance.
98  
99 =item *
100  
101 C<event.description> - A description of the event.
102  
103 =item *
104  
105 C<event.event-id> - The event ID.
106  
107 =item *
108  
109 C<event.event-type> - The event type (for C<io-enabled>: C<passed> |
110 C<failed>; for C<io-performance>: C<io-performance:degraded> |
111 C<io-performance:severely-degraded> | C<io-performance:stalled>).
112  
113 =item *
114  
115 C<event.not-after> - The latest end time for the event.
116  
117 =item *
118  
119 C<event.not-before> - The earliest start time for the event.
120  
121 =item *
122  
123 C<volume-status.details-name> - The cause for C<volume-status.status>
124 (C<io-enabled> | C<io-performance>).
125  
126 =item *
127  
128 C<volume-status.details-status> - The status of
129 C<volume-status.details-name> (for C<io-enabled>: C<passed> |
130 C<failed>; for C<io-performance>: C<normal> | C<degraded> |
131 C<severely-degraded> | C<stalled>).
132  
133 =item *
134  
135 C<volume-status.status> - The status of the volume (C<ok> | C<impaired>
136 | C<warning> | C<insufficient-data>).
137  
138 =back
139  
140  
141  
142  
143 =head2 MaxResults => Int
144  
145 The maximum number of volume results returned by
146 C<DescribeVolumeStatus> in paginated output. When this parameter is
147 used, the request only returns C<MaxResults> results in a single page
148 along with a C<NextToken> response element. The remaining results of
149 the initial request can be seen by sending another request with the
150 returned C<NextToken> value. This value can be between 5 and 1,000; if
151 C<MaxResults> is given a value larger than 1,000, only 1,000 results
152 are returned. If this parameter is not used, then
153 C<DescribeVolumeStatus> returns all results. You cannot specify this
154 parameter and the volume IDs parameter in the same request.
155  
156  
157  
158 =head2 NextToken => Str
159  
160 The C<NextToken> value to include in a future C<DescribeVolumeStatus>
161 request. When the results of the request exceed C<MaxResults>, this
162 value can be used to retrieve the next page of results. This value is
163 C<null> when there are no more results to return.
164  
165  
166  
167 =head2 VolumeIds => ArrayRef[Str|Undef]
168  
169 The IDs of the volumes.
170  
171 Default: Describes all your volumes.
172  
173  
174  
175  
176 =head1 SEE ALSO
177  
178 This class forms part of L<Paws>, documenting arguments for method DescribeVolumeStatus in L<Paws::EC2>
179  
180 =head1 BUGS and CONTRIBUTIONS
181  
182 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
183  
184 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
185  
186 =cut
187  
« blib/lib/Paws/EC2/DescribeTagsResult.pm ↑ Summary blib/lib/Paws/EC2/DescribeVolumeStatusResult.pm »