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.OpenSearch.DescribeReservedInstanceOfferings

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

Synopsis

Creating a Request

data DescribeReservedInstanceOfferings Source #

Container for the request parameters to a DescribeReservedInstanceOfferings operation.

See: newDescribeReservedInstanceOfferings smart constructor.

Constructors

DescribeReservedInstanceOfferings'

Fields

maxResults :: Maybe Int
An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
nextToken :: Maybe Text
If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.
reservedInstanceOfferingId :: Maybe Text
The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

Instances

Instances details

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

newDescribeReservedInstanceOfferings :: DescribeReservedInstanceOfferings Source #

Create a value of DescribeReservedInstanceOfferings 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:maxResults:DescribeReservedInstanceOfferings', describeReservedInstanceOfferings_maxResults - An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

DescribeReservedInstanceOfferings, describeReservedInstanceOfferings_nextToken - If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

DescribeReservedInstanceOfferings, describeReservedInstanceOfferings_reservedInstanceOfferingId - The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

Request Lenses

describeReservedInstanceOfferings_maxResults :: Lens' DescribeReservedInstanceOfferings (Maybe Int) Source #

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

describeReservedInstanceOfferings_nextToken :: Lens' DescribeReservedInstanceOfferings (Maybe Text) Source #

If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

describeReservedInstanceOfferings_reservedInstanceOfferingId :: Lens' DescribeReservedInstanceOfferings (Maybe Text) Source #

The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

Destructuring the Response

data DescribeReservedInstanceOfferingsResponse Source #

Container for results of a DescribeReservedInstanceOfferings request.

See: newDescribeReservedInstanceOfferingsResponse smart constructor.

Constructors

DescribeReservedInstanceOfferingsResponse'
Fields nextToken :: Maybe Text When `nextToken` is returned, there are more results available. The value of `nextToken` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. reservedInstanceOfferings :: Maybe [ReservedInstanceOffering] List of Reserved Instance offerings. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newDescribeReservedInstanceOfferingsResponse Source #

Arguments

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

Create a value of DescribeReservedInstanceOfferingsResponse 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:

DescribeReservedInstanceOfferings, describeReservedInstanceOfferingsResponse_nextToken - When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

$sel:reservedInstanceOfferings:DescribeReservedInstanceOfferingsResponse', describeReservedInstanceOfferingsResponse_reservedInstanceOfferings - List of Reserved Instance offerings.

$sel:httpStatus:DescribeReservedInstanceOfferingsResponse', describeReservedInstanceOfferingsResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedInstanceOfferingsResponse_nextToken :: Lens' DescribeReservedInstanceOfferingsResponse (Maybe Text) Source #

When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

describeReservedInstanceOfferingsResponse_reservedInstanceOfferings :: Lens' DescribeReservedInstanceOfferingsResponse (Maybe [ReservedInstanceOffering]) Source #

List of Reserved Instance offerings.

describeReservedInstanceOfferingsResponse_httpStatus :: Lens' DescribeReservedInstanceOfferingsResponse Int Source #

The response's http status code.