blib/lib/Paws/EC2/DescribeInstanceStatus.pm

filter: Statementstmt 100% 16 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 18 / 18 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/DescribeInstanceAttribute.pm ↑ Summary blib/lib/Paws/EC2/DescribeInstanceStatusResult.pm »
1  
2 package Paws::EC2::DescribeInstanceStatus;
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 IncludeAllInstances => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'includeAllInstances' );
7 1 has InstanceIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'InstanceId' );
8 1 has MaxResults => (is => 'ro', isa => 'Int');
9 1 has NextToken => (is => 'ro', isa => 'Str');
10  
11 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
12  
13 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeInstanceStatus');
14 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeInstanceStatusResult');
15 1 class_has _result_key => (isa => 'Str', is => 'ro');
16 1 1;
17  
18 ### main pod documentation begin ###
19  
20 =head1 NAME
21  
22 Paws::EC2::DescribeInstanceStatus - Arguments for method DescribeInstanceStatus on L<Paws::EC2>
23  
24 =head1 DESCRIPTION
25  
26 This class represents the parameters used for calling the method DescribeInstanceStatus on the
27 L<Amazon Elastic Compute Cloud|Paws::EC2> 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 =head1 SYNOPSIS
33  
34 my $ec2 = Paws->service('EC2');
35 # To describe the status of an instance
36 # This example describes the current status of the specified instance.
37 my $DescribeInstanceStatusResult =
38 $ec2->DescribeInstanceStatus( 'InstanceIds' => ['i-1234567890abcdef0'] );
39  
40 # Results:
41 my $InstanceStatuses = $DescribeInstanceStatusResult->InstanceStatuses;
42  
43 # Returns a L<Paws::EC2::DescribeInstanceStatusResult> object.
44  
45 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.
46 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeInstanceStatus>
47  
48 =head1 ATTRIBUTES
49  
50  
51 =head2 DryRun => Bool
52  
53 Checks whether you have the required permissions for the action,
54 without actually making the request, and provides an error response. If
55 you have the required permissions, the error response is
56 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
57  
58  
59  
60 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
61  
62 The filters.
63  
64 =over
65  
66 =item *
67  
68 C<availability-zone> - The Availability Zone of the instance.
69  
70 =item *
71  
72 C<event.code> - The code for the scheduled event (C<instance-reboot> |
73 C<system-reboot> | C<system-maintenance> | C<instance-retirement> |
74 C<instance-stop>).
75  
76 =item *
77  
78 C<event.description> - A description of the event.
79  
80 =item *
81  
82 C<event.instance-event-id> - The ID of the event whose date and time
83 you are modifying.
84  
85 =item *
86  
87 C<event.not-after> - The latest end time for the scheduled event (for
88 example, C<2014-09-15T17:15:20.000Z>).
89  
90 =item *
91  
92 C<event.not-before> - The earliest start time for the scheduled event
93 (for example, C<2014-09-15T17:15:20.000Z>).
94  
95 =item *
96  
97 C<event.not-before-deadline> - The deadline for starting the event (for
98 example, C<2014-09-15T17:15:20.000Z>).
99  
100 =item *
101  
102 C<instance-state-code> - The code for the instance state, as a 16-bit
103 unsigned integer. The high byte is used for internal purposes and
104 should be ignored. The low byte is set based on the state represented.
105 The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48
106 (terminated), 64 (stopping), and 80 (stopped).
107  
108 =item *
109  
110 C<instance-state-name> - The state of the instance (C<pending> |
111 C<running> | C<shutting-down> | C<terminated> | C<stopping> |
112 C<stopped>).
113  
114 =item *
115  
116 C<instance-status.reachability> - Filters on instance status where the
117 name is C<reachability> (C<passed> | C<failed> | C<initializing> |
118 C<insufficient-data>).
119  
120 =item *
121  
122 C<instance-status.status> - The status of the instance (C<ok> |
123 C<impaired> | C<initializing> | C<insufficient-data> |
124 C<not-applicable>).
125  
126 =item *
127  
128 C<system-status.reachability> - Filters on system status where the name
129 is C<reachability> (C<passed> | C<failed> | C<initializing> |
130 C<insufficient-data>).
131  
132 =item *
133  
134 C<system-status.status> - The system status of the instance (C<ok> |
135 C<impaired> | C<initializing> | C<insufficient-data> |
136 C<not-applicable>).
137  
138 =back
139  
140  
141  
142  
143 =head2 IncludeAllInstances => Bool
144  
145 When C<true>, includes the health status for all instances. When
146 C<false>, includes the health status for running instances only.
147  
148 Default: C<false>
149  
150  
151  
152 =head2 InstanceIds => ArrayRef[Str|Undef]
153  
154 The instance IDs.
155  
156 Default: Describes all your instances.
157  
158 Constraints: Maximum 100 explicitly specified instance IDs.
159  
160  
161  
162 =head2 MaxResults => Int
163  
164 The maximum number of results to return in a single call. To retrieve
165 the remaining results, make another call with the returned C<NextToken>
166 value. This value can be between 5 and 1000. You cannot specify this
167 parameter and the instance IDs parameter in the same call.
168  
169  
170  
171 =head2 NextToken => Str
172  
173 The token to retrieve the next page of results.
174  
175  
176  
177  
178 =head1 SEE ALSO
179  
180 This class forms part of L<Paws>, documenting arguments for method DescribeInstanceStatus in L<Paws::EC2>
181  
182 =head1 BUGS and CONTRIBUTIONS
183  
184 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
185  
186 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
187  
188 =cut
189  
« blib/lib/Paws/EC2/DescribeInstanceAttribute.pm ↑ Summary blib/lib/Paws/EC2/DescribeInstanceStatusResult.pm »