com.amazonaws.services.ec2.model

Class DescribeSpotPriceHistoryRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSpotPriceHistoryRequest

All Implemented Interfaces:

ReadLimitInfo, DryRunSupportedRequest<DescribeSpotPriceHistoryRequest>, Serializable, Cloneable

public class DescribeSpotPriceHistoryRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeSpotPriceHistoryRequest>

Container for the parameters to the DescribeSpotPriceHistory operation.

Describes the Spot price history. The prices returned are listed in chronological order, from the oldest to the most recent, for up to the past 90 days. For more information, see Spot Instance Pricing History in the Amazon Elastic Compute Cloud User Guide .

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.

See Also:

AmazonEC2.describeSpotPriceHistory(DescribeSpotPriceHistoryRequest), Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeSpotPriceHistoryRequest()

Method Summary

Methods

Modifier and Type	Method and Description
DescribeSpotPriceHistoryRequest	clone() Creates a shallow clone of this request.
boolean	equals(Object obj)
String	getAvailabilityZone() Filters the results by the specified Availability Zone.
Request<DescribeSpotPriceHistoryRequest>	getDryRunRequest() This method is intended for internal use only.
Date	getEndTime() 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).
List<Filter>	getFilters() One or more filters.
List<String>	getInstanceTypes() Filters the results by the specified instance types.
Integer	getMaxResults() The maximum number of results to return in a single call.
String	getNextToken() The token for the next set of results.
List<String>	getProductDescriptions() Filters the results by the specified basic product descriptions.
Date	getStartTime() 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).
int	hashCode()
void	setAvailabilityZone(String availabilityZone) Filters the results by the specified Availability Zone.
void	setEndTime(Date endTime) 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).
void	setFilters(Collection<Filter> filters) One or more filters.
void	setInstanceTypes(Collection<String> instanceTypes) Filters the results by the specified instance types.
void	setMaxResults(Integer maxResults) The maximum number of results to return in a single call.
void	setNextToken(String nextToken) The token for the next set of results.
void	setProductDescriptions(Collection<String> productDescriptions) Filters the results by the specified basic product descriptions.
void	setStartTime(Date startTime) 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).
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeSpotPriceHistoryRequest	withAvailabilityZone(String availabilityZone) Filters the results by the specified Availability Zone.
DescribeSpotPriceHistoryRequest	withEndTime(Date endTime) 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).
DescribeSpotPriceHistoryRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeSpotPriceHistoryRequest	withFilters(Filter... filters) One or more filters.
DescribeSpotPriceHistoryRequest	withInstanceTypes(Collection<String> instanceTypes) Filters the results by the specified instance types.
DescribeSpotPriceHistoryRequest	withInstanceTypes(InstanceType... instanceTypes) Filters the results by the specified instance types.
DescribeSpotPriceHistoryRequest	withInstanceTypes(String... instanceTypes) Filters the results by the specified instance types.
DescribeSpotPriceHistoryRequest	withMaxResults(Integer maxResults) The maximum number of results to return in a single call.
DescribeSpotPriceHistoryRequest	withNextToken(String nextToken) The token for the next set of results.
DescribeSpotPriceHistoryRequest	withProductDescriptions(Collection<String> productDescriptions) Filters the results by the specified basic product descriptions.
DescribeSpotPriceHistoryRequest	withProductDescriptions(String... productDescriptions) Filters the results by the specified basic product descriptions.
DescribeSpotPriceHistoryRequest	withStartTime(Date startTime) 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).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSpotPriceHistoryRequest

public DescribeSpotPriceHistoryRequest()

Method Detail

getStartTime

public Date getStartTime()

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).

Returns:

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).

setStartTime

public void setStartTime(Date startTime)

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).

Parameters:

startTime - 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).

withStartTime

public DescribeSpotPriceHistoryRequest withStartTime(Date startTime)

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).

Returns a reference to this object so that method calls can be chained together.

Parameters:

startTime - 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).

Returns:

A reference to this updated object so that method calls can be chained together.

getEndTime

public Date getEndTime()

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).

Returns:

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).

setEndTime

public void setEndTime(Date endTime)

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).

Parameters:

endTime - 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).

withEndTime

public DescribeSpotPriceHistoryRequest withEndTime(Date endTime)

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).

Returns a reference to this object so that method calls can be chained together.

Parameters:

endTime - 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).

Returns:

A reference to this updated object so that method calls can be chained together.

getInstanceTypes

public List<String> getInstanceTypes()

Filters the results by the specified instance types.

Returns:

Filters the results by the specified instance types.

setInstanceTypes

public void setInstanceTypes(Collection<String> instanceTypes)

Filters the results by the specified instance types.

Parameters:

instanceTypes - Filters the results by the specified instance types.

withInstanceTypes

public DescribeSpotPriceHistoryRequest withInstanceTypes(String... instanceTypes)

Filters the results by the specified instance types.

NOTE: This method appends the values to the existing list (if any). Use setInstanceTypes(java.util.Collection) or withInstanceTypes(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceTypes - Filters the results by the specified instance types.

Returns:

A reference to this updated object so that method calls can be chained together.

withInstanceTypes

public DescribeSpotPriceHistoryRequest withInstanceTypes(Collection<String> instanceTypes)

Filters the results by the specified instance types.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceTypes - Filters the results by the specified instance types.

Returns:

A reference to this updated object so that method calls can be chained together.

withInstanceTypes

public DescribeSpotPriceHistoryRequest withInstanceTypes(InstanceType... instanceTypes)

Filters the results by the specified instance types.

Returns a reference to this object so that method calls can be chained together.

Parameters:

instanceTypes - Filters the results by the specified instance types.

Returns:

A reference to this updated object so that method calls can be chained together.

getProductDescriptions

public List<String> getProductDescriptions()

Filters the results by the specified basic product descriptions.

Returns:

Filters the results by the specified basic product descriptions.

setProductDescriptions

public void setProductDescriptions(Collection<String> productDescriptions)

Filters the results by the specified basic product descriptions.

Parameters:

productDescriptions - Filters the results by the specified basic product descriptions.

withProductDescriptions

public DescribeSpotPriceHistoryRequest withProductDescriptions(String... productDescriptions)

Filters the results by the specified basic product descriptions.

NOTE: This method appends the values to the existing list (if any). Use setProductDescriptions(java.util.Collection) or withProductDescriptions(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

productDescriptions - Filters the results by the specified basic product descriptions.

Returns:

A reference to this updated object so that method calls can be chained together.

withProductDescriptions

public DescribeSpotPriceHistoryRequest withProductDescriptions(Collection<String> productDescriptions)

Filters the results by the specified basic product descriptions.

Returns a reference to this object so that method calls can be chained together.

Parameters:

productDescriptions - Filters the results by the specified basic product descriptions.

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

Returns:

One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

Parameters:

filters - One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

withFilters

public DescribeSpotPriceHistoryRequest withFilters(Filter... filters)

One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeSpotPriceHistoryRequest withFilters(Collection<Filter> filters)

One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

filters - One or more filters.

• availability-zone - The Availability Zone for which prices should be returned.

• instance-type - The type of instance (for example, m1.small).

• 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 timestamp 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getAvailabilityZone

public String getAvailabilityZone()

Filters the results by the specified Availability Zone.

Returns:

Filters the results by the specified Availability Zone.

setAvailabilityZone

public void setAvailabilityZone(String availabilityZone)

Filters the results by the specified Availability Zone.

Parameters:

availabilityZone - Filters the results by the specified Availability Zone.

withAvailabilityZone

public DescribeSpotPriceHistoryRequest withAvailabilityZone(String availabilityZone)

Filters the results by the specified Availability Zone.

Returns a reference to this object so that method calls can be chained together.

Parameters:

availabilityZone - Filters the results by the specified Availability Zone.

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

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.

Returns:

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.

setMaxResults

public void setMaxResults(Integer maxResults)

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.

Parameters:

maxResults - 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.

withMaxResults

public DescribeSpotPriceHistoryRequest withMaxResults(Integer maxResults)

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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

maxResults - 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.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

The token for the next set of results.

Returns:

The token for the next set of results.

setNextToken

public void setNextToken(String nextToken)

The token for the next set of results.

Parameters:

nextToken - The token for the next set of results.

withNextToken

public DescribeSpotPriceHistoryRequest withNextToken(String nextToken)

The token for the next set of results.

Returns a reference to this object so that method calls can be chained together.

Parameters:

nextToken - The token for the next set of results.

Returns:

A reference to this updated object so that method calls can be chained together.

getDryRunRequest

public Request<DescribeSpotPriceHistoryRequest> getDryRunRequest()

This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.

Specified by:

getDryRunRequest in interface DryRunSupportedRequest<DescribeSpotPriceHistoryRequest>

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

clone

public DescribeSpotPriceHistoryRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()