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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeHostReservationOfferings Source #

See: newDescribeHostReservationOfferings smart constructor.

Constructors

DescribeHostReservationOfferings'

Fields

filter' :: Maybe [Filter]
The filters.
- instance-family - The instance family of the offering (for example, m4).
- payment-option - The payment option (NoUpfront | PartialUpfront | AllUpfront).
maxDuration :: Maybe Int
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.
maxResults :: Maybe Natural
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.
minDuration :: Maybe Int
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.
nextToken :: Maybe Text
The token to use to retrieve the next page of results.
offeringId :: Maybe Text
The ID of the reservation offering.

Instances

Instances details

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

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.

Constructors

DescribeHostReservationOfferingsResponse'
Fields nextToken :: Maybe Text The token to use to retrieve the next page of results. This value is `null` when there are no more results to return. offeringSet :: Maybe [HostOffering] Information about the offerings. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeHostReservationOfferingsResponse Source #

Arguments

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

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.