amazonka-memorydb-2.0: Amazon MemoryDB 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.MemoryDb.DescribeReservedNodesOfferings

Description

Lists available reserved node offerings.

This operation returns paginated results.

Synopsis

Creating a Request

data DescribeReservedNodesOfferings Source #

See: newDescribeReservedNodesOfferings smart constructor.

Constructors

DescribeReservedNodesOfferings' 

Fields

  • duration :: Maybe Text

    Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

  • maxResults :: Maybe Int

    The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

  • nextToken :: Maybe Text

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • nodeType :: Maybe Text

    The node type for the reserved nodes. For more information, see Supported node types.

  • offeringType :: Maybe Text

    The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

  • reservedNodesOfferingId :: Maybe Text

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Instances

Instances details
ToJSON DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

ToHeaders DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

ToPath DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

ToQuery DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

AWSPager DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

AWSRequest DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Generic DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Associated Types

type Rep DescribeReservedNodesOfferings :: Type -> Type #

Read DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Show DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

NFData DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Eq DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Hashable DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

type AWSResponse DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

type Rep DescribeReservedNodesOfferings Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

type Rep DescribeReservedNodesOfferings = D1 ('MetaData "DescribeReservedNodesOfferings" "Amazonka.MemoryDb.DescribeReservedNodesOfferings" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeReservedNodesOfferings'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "duration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "nodeType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "offeringType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "reservedNodesOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeReservedNodesOfferings :: DescribeReservedNodesOfferings Source #

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

DescribeReservedNodesOfferings, describeReservedNodesOfferings_duration - Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

$sel:maxResults:DescribeReservedNodesOfferings', describeReservedNodesOfferings_maxResults - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

DescribeReservedNodesOfferings, describeReservedNodesOfferings_nextToken - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

DescribeReservedNodesOfferings, describeReservedNodesOfferings_nodeType - The node type for the reserved nodes. For more information, see Supported node types.

DescribeReservedNodesOfferings, describeReservedNodesOfferings_offeringType - The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

DescribeReservedNodesOfferings, describeReservedNodesOfferings_reservedNodesOfferingId - The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Request Lenses

describeReservedNodesOfferings_duration :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

Duration filter value, specified in years or seconds. Use this parameter to show only reservations for a given duration.

describeReservedNodesOfferings_maxResults :: Lens' DescribeReservedNodesOfferings (Maybe Int) Source #

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a marker is included in the response so that the remaining results can be retrieved.

describeReservedNodesOfferings_nextToken :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeReservedNodesOfferings_nodeType :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

The node type for the reserved nodes. For more information, see Supported node types.

describeReservedNodesOfferings_offeringType :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

The offering type filter value. Use this parameter to show only the available offerings matching the specified offering type. Valid values: "All Upfront"|"Partial Upfront"| "No Upfront"

describeReservedNodesOfferings_reservedNodesOfferingId :: Lens' DescribeReservedNodesOfferings (Maybe Text) Source #

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

Destructuring the Response

data DescribeReservedNodesOfferingsResponse Source #

Constructors

DescribeReservedNodesOfferingsResponse' 

Fields

  • nextToken :: Maybe Text

    An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

  • reservedNodesOfferings :: Maybe [ReservedNodesOffering]

    Lists available reserved node offerings.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeReservedNodesOfferingsResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Read DescribeReservedNodesOfferingsResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Show DescribeReservedNodesOfferingsResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

NFData DescribeReservedNodesOfferingsResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

Eq DescribeReservedNodesOfferingsResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

type Rep DescribeReservedNodesOfferingsResponse Source # 
Instance details

Defined in Amazonka.MemoryDb.DescribeReservedNodesOfferings

type Rep DescribeReservedNodesOfferingsResponse = D1 ('MetaData "DescribeReservedNodesOfferingsResponse" "Amazonka.MemoryDb.DescribeReservedNodesOfferings" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeReservedNodesOfferingsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "reservedNodesOfferings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ReservedNodesOffering])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeReservedNodesOfferingsResponse Source #

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

DescribeReservedNodesOfferings, describeReservedNodesOfferingsResponse_nextToken - An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:reservedNodesOfferings:DescribeReservedNodesOfferingsResponse', describeReservedNodesOfferingsResponse_reservedNodesOfferings - Lists available reserved node offerings.

$sel:httpStatus:DescribeReservedNodesOfferingsResponse', describeReservedNodesOfferingsResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedNodesOfferingsResponse_nextToken :: Lens' DescribeReservedNodesOfferingsResponse (Maybe Text) Source #

An optional marker returned from a prior request. Use this marker for pagination of results from this operation. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.