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 |
Describes Reserved Instance offerings that are available for purchase. With Reserved Instances, you purchase the right to launch instances for a period of time. During that time period, you do not receive insufficient capacity errors, and you pay a lower usage rate than the rate charged for On-Demand instances for the actual time used.
If you have listed your own Reserved Instances for sale in the Reserved Instance Marketplace, they will be excluded from these results. This is to ensure that you do not purchase your own Reserved Instances.
For more information, see Reserved Instance Marketplace in the Amazon EC2 User Guide.
This operation returns paginated results.
Synopsis
- data DescribeReservedInstancesOfferings = DescribeReservedInstancesOfferings' {
- availabilityZone :: Maybe Text
- dryRun :: Maybe Bool
- filters :: Maybe [Filter]
- includeMarketplace :: Maybe Bool
- instanceTenancy :: Maybe Tenancy
- instanceType :: Maybe InstanceType
- maxDuration :: Maybe Integer
- maxInstanceCount :: Maybe Int
- maxResults :: Maybe Int
- minDuration :: Maybe Integer
- nextToken :: Maybe Text
- offeringClass :: Maybe OfferingClassType
- offeringType :: Maybe OfferingTypeValues
- productDescription :: Maybe RIProductDescription
- reservedInstancesOfferingIds :: Maybe [Text]
- newDescribeReservedInstancesOfferings :: DescribeReservedInstancesOfferings
- describeReservedInstancesOfferings_availabilityZone :: Lens' DescribeReservedInstancesOfferings (Maybe Text)
- describeReservedInstancesOfferings_dryRun :: Lens' DescribeReservedInstancesOfferings (Maybe Bool)
- describeReservedInstancesOfferings_filters :: Lens' DescribeReservedInstancesOfferings (Maybe [Filter])
- describeReservedInstancesOfferings_includeMarketplace :: Lens' DescribeReservedInstancesOfferings (Maybe Bool)
- describeReservedInstancesOfferings_instanceTenancy :: Lens' DescribeReservedInstancesOfferings (Maybe Tenancy)
- describeReservedInstancesOfferings_instanceType :: Lens' DescribeReservedInstancesOfferings (Maybe InstanceType)
- describeReservedInstancesOfferings_maxDuration :: Lens' DescribeReservedInstancesOfferings (Maybe Integer)
- describeReservedInstancesOfferings_maxInstanceCount :: Lens' DescribeReservedInstancesOfferings (Maybe Int)
- describeReservedInstancesOfferings_maxResults :: Lens' DescribeReservedInstancesOfferings (Maybe Int)
- describeReservedInstancesOfferings_minDuration :: Lens' DescribeReservedInstancesOfferings (Maybe Integer)
- describeReservedInstancesOfferings_nextToken :: Lens' DescribeReservedInstancesOfferings (Maybe Text)
- describeReservedInstancesOfferings_offeringClass :: Lens' DescribeReservedInstancesOfferings (Maybe OfferingClassType)
- describeReservedInstancesOfferings_offeringType :: Lens' DescribeReservedInstancesOfferings (Maybe OfferingTypeValues)
- describeReservedInstancesOfferings_productDescription :: Lens' DescribeReservedInstancesOfferings (Maybe RIProductDescription)
- describeReservedInstancesOfferings_reservedInstancesOfferingIds :: Lens' DescribeReservedInstancesOfferings (Maybe [Text])
- data DescribeReservedInstancesOfferingsResponse = DescribeReservedInstancesOfferingsResponse' {}
- newDescribeReservedInstancesOfferingsResponse :: Int -> DescribeReservedInstancesOfferingsResponse
- describeReservedInstancesOfferingsResponse_nextToken :: Lens' DescribeReservedInstancesOfferingsResponse (Maybe Text)
- describeReservedInstancesOfferingsResponse_reservedInstancesOfferings :: Lens' DescribeReservedInstancesOfferingsResponse (Maybe [ReservedInstancesOffering])
- describeReservedInstancesOfferingsResponse_httpStatus :: Lens' DescribeReservedInstancesOfferingsResponse Int
Creating a Request
data DescribeReservedInstancesOfferings Source #
Contains the parameters for DescribeReservedInstancesOfferings.
See: newDescribeReservedInstancesOfferings
smart constructor.
DescribeReservedInstancesOfferings' | |
|
Instances
newDescribeReservedInstancesOfferings :: DescribeReservedInstancesOfferings Source #
Create a value of DescribeReservedInstancesOfferings
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:
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferings_availabilityZone
- The Availability Zone in which the Reserved Instance can be used.
$sel:dryRun:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_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
.
$sel:filters:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_filters
- One or more filters.
availability-zone
- The Availability Zone where the Reserved Instance can be used.duration
- The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000
|94608000
).fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).instance-type
- The instance type that is covered by the reservation.marketplace
- Set totrue
to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.product-description
- The Reserved Instance product platform description. Instances that include(Amazon VPC)
in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX
|Linux/UNIX (Amazon VPC)
|SUSE Linux
|SUSE Linux (Amazon VPC)
|Red Hat Enterprise Linux
|Red Hat Enterprise Linux (Amazon VPC)
|Red Hat Enterprise Linux with HA (Amazon VPC)
|Windows
|Windows (Amazon VPC)
|Windows with SQL Server Standard
|Windows with SQL Server Standard (Amazon VPC)
|Windows with SQL Server Web
|Windows with SQL Server Web (Amazon VPC)
|Windows with SQL Server Enterprise
|Windows with SQL Server Enterprise (Amazon VPC)
)reserved-instances-offering-id
- The Reserved Instances offering ID.scope
- The scope of the Reserved Instance (Availability Zone
orRegion
).usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
$sel:includeMarketplace:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_includeMarketplace
- Include Reserved Instance Marketplace offerings in the response.
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferings_instanceTenancy
- The tenancy of the instances covered by the reservation. A Reserved
Instance with a tenancy of dedicated
is applied to instances that run
in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host
value cannot be used with this parameter. Use
the default
or dedicated
values only.
Default: default
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferings_instanceType
- The instance type that the reservation will cover (for example,
m1.small
). For more information, see
Instance types
in the Amazon EC2 User Guide.
$sel:maxDuration:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_maxDuration
- The maximum duration (in seconds) to filter when searching for
offerings.
Default: 94608000 (3 years)
$sel:maxInstanceCount:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_maxInstanceCount
- The maximum number of instances to filter when searching for offerings.
Default: 20
$sel:maxResults:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_maxResults
- The maximum number of results to return for the request in a single
page. The remaining results of the initial request can be seen by
sending another request with the returned NextToken
value. The maximum
is 100.
Default: 100
$sel:minDuration:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_minDuration
- The minimum duration (in seconds) to filter when searching for
offerings.
Default: 2592000 (1 month)
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferings_nextToken
- The token to retrieve the next page of results.
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferings_offeringClass
- The offering class of the Reserved Instance. Can be standard
or
convertible
.
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferings_offeringType
- The Reserved Instance offering type. If you are using tools that predate
the 2011-11-01 API version, you only have access to the
Medium Utilization
Reserved Instance offering type.
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferings_productDescription
- The Reserved Instance product platform description. Instances that
include (Amazon VPC)
in the description are for use with Amazon VPC.
$sel:reservedInstancesOfferingIds:DescribeReservedInstancesOfferings'
, describeReservedInstancesOfferings_reservedInstancesOfferingIds
- One or more Reserved Instances offering IDs.
Request Lenses
describeReservedInstancesOfferings_availabilityZone :: Lens' DescribeReservedInstancesOfferings (Maybe Text) Source #
The Availability Zone in which the Reserved Instance can be used.
describeReservedInstancesOfferings_dryRun :: Lens' DescribeReservedInstancesOfferings (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
.
describeReservedInstancesOfferings_filters :: Lens' DescribeReservedInstancesOfferings (Maybe [Filter]) Source #
One or more filters.
availability-zone
- The Availability Zone where the Reserved Instance can be used.duration
- The duration of the Reserved Instance (for example, one year or three years), in seconds (31536000
|94608000
).fixed-price
- The purchase price of the Reserved Instance (for example, 9800.0).instance-type
- The instance type that is covered by the reservation.marketplace
- Set totrue
to show only Reserved Instance Marketplace offerings. When this filter is not used, which is the default behavior, all offerings from both Amazon Web Services and the Reserved Instance Marketplace are listed.product-description
- The Reserved Instance product platform description. Instances that include(Amazon VPC)
in the product platform description will only be displayed to EC2-Classic account holders and are for use with Amazon VPC. (Linux/UNIX
|Linux/UNIX (Amazon VPC)
|SUSE Linux
|SUSE Linux (Amazon VPC)
|Red Hat Enterprise Linux
|Red Hat Enterprise Linux (Amazon VPC)
|Red Hat Enterprise Linux with HA (Amazon VPC)
|Windows
|Windows (Amazon VPC)
|Windows with SQL Server Standard
|Windows with SQL Server Standard (Amazon VPC)
|Windows with SQL Server Web
|Windows with SQL Server Web (Amazon VPC)
|Windows with SQL Server Enterprise
|Windows with SQL Server Enterprise (Amazon VPC)
)reserved-instances-offering-id
- The Reserved Instances offering ID.scope
- The scope of the Reserved Instance (Availability Zone
orRegion
).usage-price
- The usage price of the Reserved Instance, per hour (for example, 0.84).
describeReservedInstancesOfferings_includeMarketplace :: Lens' DescribeReservedInstancesOfferings (Maybe Bool) Source #
Include Reserved Instance Marketplace offerings in the response.
describeReservedInstancesOfferings_instanceTenancy :: Lens' DescribeReservedInstancesOfferings (Maybe Tenancy) Source #
The tenancy of the instances covered by the reservation. A Reserved
Instance with a tenancy of dedicated
is applied to instances that run
in a VPC on single-tenant hardware (i.e., Dedicated Instances).
Important: The host
value cannot be used with this parameter. Use
the default
or dedicated
values only.
Default: default
describeReservedInstancesOfferings_instanceType :: Lens' DescribeReservedInstancesOfferings (Maybe InstanceType) Source #
The instance type that the reservation will cover (for example,
m1.small
). For more information, see
Instance types
in the Amazon EC2 User Guide.
describeReservedInstancesOfferings_maxDuration :: Lens' DescribeReservedInstancesOfferings (Maybe Integer) Source #
The maximum duration (in seconds) to filter when searching for offerings.
Default: 94608000 (3 years)
describeReservedInstancesOfferings_maxInstanceCount :: Lens' DescribeReservedInstancesOfferings (Maybe Int) Source #
The maximum number of instances to filter when searching for offerings.
Default: 20
describeReservedInstancesOfferings_maxResults :: Lens' DescribeReservedInstancesOfferings (Maybe Int) Source #
The maximum number of results to return for the request in a single
page. The remaining results of the initial request can be seen by
sending another request with the returned NextToken
value. The maximum
is 100.
Default: 100
describeReservedInstancesOfferings_minDuration :: Lens' DescribeReservedInstancesOfferings (Maybe Integer) Source #
The minimum duration (in seconds) to filter when searching for offerings.
Default: 2592000 (1 month)
describeReservedInstancesOfferings_nextToken :: Lens' DescribeReservedInstancesOfferings (Maybe Text) Source #
The token to retrieve the next page of results.
describeReservedInstancesOfferings_offeringClass :: Lens' DescribeReservedInstancesOfferings (Maybe OfferingClassType) Source #
The offering class of the Reserved Instance. Can be standard
or
convertible
.
describeReservedInstancesOfferings_offeringType :: Lens' DescribeReservedInstancesOfferings (Maybe OfferingTypeValues) Source #
The Reserved Instance offering type. If you are using tools that predate
the 2011-11-01 API version, you only have access to the
Medium Utilization
Reserved Instance offering type.
describeReservedInstancesOfferings_productDescription :: Lens' DescribeReservedInstancesOfferings (Maybe RIProductDescription) Source #
The Reserved Instance product platform description. Instances that
include (Amazon VPC)
in the description are for use with Amazon VPC.
describeReservedInstancesOfferings_reservedInstancesOfferingIds :: Lens' DescribeReservedInstancesOfferings (Maybe [Text]) Source #
One or more Reserved Instances offering IDs.
Destructuring the Response
data DescribeReservedInstancesOfferingsResponse Source #
Contains the output of DescribeReservedInstancesOfferings.
See: newDescribeReservedInstancesOfferingsResponse
smart constructor.
DescribeReservedInstancesOfferingsResponse' | |
|
Instances
newDescribeReservedInstancesOfferingsResponse Source #
Create a value of DescribeReservedInstancesOfferingsResponse
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:
DescribeReservedInstancesOfferings
, describeReservedInstancesOfferingsResponse_nextToken
- The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
$sel:reservedInstancesOfferings:DescribeReservedInstancesOfferingsResponse'
, describeReservedInstancesOfferingsResponse_reservedInstancesOfferings
- A list of Reserved Instances offerings.
$sel:httpStatus:DescribeReservedInstancesOfferingsResponse'
, describeReservedInstancesOfferingsResponse_httpStatus
- The response's http status code.
Response Lenses
describeReservedInstancesOfferingsResponse_nextToken :: Lens' DescribeReservedInstancesOfferingsResponse (Maybe Text) Source #
The token to use to retrieve the next page of results. This value is
null
when there are no more results to return.
describeReservedInstancesOfferingsResponse_reservedInstancesOfferings :: Lens' DescribeReservedInstancesOfferingsResponse (Maybe [ReservedInstancesOffering]) Source #
A list of Reserved Instances offerings.
describeReservedInstancesOfferingsResponse_httpStatus :: Lens' DescribeReservedInstancesOfferingsResponse Int Source #
The response's http status code.