blib/lib/Paws/EC2/DescribeCapacityReservations.pm untested

filter: Statementstmt 0.0% 0 / 16 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 0.0% 0 / 2 Podpod n/a totaltotal 0.0% 0 / 18 CC 1 SCAR 6.9
CC
1
Cov
0%
BEGIN
2.0
BEGIN
2.0
CRAP 2.0
1  
2 package Paws::EC2::DescribeCapacityReservations;
3 use Moose;
4 has CapacityReservationIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'CapacityReservationId' );
5 has DryRun => (is => 'ro', isa => 'Bool');
6 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
7 has MaxResults => (is => 'ro', isa => 'Int');
8 has NextToken => (is => 'ro', isa => 'Str');
9  
10 use MooseX::ClassAttribute;
11  
12 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeCapacityReservations');
13 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeCapacityReservationsResult');
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::DescribeCapacityReservations - Arguments for method DescribeCapacityReservations on L<Paws::EC2>
22  
23 =head1 DESCRIPTION
24  
25 This class represents the parameters used for calling the method DescribeCapacityReservations on the
26 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
27 as arguments to method DescribeCapacityReservations.
28  
29 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeCapacityReservations.
30  
31 =head1 SYNOPSIS
32  
33 my $ec2 = Paws->service('EC2');
34 my $DescribeCapacityReservationsResult = $ec2->DescribeCapacityReservations(
35 CapacityReservationIds => [ 'MyCapacityReservationId', ... ], # OPTIONAL
36 DryRun => 1, # OPTIONAL
37 Filters => [
38 {
39 Name => 'MyString', # OPTIONAL
40 Values => [
41 'MyString', ... # OPTIONAL
42 ], # OPTIONAL
43 },
44 ...
45 ], # OPTIONAL
46 MaxResults => 1, # OPTIONAL
47 NextToken => 'MyString', # OPTIONAL
48 );
49  
50 # Results:
51 my $CapacityReservations =
52 $DescribeCapacityReservationsResult->CapacityReservations;
53 my $NextToken = $DescribeCapacityReservationsResult->NextToken;
54  
55 # Returns a L<Paws::EC2::DescribeCapacityReservationsResult> object.
56  
57 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.
58 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeCapacityReservations>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 CapacityReservationIds => ArrayRef[Str|Undef]
64  
65 The ID of the Capacity Reservation.
66  
67  
68  
69 =head2 DryRun => Bool
70  
71 Checks whether you have the required permissions for the action,
72 without actually making the request, and provides an error response. If
73 you have the required permissions, the error response is
74 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
75  
76  
77  
78 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
79  
80 One or more filters.
81  
82 =over
83  
84 =item *
85  
86 C<instance-type> - The type of instance for which the Capacity
87 Reservation reserves capacity.
88  
89 =item *
90  
91 C<owner-id> - The ID of the account that owns the Capacity Reservation.
92  
93 =item *
94  
95 C<availability-zone-id> - The Availability Zone ID of the Capacity
96 Reservation.
97  
98 =item *
99  
100 C<instance-platform> - The type of operating system for which the
101 Capacity Reservation reserves capacity.
102  
103 =item *
104  
105 C<availability-zone> - The Availability Zone ID of the Capacity
106 Reservation.
107  
108 =item *
109  
110 C<tenancy> - Indicates the tenancy of the Capacity Reservation. A
111 Capacity Reservation can have one of the following tenancy settings:
112  
113 =over
114  
115 =item *
116  
117 C<default> - The Capacity Reservation is created on hardware that is
118 shared with other accounts.
119  
120 =item *
121  
122 C<dedicated> - The Capacity Reservation is created on single-tenant
123 hardware that is dedicated to a single account.
124  
125 =back
126  
127 =item *
128  
129 C<outpost-arn> - The Amazon Resource Name (ARN) of the Outpost on which
130 the Capacity Reservation was created.
131  
132 =item *
133  
134 C<state> - The current state of the Capacity Reservation. A Capacity
135 Reservation can be in one of the following states:
136  
137 =over
138  
139 =item *
140  
141 C<active>- The Capacity Reservation is active and the capacity is
142 available for your use.
143  
144 =item *
145  
146 C<expired> - The Capacity Reservation expired automatically at the date
147 and time specified in your request. The reserved capacity is no longer
148 available for your use.
149  
150 =item *
151  
152 C<cancelled> - The Capacity Reservation was cancelled. The reserved
153 capacity is no longer available for your use.
154  
155 =item *
156  
157 C<pending> - The Capacity Reservation request was successful but the
158 capacity provisioning is still pending.
159  
160 =item *
161  
162 C<failed> - The Capacity Reservation request has failed. A request
163 might fail due to invalid request parameters, capacity constraints, or
164 instance limit constraints. Failed requests are retained for 60
165 minutes.
166  
167 =back
168  
169 =item *
170  
171 C<start-date> - The date and time at which the Capacity Reservation was
172 started.
173  
174 =item *
175  
176 C<end-date> - The date and time at which the Capacity Reservation
177 expires. When a Capacity Reservation expires, the reserved capacity is
178 released and you can no longer launch instances into it. The Capacity
179 Reservation's state changes to expired when it reaches its end date and
180 time.
181  
182 =item *
183  
184 C<end-date-type> - Indicates the way in which the Capacity Reservation
185 ends. A Capacity Reservation can have one of the following end types:
186  
187 =over
188  
189 =item *
190  
191 C<unlimited> - The Capacity Reservation remains active until you
192 explicitly cancel it.
193  
194 =item *
195  
196 C<limited> - The Capacity Reservation expires automatically at a
197 specified date and time.
198  
199 =back
200  
201 =item *
202  
203 C<instance-match-criteria> - Indicates the type of instance launches
204 that the Capacity Reservation accepts. The options include:
205  
206 =over
207  
208 =item *
209  
210 C<open> - The Capacity Reservation accepts all instances that have
211 matching attributes (instance type, platform, and Availability Zone).
212 Instances that have matching attributes launch into the Capacity
213 Reservation automatically without specifying any additional parameters.
214  
215 =item *
216  
217 C<targeted> - The Capacity Reservation only accepts instances that have
218 matching attributes (instance type, platform, and Availability Zone),
219 and explicitly target the Capacity Reservation. This ensures that only
220 permitted instances can use the reserved capacity.
221  
222 =back
223  
224 =back
225  
226  
227  
228  
229 =head2 MaxResults => Int
230  
231 The maximum number of results to return for the request in a single
232 page. The remaining results can be seen by sending another request with
233 the returned C<nextToken> value. This value can be between 5 and 500.
234 If C<maxResults> is given a larger value than 500, you receive an
235 error.
236  
237  
238  
239 =head2 NextToken => Str
240  
241 The token to use to retrieve the next page of results.
242  
243  
244  
245  
246 =head1 SEE ALSO
247  
248 This class forms part of L<Paws>, documenting arguments for method DescribeCapacityReservations in L<Paws::EC2>
249  
250 =head1 BUGS and CONTRIBUTIONS
251  
252 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
253  
254 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
255  
256 =cut
257