Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.EC2.DescribeSpotPriceHistory

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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, the operation returns the prices of the instance types within that time range. It also returns the last price change before the start time, which is the effective price as of the start time.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeSpotPriceHistory Source #

Contains the parameters for DescribeSpotPriceHistory.

See: newDescribeSpotPriceHistory smart constructor.

Constructors

DescribeSpotPriceHistory'

Fields

availabilityZone :: Maybe Text
Filters the results by the specified Availability Zone.
dryRun :: Maybe Bool
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.
endTime :: Maybe ISO8601
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).
filters :: Maybe [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 | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (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.
instanceTypes :: Maybe [InstanceType]
Filters the results by the specified instance types.
maxResults :: Maybe Int
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.
nextToken :: Maybe Text
The token for the next set of results.
productDescriptions :: Maybe [Text]
Filters the results by the specified basic product descriptions.
startTime :: Maybe ISO8601
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).

Instances

Instances details

ToHeaders DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods toHeaders :: DescribeSpotPriceHistory -> [Header] #
ToPath DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods toPath :: DescribeSpotPriceHistory -> ByteString #
ToQuery DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods toQuery :: DescribeSpotPriceHistory -> QueryString #
AWSPager DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods page :: DescribeSpotPriceHistory -> AWSResponse DescribeSpotPriceHistory -> Maybe DescribeSpotPriceHistory #
AWSRequest DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Associated Types type AWSResponse DescribeSpotPriceHistory # Methods request :: (Service -> Service) -> DescribeSpotPriceHistory -> Request DescribeSpotPriceHistory # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeSpotPriceHistory -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeSpotPriceHistory))) #
Generic DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Associated Types type Rep DescribeSpotPriceHistory :: Type -> Type # Methods from :: DescribeSpotPriceHistory -> Rep DescribeSpotPriceHistory x # to :: Rep DescribeSpotPriceHistory x -> DescribeSpotPriceHistory #
Read DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods readsPrec :: Int -> ReadS DescribeSpotPriceHistory # readList :: ReadS [DescribeSpotPriceHistory] # readPrec :: ReadPrec DescribeSpotPriceHistory # readListPrec :: ReadPrec [DescribeSpotPriceHistory] #
Show DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods showsPrec :: Int -> DescribeSpotPriceHistory -> ShowS # show :: DescribeSpotPriceHistory -> String # showList :: [DescribeSpotPriceHistory] -> ShowS #
NFData DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods rnf :: DescribeSpotPriceHistory -> () #
Eq DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods (==) :: DescribeSpotPriceHistory -> DescribeSpotPriceHistory -> Bool # (/=) :: DescribeSpotPriceHistory -> DescribeSpotPriceHistory -> Bool #
Hashable DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods hashWithSalt :: Int -> DescribeSpotPriceHistory -> Int # hash :: DescribeSpotPriceHistory -> Int #
type AWSResponse DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory type AWSResponse DescribeSpotPriceHistory = DescribeSpotPriceHistoryResponse
type Rep DescribeSpotPriceHistory Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory type Rep DescribeSpotPriceHistory = D1 ('MetaData "DescribeSpotPriceHistory" "Amazonka.EC2.DescribeSpotPriceHistory" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSpotPriceHistory'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "availabilityZone") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "dryRun") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter])))) :: ((S1 ('MetaSel ('Just "instanceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [InstanceType])) :: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "productDescriptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ISO8601)))))))

newDescribeSpotPriceHistory :: DescribeSpotPriceHistory Source #

Create a value of DescribeSpotPriceHistory with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSpotPriceHistory, describeSpotPriceHistory_availabilityZone - Filters the results by the specified Availability Zone.

$sel:dryRun:DescribeSpotPriceHistory', describeSpotPriceHistory_dryRun - Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

DescribeSpotPriceHistory, describeSpotPriceHistory_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).

$sel:filters:DescribeSpotPriceHistory', describeSpotPriceHistory_filters - 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 | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (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.

DescribeSpotPriceHistory, describeSpotPriceHistory_instanceTypes - Filters the results by the specified instance types.

$sel:maxResults:DescribeSpotPriceHistory', describeSpotPriceHistory_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.

DescribeSpotPriceHistory, describeSpotPriceHistory_nextToken - The token for the next set of results.

$sel:productDescriptions:DescribeSpotPriceHistory', describeSpotPriceHistory_productDescriptions - Filters the results by the specified basic product descriptions.

DescribeSpotPriceHistory, describeSpotPriceHistory_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).

Request Lenses

describeSpotPriceHistory_availabilityZone :: Lens' DescribeSpotPriceHistory (Maybe Text) Source #

Filters the results by the specified Availability Zone.

describeSpotPriceHistory_dryRun :: Lens' DescribeSpotPriceHistory (Maybe Bool) Source #

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

describeSpotPriceHistory_endTime :: Lens' DescribeSpotPriceHistory (Maybe UTCTime) Source #

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

describeSpotPriceHistory_filters :: Lens' DescribeSpotPriceHistory (Maybe [Filter]) Source #

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 | Red Hat Enterprise Linux | SUSE Linux | Windows | Linux/UNIX (Amazon VPC) | Red Hat Enterprise Linux (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.

describeSpotPriceHistory_instanceTypes :: Lens' DescribeSpotPriceHistory (Maybe [InstanceType]) Source #

Filters the results by the specified instance types.

describeSpotPriceHistory_maxResults :: Lens' DescribeSpotPriceHistory (Maybe Int) Source #

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.

describeSpotPriceHistory_nextToken :: Lens' DescribeSpotPriceHistory (Maybe Text) Source #

The token for the next set of results.

describeSpotPriceHistory_productDescriptions :: Lens' DescribeSpotPriceHistory (Maybe [Text]) Source #

Filters the results by the specified basic product descriptions.

describeSpotPriceHistory_startTime :: Lens' DescribeSpotPriceHistory (Maybe UTCTime) Source #

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

Destructuring the Response

data DescribeSpotPriceHistoryResponse Source #

Contains the output of DescribeSpotPriceHistory.

See: newDescribeSpotPriceHistoryResponse smart constructor.

Constructors

DescribeSpotPriceHistoryResponse'
Fields nextToken :: Maybe Text The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return. spotPriceHistory :: Maybe [SpotPrice] The historical Spot prices. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic DescribeSpotPriceHistoryResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Associated Types type Rep DescribeSpotPriceHistoryResponse :: Type -> Type # Methods from :: DescribeSpotPriceHistoryResponse -> Rep DescribeSpotPriceHistoryResponse x # to :: Rep DescribeSpotPriceHistoryResponse x -> DescribeSpotPriceHistoryResponse #
Read DescribeSpotPriceHistoryResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods readsPrec :: Int -> ReadS DescribeSpotPriceHistoryResponse # readList :: ReadS [DescribeSpotPriceHistoryResponse] # readPrec :: ReadPrec DescribeSpotPriceHistoryResponse # readListPrec :: ReadPrec [DescribeSpotPriceHistoryResponse] #
Show DescribeSpotPriceHistoryResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods showsPrec :: Int -> DescribeSpotPriceHistoryResponse -> ShowS # show :: DescribeSpotPriceHistoryResponse -> String # showList :: [DescribeSpotPriceHistoryResponse] -> ShowS #
NFData DescribeSpotPriceHistoryResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods rnf :: DescribeSpotPriceHistoryResponse -> () #
Eq DescribeSpotPriceHistoryResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory Methods (==) :: DescribeSpotPriceHistoryResponse -> DescribeSpotPriceHistoryResponse -> Bool # (/=) :: DescribeSpotPriceHistoryResponse -> DescribeSpotPriceHistoryResponse -> Bool #
type Rep DescribeSpotPriceHistoryResponse Source #
Instance details Defined in Amazonka.EC2.DescribeSpotPriceHistory type Rep DescribeSpotPriceHistoryResponse = D1 ('MetaData "DescribeSpotPriceHistoryResponse" "Amazonka.EC2.DescribeSpotPriceHistory" "amazonka-ec2-2.0-48L9RAJvmvzAdBkRegqWCL" 'False) (C1 ('MetaCons "DescribeSpotPriceHistoryResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "spotPriceHistory") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [SpotPrice])) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeSpotPriceHistoryResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeSpotPriceHistoryResponse'`
-> DescribeSpotPriceHistoryResponse

Create a value of DescribeSpotPriceHistoryResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

DescribeSpotPriceHistory, describeSpotPriceHistoryResponse_nextToken - The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.

$sel:spotPriceHistory:DescribeSpotPriceHistoryResponse', describeSpotPriceHistoryResponse_spotPriceHistory - The historical Spot prices.

$sel:httpStatus:DescribeSpotPriceHistoryResponse', describeSpotPriceHistoryResponse_httpStatus - The response's http status code.

Response Lenses

describeSpotPriceHistoryResponse_nextToken :: Lens' DescribeSpotPriceHistoryResponse (Maybe Text) Source #

The token required to retrieve the next set of results. This value is null or an empty string when there are no more results to return.

describeSpotPriceHistoryResponse_spotPriceHistory :: Lens' DescribeSpotPriceHistoryResponse (Maybe [SpotPrice]) Source #

The historical Spot prices.

describeSpotPriceHistoryResponse_httpStatus :: Lens' DescribeSpotPriceHistoryResponse Int Source #

The response's http status code.