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 the Dedicated Host reservations that are available to purchase.
The results describe all of the Dedicated Host reservation offerings, including offerings that might not match the instance family and Region of your Dedicated Hosts. When purchasing an offering, ensure that the instance family and Region of the offering matches that of the Dedicated Hosts with which it is to be associated. For more information about supported instance types, see Dedicated Hosts in the Amazon EC2 User Guide.
This operation returns paginated results.
Synopsis
- data DescribeHostReservationOfferings = DescribeHostReservationOfferings' {
- filter' :: Maybe [Filter]
- maxDuration :: Maybe Int
- maxResults :: Maybe Natural
- minDuration :: Maybe Int
- nextToken :: Maybe Text
- offeringId :: Maybe Text
- newDescribeHostReservationOfferings :: DescribeHostReservationOfferings
- describeHostReservationOfferings_filter :: Lens' DescribeHostReservationOfferings (Maybe [Filter])
- describeHostReservationOfferings_maxDuration :: Lens' DescribeHostReservationOfferings (Maybe Int)
- describeHostReservationOfferings_maxResults :: Lens' DescribeHostReservationOfferings (Maybe Natural)
- describeHostReservationOfferings_minDuration :: Lens' DescribeHostReservationOfferings (Maybe Int)
- describeHostReservationOfferings_nextToken :: Lens' DescribeHostReservationOfferings (Maybe Text)
- describeHostReservationOfferings_offeringId :: Lens' DescribeHostReservationOfferings (Maybe Text)
- data DescribeHostReservationOfferingsResponse = DescribeHostReservationOfferingsResponse' {
- nextToken :: Maybe Text
- offeringSet :: Maybe [HostOffering]
- httpStatus :: Int
- newDescribeHostReservationOfferingsResponse :: Int -> DescribeHostReservationOfferingsResponse
- describeHostReservationOfferingsResponse_nextToken :: Lens' DescribeHostReservationOfferingsResponse (Maybe Text)
- describeHostReservationOfferingsResponse_offeringSet :: Lens' DescribeHostReservationOfferingsResponse (Maybe [HostOffering])
- describeHostReservationOfferingsResponse_httpStatus :: Lens' DescribeHostReservationOfferingsResponse Int
Creating a Request
data DescribeHostReservationOfferings Source #
See: newDescribeHostReservationOfferings
smart constructor.
DescribeHostReservationOfferings' | |
|
Instances
newDescribeHostReservationOfferings :: DescribeHostReservationOfferings Source #
Create a value of DescribeHostReservationOfferings
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:
$sel:filter':DescribeHostReservationOfferings'
, describeHostReservationOfferings_filter
- The filters.
instance-family
- The instance family of the offering (for example,m4
).payment-option
- The payment option (NoUpfront
|PartialUpfront
|AllUpfront
).
$sel:maxDuration:DescribeHostReservationOfferings'
, describeHostReservationOfferings_maxDuration
- This is the maximum duration of the reservation to purchase, specified
in seconds. Reservations are available in one-year and three-year terms.
The number of seconds specified must be the number of seconds in a year
(365x24x60x60) times one of the supported durations (1 or 3). For
example, specify 94608000 for three years.
$sel:maxResults:DescribeHostReservationOfferings'
, describeHostReservationOfferings_maxResults
- The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request with
the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
$sel:minDuration:DescribeHostReservationOfferings'
, describeHostReservationOfferings_minDuration
- This is the minimum duration of the reservation you'd like to purchase,
specified in seconds. Reservations are available in one-year and
three-year terms. The number of seconds specified must be the number of
seconds in a year (365x24x60x60) times one of the supported durations (1
or 3). For example, specify 31536000 for one year.
DescribeHostReservationOfferings
, describeHostReservationOfferings_nextToken
- The token to use to retrieve the next page of results.
DescribeHostReservationOfferings
, describeHostReservationOfferings_offeringId
- The ID of the reservation offering.
Request Lenses
describeHostReservationOfferings_filter :: Lens' DescribeHostReservationOfferings (Maybe [Filter]) Source #
The filters.
instance-family
- The instance family of the offering (for example,m4
).payment-option
- The payment option (NoUpfront
|PartialUpfront
|AllUpfront
).
describeHostReservationOfferings_maxDuration :: Lens' DescribeHostReservationOfferings (Maybe Int) Source #
This is the maximum duration of the reservation to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 94608000 for three years.
describeHostReservationOfferings_maxResults :: Lens' DescribeHostReservationOfferings (Maybe Natural) Source #
The maximum number of results to return for the request in a single
page. The remaining results can be seen by sending another request with
the returned nextToken
value. This value can be between 5 and 500. If
maxResults
is given a larger value than 500, you receive an error.
describeHostReservationOfferings_minDuration :: Lens' DescribeHostReservationOfferings (Maybe Int) Source #
This is the minimum duration of the reservation you'd like to purchase, specified in seconds. Reservations are available in one-year and three-year terms. The number of seconds specified must be the number of seconds in a year (365x24x60x60) times one of the supported durations (1 or 3). For example, specify 31536000 for one year.
describeHostReservationOfferings_nextToken :: Lens' DescribeHostReservationOfferings (Maybe Text) Source #
The token to use to retrieve the next page of results.
describeHostReservationOfferings_offeringId :: Lens' DescribeHostReservationOfferings (Maybe Text) Source #
The ID of the reservation offering.
Destructuring the Response
data DescribeHostReservationOfferingsResponse Source #
See: newDescribeHostReservationOfferingsResponse
smart constructor.
DescribeHostReservationOfferingsResponse' | |
|
Instances
newDescribeHostReservationOfferingsResponse Source #
Create a value of DescribeHostReservationOfferingsResponse
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:
DescribeHostReservationOfferings
, describeHostReservationOfferingsResponse_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:offeringSet:DescribeHostReservationOfferingsResponse'
, describeHostReservationOfferingsResponse_offeringSet
- Information about the offerings.
$sel:httpStatus:DescribeHostReservationOfferingsResponse'
, describeHostReservationOfferingsResponse_httpStatus
- The response's http status code.
Response Lenses
describeHostReservationOfferingsResponse_nextToken :: Lens' DescribeHostReservationOfferingsResponse (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.
describeHostReservationOfferingsResponse_offeringSet :: Lens' DescribeHostReservationOfferingsResponse (Maybe [HostOffering]) Source #
Information about the offerings.
describeHostReservationOfferingsResponse_httpStatus :: Lens' DescribeHostReservationOfferingsResponse Int Source #
The response's http status code.