File Coverage

blib/lib/Paws/EC2/DescribeReservedInstancesOfferings.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::DescribeReservedInstancesOfferings;
3 1     1   574 use Moose;
  1     1   3  
  1         11  
  1         398  
  1         3  
  1         6  
4             has AvailabilityZone => (is => 'ro', isa => 'Str');
5             has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' );
6             has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' );
7             has IncludeMarketplace => (is => 'ro', isa => 'Bool');
8             has InstanceTenancy => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'instanceTenancy' );
9             has InstanceType => (is => 'ro', isa => 'Str');
10             has MaxDuration => (is => 'ro', isa => 'Int');
11             has MaxInstanceCount => (is => 'ro', isa => 'Int');
12             has MaxResults => (is => 'ro', isa => 'Int', traits => ['NameInRequest'], request_name => 'maxResults' );
13             has MinDuration => (is => 'ro', isa => 'Int');
14             has NextToken => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'nextToken' );
15             has OfferingClass => (is => 'ro', isa => 'Str');
16             has OfferingType => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'offeringType' );
17             has ProductDescription => (is => 'ro', isa => 'Str');
18             has ReservedInstancesOfferingIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'ReservedInstancesOfferingId' );
19              
20 1     1   9115 use MooseX::ClassAttribute;
  1     1   6  
  1         14  
  1         5928  
  1         3  
  1         9  
21              
22             class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeReservedInstancesOfferings');
23             class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeReservedInstancesOfferingsResult');
24             class_has _result_key => (isa => 'Str', is => 'ro');
25             1;
26              
27             ### main pod documentation begin ###
28              
29             =head1 NAME
30              
31             Paws::EC2::DescribeReservedInstancesOfferings - Arguments for method DescribeReservedInstancesOfferings on Paws::EC2
32              
33             =head1 DESCRIPTION
34              
35             This class represents the parameters used for calling the method DescribeReservedInstancesOfferings on the
36             Amazon Elastic Compute Cloud 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             As an example:
42              
43             $service_obj->DescribeReservedInstancesOfferings(Att1 => $value1, Att2 => $value2, ...);
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              
47             =head1 ATTRIBUTES
48              
49              
50             =head2 AvailabilityZone => Str
51              
52             The Availability Zone in which the Reserved Instance can be used.
53              
54              
55              
56             =head2 DryRun => Bool
57              
58             Checks whether you have the required permissions for the action,
59             without actually making the request, and provides an error response. If
60             you have the required permissions, the error response is
61             C<DryRunOperation>. Otherwise, it is C<UnauthorizedOperation>.
62              
63              
64              
65             =head2 Filters => ArrayRef[L<Paws::EC2::Filter>]
66              
67             One or more filters.
68              
69             =over
70              
71             =item *
72              
73             C<availability-zone> - The Availability Zone where the Reserved
74             Instance can be used.
75              
76             =item *
77              
78             C<duration> - The duration of the Reserved Instance (for example, one
79             year or three years), in seconds (C<31536000> | C<94608000>).
80              
81             =item *
82              
83             C<fixed-price> - The purchase price of the Reserved Instance (for
84             example, 9800.0).
85              
86             =item *
87              
88             C<instance-type> - The instance type that is covered by the
89             reservation.
90              
91             =item *
92              
93             C<marketplace> - Set to C<true> to show only Reserved Instance
94             Marketplace offerings. When this filter is not used, which is the
95             default behavior, all offerings from both AWS and the Reserved Instance
96             Marketplace are listed.
97              
98             =item *
99              
100             C<product-description> - The Reserved Instance product platform
101             description. Instances that include C<(Amazon VPC)> in the product
102             platform description will only be displayed to EC2-Classic account
103             holders and are for use with Amazon VPC. (C<Linux/UNIX> | C<Linux/UNIX
104             (Amazon VPC)> | C<SUSE Linux> | C<SUSE Linux (Amazon VPC)> | C<Red Hat
105             Enterprise Linux> | C<Red Hat Enterprise Linux (Amazon VPC)> |
106             C<Windows> | C<Windows (Amazon VPC)> | C<Windows with SQL Server
107             Standard> | C<Windows with SQL Server Standard (Amazon VPC)> |
108             C<Windows with SQL Server Web> | C< Windows with SQL Server Web (Amazon
109             VPC)> | C<Windows with SQL Server Enterprise> | C<Windows with SQL
110             Server Enterprise (Amazon VPC)>)
111              
112             =item *
113              
114             C<reserved-instances-offering-id> - The Reserved Instances offering ID.
115              
116             =item *
117              
118             C<scope> - The scope of the Reserved Instance (C<Availability Zone> or
119             C<Region>).
120              
121             =item *
122              
123             C<usage-price> - The usage price of the Reserved Instance, per hour
124             (for example, 0.84).
125              
126             =back
127              
128              
129              
130              
131             =head2 IncludeMarketplace => Bool
132              
133             Include Reserved Instance Marketplace offerings in the response.
134              
135              
136              
137             =head2 InstanceTenancy => Str
138              
139             The tenancy of the instances covered by the reservation. A Reserved
140             Instance with a tenancy of C<dedicated> is applied to instances that
141             run in a VPC on single-tenant hardware (i.e., Dedicated Instances).
142              
143             B<Important:> The C<host> value cannot be used with this parameter. Use
144             the C<default> or C<dedicated> values only.
145              
146             Default: C<default>
147              
148             Valid values are: C<"default">, C<"dedicated">, C<"host">
149              
150             =head2 InstanceType => Str
151              
152             The instance type that the reservation will cover (for example,
153             C<m1.small>). For more information, see Instance Types in the I<Amazon
154             Elastic Compute Cloud User Guide>.
155              
156             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<"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<"x1.16xlarge">, C<"x1.32xlarge">, 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<"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<"cc1.4xlarge">, C<"cc2.8xlarge">, C<"g2.2xlarge">, C<"g2.8xlarge">, C<"g3.4xlarge">, C<"g3.8xlarge">, C<"g3.16xlarge">, C<"cg1.4xlarge">, C<"p2.xlarge">, C<"p2.8xlarge">, C<"p2.16xlarge">, C<"d2.xlarge">, C<"d2.2xlarge">, C<"d2.4xlarge">, C<"d2.8xlarge">, C<"f1.2xlarge">, C<"f1.16xlarge">
157              
158             =head2 MaxDuration => Int
159              
160             The maximum duration (in seconds) to filter when searching for
161             offerings.
162              
163             Default: 94608000 (3 years)
164              
165              
166              
167             =head2 MaxInstanceCount => Int
168              
169             The maximum number of instances to filter when searching for offerings.
170              
171             Default: 20
172              
173              
174              
175             =head2 MaxResults => Int
176              
177             The maximum number of results to return for the request in a single
178             page. The remaining results of the initial request can be seen by
179             sending another request with the returned C<NextToken> value. The
180             maximum is 100.
181              
182             Default: 100
183              
184              
185              
186             =head2 MinDuration => Int
187              
188             The minimum duration (in seconds) to filter when searching for
189             offerings.
190              
191             Default: 2592000 (1 month)
192              
193              
194              
195             =head2 NextToken => Str
196              
197             The token to retrieve the next page of results.
198              
199              
200              
201             =head2 OfferingClass => Str
202              
203             The offering class of the Reserved Instance. Can be C<standard> or
204             C<convertible>.
205              
206             Valid values are: C<"standard">, C<"convertible">
207              
208             =head2 OfferingType => Str
209              
210             The Reserved Instance offering type. If you are using tools that
211             predate the 2011-11-01 API version, you only have access to the
212             C<Medium Utilization> Reserved Instance offering type.
213              
214             Valid values are: C<"Heavy Utilization">, C<"Medium Utilization">, C<"Light Utilization">, C<"No Upfront">, C<"Partial Upfront">, C<"All Upfront">
215              
216             =head2 ProductDescription => Str
217              
218             The Reserved Instance product platform description. Instances that
219             include C<(Amazon VPC)> in the description are for use with Amazon VPC.
220              
221             Valid values are: C<"Linux/UNIX">, C<"Linux/UNIX (Amazon VPC)">, C<"Windows">, C<"Windows (Amazon VPC)">
222              
223             =head2 ReservedInstancesOfferingIds => ArrayRef[Str|Undef]
224              
225             One or more Reserved Instances offering IDs.
226              
227              
228              
229              
230             =head1 SEE ALSO
231              
232             This class forms part of L<Paws>, documenting arguments for method DescribeReservedInstancesOfferings in L<Paws::EC2>
233              
234             =head1 BUGS and CONTRIBUTIONS
235              
236             The source code is located here: https://github.com/pplu/aws-sdk-perl
237              
238             Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues
239              
240             =cut
241