amazonka-opensearch-2.0: Amazon OpenSearch Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.OpenSearch.DescribeReservedInstanceOfferings

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

ToPath DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

ToQuery DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

AWSRequest DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Generic DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Associated Types

type Rep DescribeReservedInstanceOfferings :: Type -> Type #

Read DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Show DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

NFData DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Eq DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Hashable DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

type AWSResponse DescribeReservedInstanceOfferings Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

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

Instances

Instances details
Generic DescribeReservedInstanceOfferingsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Read DescribeReservedInstanceOfferingsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Show DescribeReservedInstanceOfferingsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

NFData DescribeReservedInstanceOfferingsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

Eq DescribeReservedInstanceOfferingsResponse Source # 
Instance details

Defined in Amazonka.OpenSearch.DescribeReservedInstanceOfferings

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 #

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.