.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VM::EC2::REST::reserved_instance 3pm"
.TH VM::EC2::REST::reserved_instance 3pm "2014-10-24" "perl v5.20.1" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME VM::EC2::REST::reserved_instance \- Describing, purchasing and using Reserved Instances"
.IX Header "NAME VM::EC2::REST::reserved_instance - Describing, purchasing and using Reserved Instances"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:misc\*(Aq
.Ve
.SH "METHODS"
.IX Header "METHODS"
These methods apply to describing, purchasing and using Reserved Instances.
.PP
Implemented:
 CancelReservedInstancesListing
 DescribeReservedInstances
 DescribeReservedInstancesListings
 DescribeReservedInstancesModifications
 DescribeReservedInstancesOfferings
 ModifyReservedInstances
 PurchaseReservedInstancesOffering
 CreateReservedInstancesListing
.PP
Unimplemented:
 (none)
.ie n .SS "@offerings = $ec2\->describe_reserved_instances_offerings(@offering_ids)"
.el .SS "\f(CW@offerings\fP = \f(CW$ec2\fP\->describe_reserved_instances_offerings(@offering_ids)"
.IX Subsection "@offerings = $ec2->describe_reserved_instances_offerings(@offering_ids)"
.ie n .SS "@offerings = $ec2\->describe_reserved_instances_offerings(%args)"
.el .SS "\f(CW@offerings\fP = \f(CW$ec2\fP\->describe_reserved_instances_offerings(%args)"
.IX Subsection "@offerings = $ec2->describe_reserved_instances_offerings(%args)"
This method returns a list of the reserved instance offerings
currently available for purchase. The arguments allow you to filter
the offerings according to a variety of filters.
.PP
All arguments are optional. If no named arguments are used, then the
arguments are treated as Reserved Instance Offering IDs.
.PP
.Vb 2
\& \-reserved_instances_offering_id  A scalar or arrayref of reserved
\&                                   instance offering IDs
\&
\& \-instance_type                   The instance type on which the
\&                                   reserved instance can be used,
\&                                   e.g. "c1.medium"
\&
\& \-availability_zone, \-zone        The availability zone in which the
\&                                   reserved instance can be used.
\&
\& \-product_description             The reserved instance description.
\&                                   Valid values are "Linux/UNIX",
\&                                   "Linux/UNIX (Amazon VPC)",
\&                                   "Windows", and "Windows (Amazon
\&                                   VPC)"
\&
\& \-instance_tenancy                The tenancy of the reserved instance
\&                                   offering, either "default" or
\&                                   "dedicated". (VPC instances only)
\&
\& \-offering_type                  The reserved instance offering type, one of
\&                                   "Heavy Utilization", "Medium Utilization",
\&                                   or "Light Utilization".
\&
\& \-filter                          A set of filters to apply.
.Ve
.PP
For available filters, see http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeReservedInstancesOfferings.html.
.PP
The returned objects are of type VM::EC2::ReservedInstance::Offering
.PP
This can be combined with the Offering \fIpurchase()\fR method as shown here:
.PP
.Vb 7
\& @offerings = $ec2\->describe_reserved_instances_offerings(
\&          {\*(Aqavailability\-zone\*(Aq   => \*(Aqus\-east\-1a\*(Aq,
\&           \*(Aqinstance\-type\*(Aq       => \*(Aqc1.medium\*(Aq,
\&           \*(Aqproduct\-description\*(Aq =>\*(AqLinux/UNIX\*(Aq,
\&           \*(Aqduration\*(Aq            => 31536000,  # this is 1 year
\&           });
\& $offerings[0]\->purchase(5) and print "Five reserved instances purchased\en";
.Ve
.ie n .SS "$id = $ec2\->purchase_reserved_instances_offering($offering_id)"
.el .SS "\f(CW$id\fP = \f(CW$ec2\fP\->purchase_reserved_instances_offering($offering_id)"
.IX Subsection "$id = $ec2->purchase_reserved_instances_offering($offering_id)"
.ie n .SS "$id = $ec2\->purchase_reserved_instances_offering(%args)"
.el .SS "\f(CW$id\fP = \f(CW$ec2\fP\->purchase_reserved_instances_offering(%args)"
.IX Subsection "$id = $ec2->purchase_reserved_instances_offering(%args)"
Purchase one or more reserved instances based on an offering.
.PP
Arguments:
.PP
.Vb 2
\& \-reserved_instances_offering_id, \-id \-\- The reserved instance offering ID
\&                                         to purchase (required).
\&
\& \-instance_count, \-count              \-\- Number of instances to reserve
\&                                          under this offer (optional, defaults
\&                                          to 1).
.Ve
.PP
Returns a Reserved Instances Id on success, undef on failure. Also see the \fIpurchase()\fR method of
VM::EC2::ReservedInstance::Offering.
.ie n .SS "@res_instances = $ec2\->describe_reserved_instances(@res_instance_ids)"
.el .SS "\f(CW@res_instances\fP = \f(CW$ec2\fP\->describe_reserved_instances(@res_instance_ids)"
.IX Subsection "@res_instances = $ec2->describe_reserved_instances(@res_instance_ids)"
.ie n .SS "@res_instances = $ec2\->describe_reserved_instances(%args)"
.el .SS "\f(CW@res_instances\fP = \f(CW$ec2\fP\->describe_reserved_instances(%args)"
.IX Subsection "@res_instances = $ec2->describe_reserved_instances(%args)"
This method returns a list of the reserved instances that you
currently own.  The information returned includes the type of
instances that the reservation allows you to launch, the availability
zone, and the cost per hour to run those reserved instances.
.PP
All arguments are optional. If no named arguments are used, then the
arguments are treated as Reserved Instance IDs.
.PP
.Vb 2
\& \-reserved_instances_id \-\- A scalar or arrayref of reserved
\&                           instance IDs
\&
\& \-filter                \-\- A set of filters to apply.
.Ve
.PP
For available filters, see http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeReservedInstances.html.
.PP
The returned objects are of type VM::EC2::ReservedInstance
.ie n .SS "$id = $ec2\->modify_reserved_instances(%args)"
.el .SS "\f(CW$id\fP = \f(CW$ec2\fP\->modify_reserved_instances(%args)"
.IX Subsection "$id = $ec2->modify_reserved_instances(%args)"
Modifies the Availability Zone, instance count, instance type, or network
platform (EC2\-Classic or \s-1EC2\-VPC\s0) of your Reserved Instances. The Reserved
Instances to be modified must be identical, except for Availability Zone,
network platform, and instance type.
.PP
Required arguments:
.PP
.Vb 2
\& \-reserved_instances_id         \-\- The IDs of the Reserved Instances to modify
\&                                   Can be scalar or arrayref.
\&
\& \-target_configuration          \-\- The configuration settings for the Reserved
\&                                   Instances to modify
\&
\&                                   Must be a hashref or arrayref of hashes with
\&                                   one or more of the following values:
\&                                     AvailabilityZone, Platform, InstanceType
\&                                   The following is also REQUIRED:
\&                                     InstanceCount
\&
\& \-id                            \-\- Alias for \-reserved_instances_id
.Ve
.PP
Returns the reserved instances modification \s-1ID\s0 string.
.ie n .SS "@mods = $ec2\->describe_reserved_instances_modifications(@ids)"
.el .SS "\f(CW@mods\fP = \f(CW$ec2\fP\->describe_reserved_instances_modifications(@ids)"
.IX Subsection "@mods = $ec2->describe_reserved_instances_modifications(@ids)"
.ie n .SS "@mods = $ec2\->describe_reserved_instances_modifications(%args)"
.el .SS "\f(CW@mods\fP = \f(CW$ec2\fP\->describe_reserved_instances_modifications(%args)"
.IX Subsection "@mods = $ec2->describe_reserved_instances_modifications(%args)"
Describes the modifications made to your Reserved Instances.
.PP
All arguments are optional. If no named arguments are used, then the
arguments are treated as Reserved Instance Modification IDs.
.PP
.Vb 2
\& \-reserved_instances_modification_id \-\- A scalar or arrayref of reserved
\&                                        instance modification IDs
\&
\& \-filter                             \-\- A set of filters to apply.
\&
\& \-id                                 \-\- Alias for \-reserved_instances_modification_id
.Ve
.PP
For available filters, see:
http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeReservedInstancesModifications.html
.PP
The returned objects are of type VM::EC2::ReservedInstance::Modification
.ie n .SS "@list = $ec2\->describe_reserved_instances_listings(%args)"
.el .SS "\f(CW@list\fP = \f(CW$ec2\fP\->describe_reserved_instances_listings(%args)"
.IX Subsection "@list = $ec2->describe_reserved_instances_listings(%args)"
Describes the account's Reserved Instance listings in the Reserved Instance
Marketplace.
.PP
All arguments are optional. If no named arguments are used, then the
arguments are treated as Reserved Instance Listing IDs.
.PP
.Vb 2
\& \-reserved_instances_listing_id      \-\- A scalar or arrayref of reserved
\&                                        instance listing IDs
\&
\& \-reserved_instances_id              \-\- A scalar or arrayref of reserved
\&                                        instance IDs 
\&
\& \-filter                             \-\- A set of filters to apply.
.Ve
.PP
For available filters, see:
http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeReservedInstancesListings.html
.PP
The returned objects are of type VM::EC2::ReservedInstance::Listing
.ie n .SS "$listing = $ec2\->cancel_reserved_instances_listing(%args)"
.el .SS "\f(CW$listing\fP = \f(CW$ec2\fP\->cancel_reserved_instances_listing(%args)"
.IX Subsection "$listing = $ec2->cancel_reserved_instances_listing(%args)"
Cancels the specified Reserved Instance listing in the Reserved Instance
Marketplace.
.PP
Required arguments:
.PP
.Vb 2
\& \-reserved_instances_listing_id    \-\- The ID of the Reserved Instance listing
\&                                      to be canceled
.Ve
.PP
Returns an object of type VM::EC2::ReservedInstance::Listing
.ie n .SS "$listing = $ec2\->create_reserved_instances_listing(%args)"
.el .SS "\f(CW$listing\fP = \f(CW$ec2\fP\->create_reserved_instances_listing(%args)"
.IX Subsection "$listing = $ec2->create_reserved_instances_listing(%args)"
Creates a listing for Amazon \s-1EC2\s0 Reserved Instances to be sold in the Reserved
Instance Marketplace. Only one Reserved Instance listing may be created at a
time.
.PP
Required arguments:
.PP
.Vb 1
\& \-reserved_instances_id   \-\- The ID of the active Reserved Instance
\&
\& \-instance_count          \-\- The number of instances to be listed in the
\&                             Reserved Instance Marketplace. This number
\&                             should be less than or equal to the instance count
\&                             associated with the Reserved Instance ID specified
\&
\& \-price_schedules         \-\- hashref containing term/price pairs for months
\&                             the Reserved Instance has remaining in its term
\&
\&                             For example, with a RI with 11 months to go:
\&
\&                             { 11 => 2.5,
\&                                8 => 2.0,
\&                                5 => 1.5,
\&                                3 => 0.7,
\&                                1 => 0.1 }
\&
\&                             For months 11,10,9 the price is $2.50, 8,7,6 is
\&                             $2.00, 5,4 is $1.50, 3,2 is $0.70 and the last
\&                             month is $0.10.
\&
\&                             For more details, see the API docs at:
\&http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference\-query\-CreateReservedInstancesListing.html
\&                             
\&
\& \-client_token            \-\- Unique, case\-sensitive identifier to ensure
\&                             idempotency of listings
.Ve
.PP
Returns an object of type VM::EC2::ReservedInstance::Listing
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Lance Kinley <lkinley@loyaltymethods.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
Copyright (c) 2014 Loyalty Methods, Inc.
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL \s0(either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.