blib/lib/Paws/EC2/DescribeReservedInstancesOfferings.pm

filter: Statementstmt 100% 25 / 25 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 27 / 27 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/EC2/DescribeReservedInstances.pm ↑ Summary blib/lib/Paws/EC2/DescribeReservedInstancesOfferingsResult.pm »
1  
2 package Paws::EC2::DescribeReservedInstancesOfferings;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has AvailabilityZone => (is => 'ro', isa => 'Str');
5 1 has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
6 1 has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
7 1 has IncludeMarketplace => (is => 'ro', isa => 'Bool');
8 1 has InstanceTenancy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'instanceTenancy' );
9 1 has InstanceType => (is => 'ro', isa => 'Str');
10 1 has MaxDuration => (is => 'ro', isa => 'Int');
11 1 has MaxInstanceCount => (is => 'ro', isa => 'Int');
12 1 has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
13 1 has MinDuration => (is => 'ro', isa => 'Int');
14 1 has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
15 1 has OfferingClass => (is => 'ro', isa => 'Str');
16 1 has OfferingType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'offeringType' );
17 1 has ProductDescription => (is => 'ro', isa => 'Str');
18 1 has ReservedInstancesOfferingIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'ReservedInstancesOfferingId' );
19  
20 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
21  
22 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeReservedInstancesOfferings');
23 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeReservedInstancesOfferingsResult');
24 1 class_has _result_key => (isa => 'Str', is => 'ro');
25 1 1;
26  
27 ### main pod documentation begin ###
28  
29 =head1 NAME
30  
31 Paws::EC2::DescribeReservedInstancesOfferings - Arguments for method DescribeReservedInstancesOfferings on L<Paws::EC2>
32  
33 =head1 DESCRIPTION
34  
35 This class represents the parameters used for calling the method DescribeReservedInstancesOfferings on the
36 L<Amazon Elastic Compute Cloud|Paws::EC2> service. Use the attributes of this class
37 as arguments to method DescribeReservedInstancesOfferings.
38  
39 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeReservedInstancesOfferings.
40  
41 =head1 SYNOPSIS
42  
43 my $ec2 = Paws->service('EC2');
44 my $DescribeReservedInstancesOfferingsResult =
45 $ec2->DescribeReservedInstancesOfferings(
46 AvailabilityZone => 'MyString', # OPTIONAL
47 DryRun => 1, # OPTIONAL
48 Filters => [
49 {
50 Name => 'MyString',
51 Values => [ 'MyString', ... ], # OPTIONAL
52 },
53 ...
54 ], # OPTIONAL
55 IncludeMarketplace => 1, # OPTIONAL
56 InstanceTenancy => 'default', # OPTIONAL
57 InstanceType => 't1.micro', # OPTIONAL
58 MaxDuration => 1, # OPTIONAL
59 MaxInstanceCount => 1, # OPTIONAL
60 MaxResults => 1, # OPTIONAL
61 MinDuration => 1, # OPTIONAL
62 NextToken => 'MyString', # OPTIONAL
63 OfferingClass => 'standard', # OPTIONAL
64 OfferingType => 'Heavy Utilization', # OPTIONAL
65 ProductDescription => 'Linux/UNIX', # OPTIONAL
66 ReservedInstancesOfferingIds => [ 'MyReservedInstancesOfferingId', ... ]
67 , # OPTIONAL
68 );
69  
70 # Results:
71 my $NextToken = $DescribeReservedInstancesOfferingsResult->NextToken;
72 my $ReservedInstancesOfferings =
73 $DescribeReservedInstancesOfferingsResult->ReservedInstancesOfferings;
74  
75 # Returns a L<Paws::EC2::DescribeReservedInstancesOfferingsResult> object.
76  
77 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.
78 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ec2/DescribeReservedInstancesOfferings>
79  
80 =head1 ATTRIBUTES
81  
82  
83 =head2 AvailabilityZone => Str
84  
85 The Availability Zone in which the Reserved Instance can be used.
86  
87  
88  
89 =head2 DryRun => Bool
90  
91 Checks whether you have the required permissions for the action,
92 without actually making the request, and provides an error response. If
93 you have the required permissions, the error response is
94 C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
95  
96  
97  
98 =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
99  
100 One or more filters.
101  
102 =over
103  
104 =item *
105  
106 C<availability-zone> - The Availability Zone where the Reserved
107 Instance can be used.
108  
109 =item *
110  
111 C<duration> - The duration of the Reserved Instance (for example, one
112 year or three years), in seconds (C<31536000> | C<94608000>).
113  
114 =item *
115  
116 C<fixed-price> - The purchase price of the Reserved Instance (for
117 example, 9800.0).
118  
119 =item *
120  
121 C<instance-type> - The instance type that is covered by the
122 reservation.
123  
124 =item *
125  
126 C<marketplace> - Set to C<true> to show only Reserved Instance
127 Marketplace offerings. When this filter is not used, which is the
128 default behavior, all offerings from both Amazon Web Services and the
129 Reserved Instance Marketplace are listed.
130  
131 =item *
132  
133 C<product-description> - The Reserved Instance product platform
134 description. Instances that include C<(Amazon VPC)> in the product
135 platform description will only be displayed to EC2-Classic account
136 holders and are for use with Amazon VPC. (C<Linux/UNIX> | C<Linux/UNIX
137 (Amazon VPC)> | C<SUSE Linux> | C<SUSE Linux (Amazon VPC)> | C<Red Hat
138 Enterprise Linux> | C<Red Hat Enterprise Linux (Amazon VPC)> | C<Red
139 Hat Enterprise Linux with HA (Amazon VPC)> | C<Windows> | C<Windows
140 (Amazon VPC)> | C<Windows with SQL Server Standard> | C<Windows with
141 SQL Server Standard (Amazon VPC)> | C<Windows with SQL Server Web> | C<
142 Windows with SQL Server Web (Amazon VPC)> | C<Windows with SQL Server
143 Enterprise> | C<Windows with SQL Server Enterprise (Amazon VPC)>)
144  
145 =item *
146  
147 C<reserved-instances-offering-id> - The Reserved Instances offering ID.
148  
149 =item *
150  
151 C<scope> - The scope of the Reserved Instance (C<Availability Zone> or
152 C<Region>).
153  
154 =item *
155  
156 C<usage-price> - The usage price of the Reserved Instance, per hour
157 (for example, 0.84).
158  
159 =back
160  
161  
162  
163  
164 =head2 IncludeMarketplace => Bool
165  
166 Include Reserved Instance Marketplace offerings in the response.
167  
168  
169  
170 =head2 InstanceTenancy => Str
171  
172 The tenancy of the instances covered by the reservation. A Reserved
173 Instance with a tenancy of C<dedicated> is applied to instances that
174 run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
175  
176 B<Important:> The C<host> value cannot be used with this parameter. Use
177 the C<default> or C<dedicated> values only.
178  
179 Default: C<default>
180  
181 Valid values are: C<"default">, C<"dedicated">, C<"host">
182  
183 =head2 InstanceType => Str
184  
185 The instance type that the reservation will cover (for example,
186 C<m1.small>). For more information, see Instance types
187 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html)
188 in the I<Amazon EC2 User Guide>.
189  
190 Valid values are: C<"t1.micro">, C<"t2.nano">, C<"t2.micro">, C<"t2.small">, C<"t2.medium">, C<"t2.large">, C<"t2.xlarge">, C<"t2.2xlarge">, C<"t3.nano">, C<"t3.micro">, C<"t3.small">, C<"t3.medium">, C<"t3.large">, C<"t3.xlarge">, C<"t3.2xlarge">, C<"t3a.nano">, C<"t3a.micro">, C<"t3a.small">, C<"t3a.medium">, C<"t3a.large">, C<"t3a.xlarge">, C<"t3a.2xlarge">, C<"t4g.nano">, C<"t4g.micro">, C<"t4g.small">, C<"t4g.medium">, C<"t4g.large">, C<"t4g.xlarge">, C<"t4g.2xlarge">, C<"m1.small">, C<"m1.medium">, C<"m1.large">, C<"m1.xlarge">, C<"m3.medium">, C<"m3.large">, C<"m3.xlarge">, C<"m3.2xlarge">, C<"m4.large">, C<"m4.xlarge">, C<"m4.2xlarge">, C<"m4.4xlarge">, C<"m4.10xlarge">, C<"m4.16xlarge">, C<"m2.xlarge">, C<"m2.2xlarge">, C<"m2.4xlarge">, C<"cr1.8xlarge">, C<"r3.large">, C<"r3.xlarge">, C<"r3.2xlarge">, C<"r3.4xlarge">, C<"r3.8xlarge">, C<"r4.large">, C<"r4.xlarge">, C<"r4.2xlarge">, C<"r4.4xlarge">, C<"r4.8xlarge">, C<"r4.16xlarge">, C<"r5.large">, C<"r5.xlarge">, C<"r5.2xlarge">, C<"r5.4xlarge">, C<"r5.8xlarge">, C<"r5.12xlarge">, C<"r5.16xlarge">, C<"r5.24xlarge">, C<"r5.metal">, C<"r5a.large">, C<"r5a.xlarge">, C<"r5a.2xlarge">, C<"r5a.4xlarge">, C<"r5a.8xlarge">, C<"r5a.12xlarge">, C<"r5a.16xlarge">, C<"r5a.24xlarge">, C<"r5b.large">, C<"r5b.xlarge">, C<"r5b.2xlarge">, C<"r5b.4xlarge">, C<"r5b.8xlarge">, C<"r5b.12xlarge">, C<"r5b.16xlarge">, C<"r5b.24xlarge">, C<"r5b.metal">, C<"r5d.large">, C<"r5d.xlarge">, C<"r5d.2xlarge">, C<"r5d.4xlarge">, C<"r5d.8xlarge">, C<"r5d.12xlarge">, C<"r5d.16xlarge">, C<"r5d.24xlarge">, C<"r5d.metal">, C<"r5ad.large">, C<"r5ad.xlarge">, C<"r5ad.2xlarge">, C<"r5ad.4xlarge">, C<"r5ad.8xlarge">, C<"r5ad.12xlarge">, C<"r5ad.16xlarge">, C<"r5ad.24xlarge">, C<"r6g.metal">, C<"r6g.medium">, C<"r6g.large">, C<"r6g.xlarge">, C<"r6g.2xlarge">, C<"r6g.4xlarge">, C<"r6g.8xlarge">, C<"r6g.12xlarge">, C<"r6g.16xlarge">, C<"r6gd.metal">, C<"r6gd.medium">, C<"r6gd.large">, C<"r6gd.xlarge">, C<"r6gd.2xlarge">, C<"r6gd.4xlarge">, C<"r6gd.8xlarge">, C<"r6gd.12xlarge">, C<"r6gd.16xlarge">, C<"x1.16xlarge">, C<"x1.32xlarge">, C<"x1e.xlarge">, C<"x1e.2xlarge">, C<"x1e.4xlarge">, C<"x1e.8xlarge">, C<"x1e.16xlarge">, C<"x1e.32xlarge">, C<"i2.xlarge">, C<"i2.2xlarge">, C<"i2.4xlarge">, C<"i2.8xlarge">, C<"i3.large">, C<"i3.xlarge">, C<"i3.2xlarge">, C<"i3.4xlarge">, C<"i3.8xlarge">, C<"i3.16xlarge">, C<"i3.metal">, C<"i3en.large">, C<"i3en.xlarge">, C<"i3en.2xlarge">, C<"i3en.3xlarge">, C<"i3en.6xlarge">, C<"i3en.12xlarge">, C<"i3en.24xlarge">, C<"i3en.metal">, C<"hi1.4xlarge">, C<"hs1.8xlarge">, C<"c1.medium">, C<"c1.xlarge">, C<"c3.large">, C<"c3.xlarge">, C<"c3.2xlarge">, C<"c3.4xlarge">, C<"c3.8xlarge">, C<"c4.large">, C<"c4.xlarge">, C<"c4.2xlarge">, C<"c4.4xlarge">, C<"c4.8xlarge">, C<"c5.large">, C<"c5.xlarge">, C<"c5.2xlarge">, C<"c5.4xlarge">, C<"c5.9xlarge">, C<"c5.12xlarge">, C<"c5.18xlarge">, C<"c5.24xlarge">, C<"c5.metal">, C<"c5a.large">, C<"c5a.xlarge">, C<"c5a.2xlarge">, C<"c5a.4xlarge">, C<"c5a.8xlarge">, C<"c5a.12xlarge">, C<"c5a.16xlarge">, C<"c5a.24xlarge">, C<"c5ad.large">, C<"c5ad.xlarge">, C<"c5ad.2xlarge">, C<"c5ad.4xlarge">, C<"c5ad.8xlarge">, C<"c5ad.12xlarge">, C<"c5ad.16xlarge">, C<"c5ad.24xlarge">, C<"c5d.large">, C<"c5d.xlarge">, C<"c5d.2xlarge">, C<"c5d.4xlarge">, C<"c5d.9xlarge">, C<"c5d.12xlarge">, C<"c5d.18xlarge">, C<"c5d.24xlarge">, C<"c5d.metal">, C<"c5n.large">, C<"c5n.xlarge">, C<"c5n.2xlarge">, C<"c5n.4xlarge">, C<"c5n.9xlarge">, C<"c5n.18xlarge">, C<"c5n.metal">, C<"c6g.metal">, C<"c6g.medium">, C<"c6g.large">, C<"c6g.xlarge">, C<"c6g.2xlarge">, C<"c6g.4xlarge">, C<"c6g.8xlarge">, C<"c6g.12xlarge">, C<"c6g.16xlarge">, C<"c6gd.metal">, C<"c6gd.medium">, C<"c6gd.large">, C<"c6gd.xlarge">, C<"c6gd.2xlarge">, C<"c6gd.4xlarge">, C<"c6gd.8xlarge">, C<"c6gd.12xlarge">, C<"c6gd.16xlarge">, C<"c6gn.medium">, C<"c6gn.large">, C<"c6gn.xlarge">, C<"c6gn.2xlarge">, C<"c6gn.4xlarge">, C<"c6gn.8xlarge">, C<"c6gn.12xlarge">, C<"c6gn.16xlarge">, C<"cc1.4xlarge">, C<"cc2.8xlarge">, C<"g2.2xlarge">, C<"g2.8xlarge">, C<"g3.4xlarge">, C<"g3.8xlarge">, C<"g3.16xlarge">, C<"g3s.xlarge">, C<"g4ad.4xlarge">, C<"g4ad.8xlarge">, C<"g4ad.16xlarge">, C<"g4dn.xlarge">, C<"g4dn.2xlarge">, C<"g4dn.4xlarge">, C<"g4dn.8xlarge">, C<"g4dn.12xlarge">, C<"g4dn.16xlarge">, C<"g4dn.metal">, C<"cg1.4xlarge">, C<"p2.xlarge">, C<"p2.8xlarge">, C<"p2.16xlarge">, C<"p3.2xlarge">, C<"p3.8xlarge">, C<"p3.16xlarge">, C<"p3dn.24xlarge">, C<"p4d.24xlarge">, C<"d2.xlarge">, C<"d2.2xlarge">, C<"d2.4xlarge">, C<"d2.8xlarge">, C<"d3.xlarge">, C<"d3.2xlarge">, C<"d3.4xlarge">, C<"d3.8xlarge">, C<"d3en.xlarge">, C<"d3en.2xlarge">, C<"d3en.4xlarge">, C<"d3en.6xlarge">, C<"d3en.8xlarge">, C<"d3en.12xlarge">, C<"f1.2xlarge">, C<"f1.4xlarge">, C<"f1.16xlarge">, C<"m5.large">, C<"m5.xlarge">, C<"m5.2xlarge">, C<"m5.4xlarge">, C<"m5.8xlarge">, C<"m5.12xlarge">, C<"m5.16xlarge">, C<"m5.24xlarge">, C<"m5.metal">, C<"m5a.large">, C<"m5a.xlarge">, C<"m5a.2xlarge">, C<"m5a.4xlarge">, C<"m5a.8xlarge">, C<"m5a.12xlarge">, C<"m5a.16xlarge">, C<"m5a.24xlarge">, C<"m5d.large">, C<"m5d.xlarge">, C<"m5d.2xlarge">, C<"m5d.4xlarge">, C<"m5d.8xlarge">, C<"m5d.12xlarge">, C<"m5d.16xlarge">, C<"m5d.24xlarge">, C<"m5d.metal">, C<"m5ad.large">, C<"m5ad.xlarge">, C<"m5ad.2xlarge">, C<"m5ad.4xlarge">, C<"m5ad.8xlarge">, C<"m5ad.12xlarge">, C<"m5ad.16xlarge">, C<"m5ad.24xlarge">, C<"m5zn.large">, C<"m5zn.xlarge">, C<"m5zn.2xlarge">, C<"m5zn.3xlarge">, C<"m5zn.6xlarge">, C<"m5zn.12xlarge">, C<"m5zn.metal">, C<"h1.2xlarge">, C<"h1.4xlarge">, C<"h1.8xlarge">, C<"h1.16xlarge">, C<"z1d.large">, C<"z1d.xlarge">, C<"z1d.2xlarge">, C<"z1d.3xlarge">, C<"z1d.6xlarge">, C<"z1d.12xlarge">, C<"z1d.metal">, C<"u-6tb1.56xlarge">, C<"u-6tb1.112xlarge">, C<"u-9tb1.112xlarge">, C<"u-12tb1.112xlarge">, C<"u-6tb1.metal">, C<"u-9tb1.metal">, C<"u-12tb1.metal">, C<"u-18tb1.metal">, C<"u-24tb1.metal">, C<"a1.medium">, C<"a1.large">, C<"a1.xlarge">, C<"a1.2xlarge">, C<"a1.4xlarge">, C<"a1.metal">, C<"m5dn.large">, C<"m5dn.xlarge">, C<"m5dn.2xlarge">, C<"m5dn.4xlarge">, C<"m5dn.8xlarge">, C<"m5dn.12xlarge">, C<"m5dn.16xlarge">, C<"m5dn.24xlarge">, C<"m5dn.metal">, C<"m5n.large">, C<"m5n.xlarge">, C<"m5n.2xlarge">, C<"m5n.4xlarge">, C<"m5n.8xlarge">, C<"m5n.12xlarge">, C<"m5n.16xlarge">, C<"m5n.24xlarge">, C<"m5n.metal">, C<"r5dn.large">, C<"r5dn.xlarge">, C<"r5dn.2xlarge">, C<"r5dn.4xlarge">, C<"r5dn.8xlarge">, C<"r5dn.12xlarge">, C<"r5dn.16xlarge">, C<"r5dn.24xlarge">, C<"r5dn.metal">, C<"r5n.large">, C<"r5n.xlarge">, C<"r5n.2xlarge">, C<"r5n.4xlarge">, C<"r5n.8xlarge">, C<"r5n.12xlarge">, C<"r5n.16xlarge">, C<"r5n.24xlarge">, C<"r5n.metal">, C<"inf1.xlarge">, C<"inf1.2xlarge">, C<"inf1.6xlarge">, C<"inf1.24xlarge">, C<"m6g.metal">, C<"m6g.medium">, C<"m6g.large">, C<"m6g.xlarge">, C<"m6g.2xlarge">, C<"m6g.4xlarge">, C<"m6g.8xlarge">, C<"m6g.12xlarge">, C<"m6g.16xlarge">, C<"m6gd.metal">, C<"m6gd.medium">, C<"m6gd.large">, C<"m6gd.xlarge">, C<"m6gd.2xlarge">, C<"m6gd.4xlarge">, C<"m6gd.8xlarge">, C<"m6gd.12xlarge">, C<"m6gd.16xlarge">, C<"mac1.metal">, C<"x2gd.medium">, C<"x2gd.large">, C<"x2gd.xlarge">, C<"x2gd.2xlarge">, C<"x2gd.4xlarge">, C<"x2gd.8xlarge">, C<"x2gd.12xlarge">, C<"x2gd.16xlarge">, C<"x2gd.metal">
191  
192 =head2 MaxDuration => Int
193  
194 The maximum duration (in seconds) to filter when searching for
195 offerings.
196  
197 Default: 94608000 (3 years)
198  
199  
200  
201 =head2 MaxInstanceCount => Int
202  
203 The maximum number of instances to filter when searching for offerings.
204  
205 Default: 20
206  
207  
208  
209 =head2 MaxResults => Int
210  
211 The maximum number of results to return for the request in a single
212 page. The remaining results of the initial request can be seen by
213 sending another request with the returned C<NextToken> value. The
214 maximum is 100.
215  
216 Default: 100
217  
218  
219  
220 =head2 MinDuration => Int
221  
222 The minimum duration (in seconds) to filter when searching for
223 offerings.
224  
225 Default: 2592000 (1 month)
226  
227  
228  
229 =head2 NextToken => Str
230  
231 The token to retrieve the next page of results.
232  
233  
234  
235 =head2 OfferingClass => Str
236  
237 The offering class of the Reserved Instance. Can be C<standard> or
238 C<convertible>.
239  
240 Valid values are: C<"standard">, C<"convertible">
241  
242 =head2 OfferingType => Str
243  
244 The Reserved Instance offering type. If you are using tools that
245 predate the 2011-11-01 API version, you only have access to the
246 C<Medium Utilization> Reserved Instance offering type.
247  
248 Valid values are: C<"Heavy Utilization">, C<"Medium Utilization">, C<"Light Utilization">, C<"No Upfront">, C<"Partial Upfront">, C<"All Upfront">
249  
250 =head2 ProductDescription => Str
251  
252 The Reserved Instance product platform description. Instances that
253 include C<(Amazon VPC)> in the description are for use with Amazon VPC.
254  
255 Valid values are: C<"Linux/UNIX">, C<"Linux/UNIX (Amazon VPC)">, C<"Windows">, C<"Windows (Amazon VPC)">
256  
257 =head2 ReservedInstancesOfferingIds => ArrayRef[Str|Undef]
258  
259 One or more Reserved Instances offering IDs.
260  
261  
262  
263  
264 =head1 SEE ALSO
265  
266 This class forms part of L<Paws>, documenting arguments for method DescribeReservedInstancesOfferings in L<Paws::EC2>
267  
268 =head1 BUGS and CONTRIBUTIONS
269  
270 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
271  
272 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
273  
274 =cut
275  
« blib/lib/Paws/EC2/DescribeReservedInstances.pm ↑ Summary blib/lib/Paws/EC2/DescribeReservedInstancesOfferingsResult.pm »