File Coverage

blib/lib/Paws/EC2/DescribeInstanceStatus.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::DescribeInstanceStatus;
3 1     1   354 use Moose;
  1     1   3  
  1         6  
  1         557  
  1         2  
  1         9  
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 IncludeAllInstances => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeAllInstances' );
7             has InstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'InstanceId' );
8             has MaxResults => (is => 'ro', isa => 'Int');
9             has NextToken => (is => 'ro', isa => 'Str');
10              
11 1     1   5484 use MooseX::ClassAttribute;
  1     1   3  
  1         8  
  1         6369  
  1         2  
  1         10  
12              
13             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeInstanceStatus');
14             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeInstanceStatusResult');
15             class_has _result_key => (isa => 'Str', is => 'ro');
16             1;
17              
18             ### main pod documentation begin ###
19              
20             =head1 NAME
21              
22             Paws::EC2::DescribeInstanceStatus - Arguments for method DescribeInstanceStatus on Paws::EC2
23              
24             =head1 DESCRIPTION
25              
26             This class represents the parameters used for calling the method DescribeInstanceStatus on the
27             Amazon Elastic Compute Cloud service. Use the attributes of this class
28             as arguments to method DescribeInstanceStatus.
29              
30             You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeInstanceStatus.
31              
32             As an example:
33              
34             $service_obj->DescribeInstanceStatus(Att1 => $value1, Att2 => $value2, ...);
35              
36             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.
37              
38             =head1 ATTRIBUTES
39              
40              
41             =head2 DryRun => Bool
42              
43             Checks whether you have the required permissions for the action,
44             without actually making the request, and provides an error response. If
45             you have the required permissions, the error response is
46             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
47              
48              
49              
50             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
51              
52             One or more filters.
53              
54             =over
55              
56             =item *
57              
58             C<availability-zone> - The Availability Zone of the instance.
59              
60             =item *
61              
62             C<event.code> - The code for the scheduled event (C<instance-reboot> |
63             C<system-reboot> | C<system-maintenance> | C<instance-retirement> |
64             C<instance-stop>).
65              
66             =item *
67              
68             C<event.description> - A description of the event.
69              
70             =item *
71              
72             C<event.not-after> - The latest end time for the scheduled event (for
73             example, C<2014-09-15T17:15:20.000Z>).
74              
75             =item *
76              
77             C<event.not-before> - The earliest start time for the scheduled event
78             (for example, C<2014-09-15T17:15:20.000Z>).
79              
80             =item *
81              
82             C<instance-state-code> - The code for the instance state, as a 16-bit
83             unsigned integer. The high byte is an opaque internal value and should
84             be ignored. The low byte is set based on the state represented. The
85             valid values are 0 (pending), 16 (running), 32 (shutting-down), 48
86             (terminated), 64 (stopping), and 80 (stopped).
87              
88             =item *
89              
90             C<instance-state-name> - The state of the instance (C<pending> |
91             C<running> | C<shutting-down> | C<terminated> | C<stopping> |
92             C<stopped>).
93              
94             =item *
95              
96             C<instance-status.reachability> - Filters on instance status where the
97             name is C<reachability> (C<passed> | C<failed> | C<initializing> |
98             C<insufficient-data>).
99              
100             =item *
101              
102             C<instance-status.status> - The status of the instance (C<ok> |
103             C<impaired> | C<initializing> | C<insufficient-data> |
104             C<not-applicable>).
105              
106             =item *
107              
108             C<system-status.reachability> - Filters on system status where the name
109             is C<reachability> (C<passed> | C<failed> | C<initializing> |
110             C<insufficient-data>).
111              
112             =item *
113              
114             C<system-status.status> - The system status of the instance (C<ok> |
115             C<impaired> | C<initializing> | C<insufficient-data> |
116             C<not-applicable>).
117              
118             =back
119              
120              
121              
122              
123             =head2 IncludeAllInstances => Bool
124              
125             When C<true>, includes the health status for all instances. When
126             C<false>, includes the health status for running instances only.
127              
128             Default: C<false>
129              
130              
131              
132             =head2 InstanceIds => ArrayRef[Str|Undef]
133              
134             One or more instance IDs.
135              
136             Default: Describes all your instances.
137              
138             Constraints: Maximum 100 explicitly specified instance IDs.
139              
140              
141              
142             =head2 MaxResults => Int
143              
144             The maximum number of results to return in a single call. To retrieve
145             the remaining results, make another call with the returned C<NextToken>
146             value. This value can be between 5 and 1000. You cannot specify this
147             parameter and the instance IDs parameter in the same call.
148              
149              
150              
151             =head2 NextToken => Str
152              
153             The token to retrieve the next page of results.
154              
155              
156              
157              
158             =head1 SEE ALSO
159              
160             This class forms part of L<Paws>, documenting arguments for method DescribeInstanceStatus in L<Paws::EC2>
161              
162             =head1 BUGS and CONTRIBUTIONS
163              
164             The source code is located here: https://github.com/pplu/aws-sdk-perl
165              
166             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
167              
168             =cut
169