File Coverage

blib/lib/Paws/EC2/DescribeVolumeStatus.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	sub	time	code
1
2				package Paws::EC2::DescribeVolumeStatus;
3	1	1	292	use Moose;
	1	1	2
	1		5
	1		394
	1		2
	1		7
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');
7				has NextToken => (is => 'ro', isa => 'Str');
8				has VolumeIds => (is => 'ro', isa => 'ArrayRef[Str\|Undef]', traits => ['NameInRequest'], request_name => 'VolumeId' );
9
10	1	1	5249	use MooseX::ClassAttribute;
	1	1	2
	1		6
	1		5706
	1		2
	1		7
11
12				class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeVolumeStatus');
13				class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeVolumeStatusResult');
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::DescribeVolumeStatus - Arguments for method DescribeVolumeStatus on Paws::EC2
22
23				=head1 DESCRIPTION
24
25				This class represents the parameters used for calling the method DescribeVolumeStatus on the
26				Amazon Elastic Compute Cloud 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				As an example:
32
33				$service_obj->DescribeVolumeStatus(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<action.code> - The action code for the event (for example,
58				C<enable-volume-io>).
59
60				=item *
61
62				C<action.description> - A description of the action.
63
64				=item *
65
66				C<action.event-id> - The event ID associated with the action.
67
68				=item *
69
70				C<availability-zone> - The Availability Zone of the instance.
71
72				=item *
73
74				C<event.description> - A description of the event.
75
76				=item *
77
78				C<event.event-id> - The event ID.
79
80				=item *
81
82				C<event.event-type> - The event type (for C<io-enabled>: C<passed> \|
83				C<failed>; for C<io-performance>: C<io-performance:degraded> \|
84				C<io-performance:severely-degraded> \| C<io-performance:stalled>).
85
86				=item *
87
88				C<event.not-after> - The latest end time for the event.
89
90				=item *
91
92				C<event.not-before> - The earliest start time for the event.
93
94				=item *
95
96				C<volume-status.details-name> - The cause for C<volume-status.status>
97				(C<io-enabled> \| C<io-performance>).
98
99				=item *
100
101				C<volume-status.details-status> - The status of
102				C<volume-status.details-name> (for C<io-enabled>: C<passed> \|
103				C<failed>; for C<io-performance>: C<normal> \| C<degraded> \|
104				C<severely-degraded> \| C<stalled>).
105
106				=item *
107
108				C<volume-status.status> - The status of the volume (C<ok> \| C<impaired>
109				\| C<warning> \| C<insufficient-data>).
110
111				=back
112
113
114
115
116				=head2 MaxResults => Int
117
118				The maximum number of volume results returned by
119				C<DescribeVolumeStatus> in paginated output. When this parameter is
120				used, the request only returns C<MaxResults> results in a single page
121				along with a C<NextToken> response element. The remaining results of
122				the initial request can be seen by sending another request with the
123				returned C<NextToken> value. This value can be between 5 and 1000; if
124				C<MaxResults> is given a value larger than 1000, only 1000 results are
125				returned. If this parameter is not used, then C<DescribeVolumeStatus>
126				returns all results. You cannot specify this parameter and the volume
127				IDs parameter in the same request.
128
129
130
131				=head2 NextToken => Str
132
133				The C<NextToken> value to include in a future C<DescribeVolumeStatus>
134				request. When the results of the request exceed C<MaxResults>, this
135				value can be used to retrieve the next page of results. This value is
136				C<null> when there are no more results to return.
137
138
139
140				=head2 VolumeIds => ArrayRef[Str\|Undef]
141
142				One or more volume IDs.
143
144				Default: Describes all your volumes.
145
146
147
148
149				=head1 SEE ALSO
150
151				This class forms part of L<Paws>, documenting arguments for method DescribeVolumeStatus in L<Paws::EC2>
152
153				=head1 BUGS and CONTRIBUTIONS
154
155				The source code is located here: https://github.com/pplu/aws-sdk-perl
156
157				Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
158
159				=cut
160