Amazon Elastic Compute Cloud
CLI Reference (API Version 2011-12-15)
Print this pageEmail this pageGo to the ForumsView the PDFShare this page on TwitterShare this page on FacebookBookmark this page on DeliciousSubmit this page to RedditSubmit this page to DiggDid this page help you?  Yes  No   Tell us about it...

ec2-describe-spot-instance-requests

Description

Describes the Spot Instance requests that belong to your account. Spot Instances are instances that Amazon EC2 starts on your behalf when the maximum price that you specify exceeds the current Spot Price. Amazon EC2 periodically sets the Spot Price based on available Spot Instance capacity and current Spot Instance requests. For more information about Spot Instances, go to Spot Instances in the Amazon Elastic Compute Cloud User Guide.

You can filter the results to return information only about Spot Instance requests that match criteria you specify. For example, you could get information about requests where the Spot Price you specified is a certain value (however, you can't use greater than or less than comparison, but you can use * and ? wildcards). You can specify multiple values for a filter. A Spot Instance request must match at least one of the specified values for it to be included in the results.

You can specify multiple filters (e.g., the Spot Price is equal to a particular value, and the instance type is m1.small). The result includes information for a particular request only if it matches all your filters. If there's no match, no special message is returned; the response is simply empty.

You can use wildcards with the filter values: * matches zero or more characters, and ? matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of \*amazon\?\\ searches for the literal string *amazon?\.

The following table shows the available filters.

Filter Name Description

availability-zone-group

Availability Zone group. If you specify the same Availability Zone group for all Spot Instance requests, all Spot Instances are launched in the same Availability Zone.

Type: String

create-time

Time stamp when the Spot Instance request was created.

Type: String

fault-code

Fault code related to the request.

Type: String

fault-message

Fault message related to the request.

Type: String

instance-id

ID of the instance that fulfilled the request.

Type: String

launch-group

Spot Instance launch group. Launch groups are Spot Instances that launch together and terminate together.

Type: String

launch.block-device-mapping.delete-on-termination

Whether an Amazon EBS volume mapped to the instance is deleted on instance termination.

Type: Boolean

launch.block-device-mapping.device-name

Device name (e.g., /dev/sdh) for an Amazon EBS volume mapped to the instance.

Type: String

launch.block-device-mapping.snapshot-id

ID for a snapshot mapped to the instance.

Type: String

launch.block-device-mapping.volume-size

Size of an Amazon EBS volume mapped to the instance (in GiB).

Type: String

launch.group-id

A security group the instance is in.

Type: String

launch.image-id

The AMI ID.

Type: String

launch.instance-type

Type of instance (e.g., m1.small).

Type: String

launch.kernel-id

Kernel ID.

Type: String

launch.key-name

Name of the key pair the instance launched with.

Type: String

launch.monitoring-enabled

Whether monitoring is enabled for the Spot Instance.

Type: Boolean

launch.ramdisk-id

RAM disk ID.

Type: String

product-description

Product description associated with the instance.

Type: String

Valid Values: Linux/UNIX | Windows

spot-instance-request-id

Spot Instance request ID.

Type: String

spot-price

Maximum hourly price for any Spot Instance launched to fulfill the request.

Type: String

state

State of the Spot Instance request.

Type: String

Valid Values: active | cancelled | open | closed | failed

tag-key

Key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter tag-key=Purpose and the filter tag-value=X, you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose=X, see the tag:key filter later in this table.

For more information about tags, go to Using Tags in the Amazon Elastic Compute Cloud User Guide.

Type: String

tag-value

Value of a tag assigned to the resource. This filter is independent of the tag-key filter.

Type: String

tag:key

Filters the results based on a specific tag/value combination.

Example: To list just the resources assigned tag Purpose=X, then specify:

--filter tag:Purpose=X

Example: To list just resources assigned tag Purpose=X OR Purpose=Y, then specify:

--filter tag:Purpose=X --filter tag:Purpose=Y

type

Type of Spot Instance request.

Type: String

Valid Values: one-time | persistent

launched-availability-zone

The Availability Zone in which the bid is launched.

Type: String

Valid Values: us-east-1a, etc.

valid-from

Start date of the request.

Type: xsd:dateTime

valid-until

End date of the request.

Type: xsd:dateTime

The short version of this command is ec2dsir.

Syntax

ec2-describe-spot-instance-requests [request_id ...] [[--filter name=value] ...]

Options

NameDescriptionRequired

request_id

Specifies the ID of the Spot Instance request.

Type: String

Default: None

Example: sir-8456a32b

No

--filter name=value

A filter for limiting the results. See the preceding table for a list of allowed filter names and values. If you're using the command line tools on a Windows system, you might need to use quotation marks (i.e., "name=value").

Type: String

Default: Describes all Spot Instance requests you own, or those otherwise specified.

Example: --filter "tag-key=Production"

No

Common Options

OptionDescription

--region REGION

Overrides the Region specified in the EC2_URL environment variable and the URL specified by the -U option.

Default: The EC2_URL environment variable, or us-east-1 if the environment variable is not set.

Example: --region eu-west-1

-U, --url URL

URL is the uniform resource locator of the Amazon EC2 web service entry point.

Default: The EC2_URL environment variable, or https://ec2.amazonaws.com if the environment variable is not set.

Example: -U https://ec2.amazonaws.com

-K, --private-key EC2-PRIVATE-KEY

The private key to use when constructing requests to Amazon EC2.

Default: The value of the EC2_PRIVATE_KEY environment variable.

Example: -K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

-C, --cert EC2-CERT

The X.509 certificate to use when constructing requests to Amazon EC2.

Default: The value of the EC2_CERT environment variable.

Example: -C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBEXAMPLE.pem

--connection-timeout TIMEOUT

Specifies a connection timeout (in seconds).

Example: --connection-timeout 30

--request-timeout TIMEOUT

Specifies a request timeout (in seconds).

Example: --request-timeout 45

-v, --verbose

Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.

-H, --headers

Displays column headers in the output.

--show-empty-fields

Shows empty columns as (nil).

--hide-tags

Do not display tags for tagged resources.

--debug

Prints internal debugging information. This is useful to assist us when troubleshooting problems.

-?, --help, -h

Displays Help.

-

If - is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another.

Example: ec2-describe-instances | grep stopped | cut -f 2 | ec2-start-instances -

Output

The command returns a table that contains the following information:

  • Request ID

  • Spot Price

  • Type

  • State (active, open, closed, cancelled, failed)

  • Fault

  • Valid From

  • Valid Until

  • Launch Group

  • Availability Zone Group

  • Launched Availability Zone

  • Launch Specification

  • Create Time

  • Description

  • Any tags assigned to the request

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example returns information about a specific Spot Instance request.

PROMPT> ec2-describe-spot-instance-requests -H	sir-64b4ee11
Type	 SpotInstanceRequestID	 Price	 RequestType	 ProductDescription	 State	 Created	 ValidFrom	 ValidUntil	 LaunchGroup	 AZGroup	 InstanceID	 ImageID	InstanceType	 KeyName	 Groups	AvailabilityZone	 KernelID	 RamdiskID	 Monitored	 SubnetID	 LaunchedAvailabilityZone		
SPOTINSTANCEREQUEST	 sir-64b4ee11	 0.100000	 one-time	 Linux/UNIX	 open	 2011-08-30T11:02:16-0800   2011-08-30T12:00:00-0800	 test	 testAZ   ami-8c1fece5	 t1.micro	 SpotTest	sg-c20e77ab	us-east-1a	monitoring-enabled	us-east-1a

Example Request

This example describes all persistent Spot Instance requests that have resulted in the launch of at least one m1.small instance, that has been fulfilled in the us-east-1a Availability Zone, and that also has monitoring enabled.

PROMPT> ec2-describe-spot-instance-requests --filter "type=persistent" --filter "launch.instance-type=m1.small" --filter "launch.monitoring-enabled=true"