.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" 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::Spot::InstanceRequest 3pm"
.TH VM::EC2::Spot::InstanceRequest 3pm "2016-06-04" "perl v5.22.2" "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::Spot::InstanceRequest \- Object describing an Amazon EC2 spot instance request
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
See \*(L"\s-1SPOT INSTANCES\*(R"\s0 in \s-1VM::EC2\s0.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This object represents an Amazon \s-1EC2\s0 spot instance request, which is
returned by \s-1VM::EC2\-\s0>\fIrequest_spot_instances()\fR and
\&\s-1VM::EC2\-\s0>\fIdescribe_spot_instance_requests()\fR.
.SH "METHODS"
.IX Header "METHODS"
These object methods are supported:
.PP
.Vb 1
\& spotInstanceRequestId       \-\- ID of this spot instance request
\&
\& spotPrice   \-\- The maximum hourly price for any spot
\&                instance launched under this request,
\&                in USD.
\&
\& type        \-\- The spot instance request type, one of
\&                \*(Aqone\-time\*(Aq or \*(Aqpersistent\*(Aq.
\&
\& state       \-\- The state of this request, one of \*(Aqopen\*(Aq,
\&                \*(Aqclosed\*(Aq, \*(Aqfulfilled\*(Aq, \*(Aqcancelled\*(Aq or \*(Aqfailed\*(Aq.
\&
\& fault       \-\- Fault code for the request, if any, an
\&                instance of VM::EC2::Error.
\&
\& status      \-\- The status code and status message describing the
\&                Spot Instance request.
\&
\& validFrom   \-\- Start date and time of the request.
\&
\& validUntil  \-\- Date and time that the request expires.
\&
\& launchGroup \-\- Launch group of the instances run under this request.
\&                Instances in the same launch group are launched
\&                and terminated together.
\&
\& launchedAvailabilityZone \-\- Availability zone of launched instance.
\&
\& availabilityZoneGroup \-\- Availability zone group of the instances
\&                run under this request. Instances in the same
\&                availability zone group will always be launched
\&                into the same availability zone.
\&
\& launchSpecification \-\- Additional information for launching
\&                instances, represented as a VM::EC2::Spot::LaunchSpecificaton
\&                object.
\&
\& instanceId  \-\- The instance ID, if an instance has been launched as a 
\&                result of this request.
\&
\& createTime  \-\- The time and date when the spot instance request was
\&                created.
\&
\& productDescription \-\- The product description associated with this spot
\&                instance request.
.Ve
.SH "Convenience Methods"
.IX Header "Convenience Methods"
This class supports the standard tagging interface. In addition it
provides the following convenience method:
.ie n .SS "$instance = $request\->instance"
.el .SS "\f(CW$instance\fP = \f(CW$request\fP\->instance"
.IX Subsection "$instance = $request->instance"
If an instance was launched as a result of this request, the
\&\fIinstance()\fR method will return the corresponding VM::EC2::Instance
object.
.ie n .SS "$state  = $request\->current_status"
.el .SS "\f(CW$state\fP  = \f(CW$request\fP\->current_status"
.IX Subsection "$state = $request->current_status"
Refreshes the request information and returns its status as a
VM::EC2::Spot::Status.  This will string interpolate as the status
code, such as \*(L"fulfilled\*(R". You may also call its object methods to
get the time of the last update and full message.
.ie n .SS "$state  = $request\->current_state"
.el .SS "\f(CW$state\fP  = \f(CW$request\fP\->current_state"
.IX Subsection "$state = $request->current_state"
Refreshes the request information and returns its state, such as \*(L"open\*(R".
.ie n .SS "$request\->refresh"
.el .SS "\f(CW$request\fP\->refresh"
.IX Subsection "$request->refresh"
Refreshes the request information.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
VM::EC2::Generic
VM::EC2::Spot::LaunchSpecification
VM::EC2::Error
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.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.