Synopsis
Calls the Amazon Elastic Compute Cloud DescribeSpotPriceHistory API operation.
Syntax
Get-EC2SpotPriceHistory-AvailabilityZone <String>-UtcEndTime <DateTime>-Filter <Filter[]>-InstanceType <String[]>-ProductDescription <String[]>-UtcStartTime <DateTime>-EndTime <DateTime>-MaxResult <Int32>-NextToken <String>-StartTime <DateTime>
Description
Describes the Spot price history. For more information, see Spot Instance Pricing History in the Amazon EC2 User Guide for Linux Instances.
When you specify a start and end time, this operation returns the prices of the instance types within the time range that you specified and the time when the price changed. The price is valid within the time period that you specified; the response merely indicates the last time that the price changed.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output.
Parameters
-AvailabilityZone <String>
Filters the results by the specified Availability Zone.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | True (ByPropertyName) |
-EndTime <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use EndTimeUtc instead. Setting either EndTime or EndTimeUtc results in both EndTime and EndTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. EndTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).This parameter is deprecated.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Filter <Filter[]>
One or more filters.
availability-zone- The Availability Zone for which prices should be returned.instance-type- The type of instance (for example,m3.medium).product-description- The product description for the Spot price (Linux/UNIX|SUSE Linux|Windows|Linux/UNIX (Amazon VPC)|SUSE Linux (Amazon VPC)|Windows (Amazon VPC)).spot-price- The Spot price. The value must match exactly (or use wildcards; greater than or less than comparison is not supported).timestamp- The time stamp of the Spot price history, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ). You can use wildcards (* and ?). Greater than or less than comparison is not supported.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | Filters |
-InstanceType <String[]>
Filters the results by the specified instance types.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | InstanceTypes |
-MaxResult <Int32>
The maximum number of results to return in a single call. Specify a value between 1 and 1000. The default value is 1000. To retrieve the remaining results, make another call with the returned
NextToken value. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | MaxItems, MaxResults |
-NextToken <String>
The token for the next set of results.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
Note: This parameter is only used if you are manually controlling output pagination of the service API call.
In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProductDescription <String[]>
Filters the results by the specified basic product descriptions.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ProductDescriptions |
-StartTime <DateTime>
This property is deprecated. Setting this property results in non-UTC DateTimes not being marshalled correctly. Use StartTimeUtc instead. Setting either StartTime or StartTimeUtc results in both StartTime and StartTimeUtc being assigned, the latest assignment to either one of the two property is reflected in the value of both. StartTime is provided for backwards compatibility only and assigning a non-Utc DateTime to it results in the wrong timestamp being passed to the service.The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).This parameter is deprecated.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-UtcEndTime <DateTime>
The date and time, up to the current date, from which to stop retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-UtcStartTime <DateTime>
The date and time, up to the past 90 days, from which to start retrieving the price history data, in UTC format (for example, YYYY-MM-DDTHH:MM:SSZ).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
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
This cmdlet does not accept pipeline input.
Outputs
This cmdlet returns a collection of Amazon.EC2.Model.SpotPrice objects.
The service call response (type Amazon.EC2.Model.DescribeSpotPriceHistoryResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Additionally, the following properties are added as Note properties to the service response type instance for the cmdlet entry in the $AWSHistory stack: NextToken (type System.String)
Examples
Example 1
PS C:\> Get-EC2SpotPriceHistory -InstanceType c3.large -AvailabilityZone us-west-2a -MaxResult 10
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017300
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 7:39:49 AM
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017200
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 7:38:29 AM
AvailabilityZone : us-west-2a
InstanceType : c3.large
Price : 0.017300
ProductDescription : Linux/UNIX (Amazon VPC)
Timestamp : 12/25/2015 6:57:13 AM
...This example gets the last 10 entries in the Spot price history for the specified instance type and Availability Zone. Note that the value specified for the -AvailabilityZone parameter must be valid for the region value supplied to either the cmdlet's -Region parameter (not shown in the example) or set as default in the shell. This example command assumes a default region of 'us-west-2' has been set in the environment.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
