AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Invokes the DescribeSpotInstanceRequests operation against Amazon Elastic Compute Cloud.

Syntax

Get-EC2SpotInstanceRequest
-SpotInstanceRequestId <String[]>
-Filter <Filter[]>

Description

Describes the Spot instance requests that belong to your account. Spot instances are instances that Amazon EC2 launches when the bid 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, see Spot Instance Requests in the Amazon Elastic Compute Cloud User Guide. You can use DescribeSpotInstanceRequests to find a running Spot instance by examining the response. If the status of the Spot instance is fulfilled, the instance ID appears in the response and contains the identifier of the instance. Alternatively, you can use DescribeInstances with a filter to look for instances where the instance lifecycle is spot. Spot instance requests are deleted 4 hours after they are canceled and their instances are terminated.

Parameters

-Filter <Filter[]>
One or more filters.
  • availability-zone-group - The Availability Zone group.
  • create-time - The time stamp when the Spot instance request was created.
  • fault-code - The fault code related to the request.
  • fault-message - The fault message related to the request.
  • instance-id - The ID of the instance that fulfilled the request.
  • launch-group - The Spot instance launch group.
  • launch.block-device-mapping.delete-on-termination - Indicates whether the Amazon EBS volume is deleted on instance termination.
  • launch.block-device-mapping.device-name - The device name for the Amazon EBS volume (for example, /dev/sdh).
  • launch.block-device-mapping.snapshot-id - The ID of the snapshot used for the Amazon EBS volume.
  • launch.block-device-mapping.volume-size - The size of the Amazon EBS volume, in GiB.
  • launch.block-device-mapping.volume-type - The type of the Amazon EBS volume: gp2 for General Purpose SSD, io1 for Provisioned IOPS SSD, st1 for Throughput Optimized HDD, sc1for Cold HDD, or standard for Magnetic.
  • launch.group-id - The security group for the instance.
  • launch.image-id - The ID of the AMI.
  • launch.instance-type - The type of instance (for example, m3.medium).
  • launch.kernel-id - The kernel ID.
  • launch.key-name - The name of the key pair the instance launched with.
  • launch.monitoring-enabled - Whether detailed monitoring is enabled for the Spot instance.
  • launch.ramdisk-id - The RAM disk ID.
  • launched-availability-zone - The Availability Zone in which the bid is launched.
  • network-interface.addresses.primary - Indicates whether the IP address is the primary private IP address.
  • network-interface.delete-on-termination - Indicates whether the network interface is deleted when the instance is terminated.
  • network-interface.description - A description of the network interface.
  • network-interface.device-index - The index of the device for the network interface attachment on the instance.
  • network-interface.group-id - The ID of the security group associated with the network interface.
  • network-interface.network-interface-id - The ID of the network interface.
  • network-interface.private-ip-address - The primary private IP address of the network interface.
  • network-interface.subnet-id - The ID of the subnet for the instance.
  • product-description - The product description associated with the instance (Linux/UNIX | Windows).
  • spot-instance-request-id - The Spot instance request ID.
  • spot-price - The maximum hourly price for any Spot instance launched to fulfill the request.
  • state - The state of the Spot instance request (open | active | closed | cancelled | failed). Spot bid status information can help you track your Amazon EC2 Spot instance requests. For more information, see Spot Bid Status in the Amazon Elastic Compute Cloud User Guide.
  • status-code - The short code describing the most recent evaluation of your Spot instance request.
  • status-message - The message explaining the status of the Spot instance request.
  • tag:key=value - The key/value combination of a tag assigned to the resource. Specify the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag Purpose=X, specify tag:Purpose for the filter name and X for the filter value.
  • tag-key - The 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 is X, see the tag:key=value filter.
  • tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
  • type - The type of Spot instance request (one-time | persistent).
  • valid-from - The start date of the request.
  • valid-until - The end date of the request.
Required?False
Position?2
Accept pipeline input?False
-SpotInstanceRequestId <String[]>
One or more Spot instance request IDs.
Required?False
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a String[] object to this cmdlet for the SpotInstanceRequestId parameter.

Outputs

This cmdlet returns a collection of SpotInstanceRequest objects. The service call response (type Amazon.EC2.Model.DescribeSpotInstanceRequestsResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> Get-EC2SpotInstanceRequest -SpotInstanceRequestId sir-12345678

ActualBlockHourlyPrice :
AvailabilityZoneGroup :
BlockDurationMinutes : 0
CreateTime : 4/8/2015 2:51:33 PM
Fault :
InstanceId : i-12345678
LaunchedAvailabilityZone : us-west-2b
LaunchGroup :
LaunchSpecification : Amazon.EC2.Model.LaunchSpecification
ProductDescription : Linux/UNIX
SpotInstanceRequestId : sir-12345678
SpotPrice : 0.020000
State : active
Status : Amazon.EC2.Model.SpotInstanceStatus
Tags : {Name}
Type : one-time
This example describes the specified Spot instance request.

Example 2

PS C:\> Get-EC2SpotInstanceRequest
This example describes all your Spot instance requests.

Supported Version

AWS Tools for PowerShell: 2.x.y.z