1VM::EC2::REST::reservedU_sienrstCaonncter(i3b)uted PerlVDMo:c:uEmCe2n:t:aRtEiSoTn::reserved_instance(3)
2
3
4

NAME VM::EC2::REST::reserved_instance

SYNOPSIS

7        use VM::EC2 ':misc'
8

METHODS

10       These methods apply to describing, purchasing and using Reserved
11       Instances.
12
13       Implemented:
14        CancelReservedInstancesListing
15        DescribeReservedInstances
16        DescribeReservedInstancesListings
17        DescribeReservedInstancesModifications
18        DescribeReservedInstancesOfferings
19        ModifyReservedInstances
20        PurchaseReservedInstancesOffering
21        CreateReservedInstancesListing
22
23       Unimplemented:
24        (none)
25
26   @offerings = $ec2->describe_reserved_instances_offerings(@offering_ids)
27   @offerings = $ec2->describe_reserved_instances_offerings(%args)
28       This method returns a list of the reserved instance offerings currently
29       available for purchase. The arguments allow you to filter the offerings
30       according to a variety of filters.
31
32       All arguments are optional. If no named arguments are used, then the
33       arguments are treated as Reserved Instance Offering IDs.
34
35        -reserved_instances_offering_id  A scalar or arrayref of reserved
36                                          instance offering IDs
37
38        -instance_type                   The instance type on which the
39                                          reserved instance can be used,
40                                          e.g. "c1.medium"
41
42        -availability_zone, -zone        The availability zone in which the
43                                          reserved instance can be used.
44
45        -product_description             The reserved instance description.
46                                          Valid values are "Linux/UNIX",
47                                          "Linux/UNIX (Amazon VPC)",
48                                          "Windows", and "Windows (Amazon
49                                          VPC)"
50
51        -instance_tenancy                The tenancy of the reserved instance
52                                          offering, either "default" or
53                                          "dedicated". (VPC instances only)
54
55        -offering_type                  The reserved instance offering type, one of
56                                          "Heavy Utilization", "Medium Utilization",
57                                          or "Light Utilization".
58
59        -filter                          A set of filters to apply.
60
61       For available filters, see
62       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeReservedInstancesOfferings.html.
63
64       The returned objects are of type VM::EC2::ReservedInstance::Offering
65
66       This can be combined with the Offering purchase() method as shown here:
67
68        @offerings = $ec2->describe_reserved_instances_offerings(
69                 {'availability-zone'   => 'us-east-1a',
70                  'instance-type'       => 'c1.medium',
71                  'product-description' =>'Linux/UNIX',
72                  'duration'            => 31536000,  # this is 1 year
73                  });
74        $offerings[0]->purchase(5) and print "Five reserved instances purchased\n";
75
76       Purchase one or more reserved instances based on an offering.
77
78       Arguments:
79
80        -reserved_instances_offering_id, -id -- The reserved instance offering ID
81                                                to purchase (required).
82
83        -instance_count, -count              -- Number of instances to reserve
84                                                 under this offer (optional, defaults
85                                                 to 1).
86
87       Returns a Reserved Instances Id on success, undef on failure. Also see
88       the purchase() method of VM::EC2::ReservedInstance::Offering.
89
90   @res_instances = $ec2->describe_reserved_instances(@res_instance_ids)
91   @res_instances = $ec2->describe_reserved_instances(%args)
92       This method returns a list of the reserved instances that you currently
93       own.  The information returned includes the type of instances that the
94       reservation allows you to launch, the availability zone, and the cost
95       per hour to run those reserved instances.
96
97       All arguments are optional. If no named arguments are used, then the
98       arguments are treated as Reserved Instance IDs.
99
100        -reserved_instances_id -- A scalar or arrayref of reserved
101                                  instance IDs
102
103        -filter                -- A set of filters to apply.
104
105       For available filters, see
106       http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeReservedInstances.html.
107
108       The returned objects are of type VM::EC2::ReservedInstance
109
110   $id = $ec2->modify_reserved_instances(%args)
111       Modifies the Availability Zone, instance count, instance type, or
112       network platform (EC2-Classic or EC2-VPC) of your Reserved Instances.
113       The Reserved Instances to be modified must be identical, except for
114       Availability Zone, network platform, and instance type.
115
116       Required arguments:
117
118        -reserved_instances_id         -- The IDs of the Reserved Instances to modify
119                                          Can be scalar or arrayref.
120
121        -target_configuration          -- The configuration settings for the Reserved
122                                          Instances to modify
123
124                                          Must be a hashref or arrayref of hashes with
125                                          one or more of the following values:
126                                            AvailabilityZone, Platform, InstanceType
127                                          The following is also REQUIRED:
128                                            InstanceCount
129
130        -id                            -- Alias for -reserved_instances_id
131
132       Returns the reserved instances modification ID string.
133
134   @mods = $ec2->describe_reserved_instances_modifications(@ids)
135   @mods = $ec2->describe_reserved_instances_modifications(%args)
136       Describes the modifications made to your Reserved Instances.
137
138       All arguments are optional. If no named arguments are used, then the
139       arguments are treated as Reserved Instance Modification IDs.
140
141        -reserved_instances_modification_id -- A scalar or arrayref of reserved
142                                               instance modification IDs
143
144        -filter                             -- A set of filters to apply.
145
146        -id                                 -- Alias for -reserved_instances_modification_id
147
148       For available filters, see:
149       http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeReservedInstancesModifications.html
150
151       The returned objects are of type
152       VM::EC2::ReservedInstance::Modification
153
154   @list = $ec2->describe_reserved_instances_listings(%args)
155       Describes the account's Reserved Instance listings in the Reserved
156       Instance Marketplace.
157
158       All arguments are optional. If no named arguments are used, then the
159       arguments are treated as Reserved Instance Listing IDs.
160
161        -reserved_instances_listing_id      -- A scalar or arrayref of reserved
162                                               instance listing IDs
163
164        -reserved_instances_id              -- A scalar or arrayref of reserved
165                                               instance IDs
166
167        -filter                             -- A set of filters to apply.
168
169       For available filters, see:
170       http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeReservedInstancesListings.html
171
172       The returned objects are of type VM::EC2::ReservedInstance::Listing
173
174   $listing = $ec2->cancel_reserved_instances_listing(%args)
175       Cancels the specified Reserved Instance listing in the Reserved
176       Instance Marketplace.
177
178       Required arguments:
179
180        -reserved_instances_listing_id    -- The ID of the Reserved Instance listing
181                                             to be canceled
182
183       Returns an object of type VM::EC2::ReservedInstance::Listing
184
185   $listing = $ec2->create_reserved_instances_listing(%args)
186       Creates a listing for Amazon EC2 Reserved Instances to be sold in the
187       Reserved Instance Marketplace. Only one Reserved Instance listing may
188       be created at a time.
189
190       Required arguments:
191
192        -reserved_instances_id   -- The ID of the active Reserved Instance
193
194        -instance_count          -- The number of instances to be listed in the
195                                    Reserved Instance Marketplace. This number
196                                    should be less than or equal to the instance count
197                                    associated with the Reserved Instance ID specified
198
199        -price_schedules         -- hashref containing term/price pairs for months
200                                    the Reserved Instance has remaining in its term
201
202                                    For example, with a RI with 11 months to go:
203
204                                    { 11 => 2.5,
205                                       8 => 2.0,
206                                       5 => 1.5,
207                                       3 => 0.7,
208                                       1 => 0.1 }
209
210                                    For months 11,10,9 the price is $2.50, 8,7,6 is
211                                    $2.00, 5,4 is $1.50, 3,2 is $0.70 and the last
212                                    month is $0.10.
213
214                                    For more details, see the API docs at:
215       http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-CreateReservedInstancesListing.html
216
217
218        -client_token            -- Unique, case-sensitive identifier to ensure
219                                    idempotency of listings
220
221       Returns an object of type VM::EC2::ReservedInstance::Listing
222

SEE ALSO

224       VM::EC2
225

AUTHOR

227       Lincoln Stein <lincoln.stein@gmail.com>.
228
229       Lance Kinley <lkinley@loyaltymethods.com>.
230
231       Copyright (c) 2011 Ontario Institute for Cancer Research
232
233       Copyright (c) 2014 Loyalty Methods, Inc.
234
235       This package and its accompanying libraries is free software; you can
236       redistribute it and/or modify it under the terms of the GPL (either
237       version 1, or at your option, any later version) or the Artistic
238       License 2.0.  Refer to LICENSE for the full license text. In addition,
239       please see DISCLAIMER.txt for disclaimers of warranty.
240

POD ERRORS

242       Hey! The above document had some coding errors, which are explained
243       below:
244
245       Around line 115:
246           Unknown directive: =head
247
248       Around line 117:
249           Unknown directive: =head
250
251
252
253perl v5.32.0                      2020-07-28VM::EC2::REST::reserved_instance(3)