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.MemoryDb.DescribeReservedNodes

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about reserved nodes for this account, or about a specified reserved node.

This operation returns paginated results.

Synopsis

data DescribeReservedNodes = DescribeReservedNodes' {
- duration :: Maybe Text
- maxResults :: Maybe Int
- nextToken :: Maybe Text
- nodeType :: Maybe Text
- offeringType :: Maybe Text
- reservationId :: Maybe Text
- reservedNodesOfferingId :: Maybe Text
}
newDescribeReservedNodes :: DescribeReservedNodes
describeReservedNodes_duration :: Lens' DescribeReservedNodes (Maybe Text)
describeReservedNodes_maxResults :: Lens' DescribeReservedNodes (Maybe Int)
describeReservedNodes_nextToken :: Lens' DescribeReservedNodes (Maybe Text)
describeReservedNodes_nodeType :: Lens' DescribeReservedNodes (Maybe Text)
describeReservedNodes_offeringType :: Lens' DescribeReservedNodes (Maybe Text)
describeReservedNodes_reservationId :: Lens' DescribeReservedNodes (Maybe Text)
describeReservedNodes_reservedNodesOfferingId :: Lens' DescribeReservedNodes (Maybe Text)
data DescribeReservedNodesResponse = DescribeReservedNodesResponse' {
- nextToken :: Maybe Text
- reservedNodes :: Maybe [ReservedNode]
- httpStatus :: Int
}
newDescribeReservedNodesResponse :: Int -> DescribeReservedNodesResponse
describeReservedNodesResponse_nextToken :: Lens' DescribeReservedNodesResponse (Maybe Text)
describeReservedNodesResponse_reservedNodes :: Lens' DescribeReservedNodesResponse (Maybe [ReservedNode])
describeReservedNodesResponse_httpStatus :: Lens' DescribeReservedNodesResponse Int

Creating a Request

data DescribeReservedNodes Source #

See: newDescribeReservedNodes smart constructor.

Constructors

DescribeReservedNodes'

Fields

duration :: Maybe Text
The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this 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 filter value. Use this parameter to show only those reservations matching the specified node type. 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"
reservationId :: Maybe Text
The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.
reservedNodesOfferingId :: Maybe Text
The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Instances

Instances details

ToJSON DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods toJSON :: DescribeReservedNodes -> Value # toEncoding :: DescribeReservedNodes -> Encoding # toJSONList :: [DescribeReservedNodes] -> Value # toEncodingList :: [DescribeReservedNodes] -> Encoding #
ToHeaders DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods toHeaders :: DescribeReservedNodes -> [Header] #
ToPath DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods toPath :: DescribeReservedNodes -> ByteString #
ToQuery DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods toQuery :: DescribeReservedNodes -> QueryString #
AWSPager DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods page :: DescribeReservedNodes -> AWSResponse DescribeReservedNodes -> Maybe DescribeReservedNodes #
AWSRequest DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Associated Types type AWSResponse DescribeReservedNodes # Methods request :: (Service -> Service) -> DescribeReservedNodes -> Request DescribeReservedNodes # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeReservedNodes -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeReservedNodes))) #
Generic DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Associated Types type Rep DescribeReservedNodes :: Type -> Type # Methods from :: DescribeReservedNodes -> Rep DescribeReservedNodes x # to :: Rep DescribeReservedNodes x -> DescribeReservedNodes #
Read DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods readsPrec :: Int -> ReadS DescribeReservedNodes # readList :: ReadS [DescribeReservedNodes] # readPrec :: ReadPrec DescribeReservedNodes # readListPrec :: ReadPrec [DescribeReservedNodes] #
Show DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods showsPrec :: Int -> DescribeReservedNodes -> ShowS # show :: DescribeReservedNodes -> String # showList :: [DescribeReservedNodes] -> ShowS #
NFData DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods rnf :: DescribeReservedNodes -> () #
Eq DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods (==) :: DescribeReservedNodes -> DescribeReservedNodes -> Bool # (/=) :: DescribeReservedNodes -> DescribeReservedNodes -> Bool #
Hashable DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes Methods hashWithSalt :: Int -> DescribeReservedNodes -> Int # hash :: DescribeReservedNodes -> Int #
type AWSResponse DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes type AWSResponse DescribeReservedNodes = DescribeReservedNodesResponse
type Rep DescribeReservedNodes Source #
Instance details Defined in Amazonka.MemoryDb.DescribeReservedNodes type Rep DescribeReservedNodes = D1 ('MetaData "DescribeReservedNodes" "Amazonka.MemoryDb.DescribeReservedNodes" "amazonka-memorydb-2.0-7JvPQiLpSKi6naAXiKMLiu" 'False) (C1 ('MetaCons "DescribeReservedNodes'" '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 "reservationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "reservedNodesOfferingId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDescribeReservedNodes :: DescribeReservedNodes Source #

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

DescribeReservedNodes, describeReservedNodes_duration - The duration filter value, specified in years or seconds. Use this parameter to show only reservations for this duration.

$sel:maxResults:DescribeReservedNodes', describeReservedNodes_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.

DescribeReservedNodes, describeReservedNodes_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.

DescribeReservedNodes, describeReservedNodes_nodeType - The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

DescribeReservedNodes, describeReservedNodes_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"

DescribeReservedNodes, describeReservedNodes_reservationId - The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

DescribeReservedNodes, describeReservedNodes_reservedNodesOfferingId - The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Request Lenses

describeReservedNodes_duration :: Lens' DescribeReservedNodes (Maybe Text) Source #

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

describeReservedNodes_maxResults :: Lens' DescribeReservedNodes (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.

describeReservedNodes_nextToken :: Lens' DescribeReservedNodes (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.

describeReservedNodes_nodeType :: Lens' DescribeReservedNodes (Maybe Text) Source #

The node type filter value. Use this parameter to show only those reservations matching the specified node type. For more information, see Supported node types.

describeReservedNodes_offeringType :: Lens' DescribeReservedNodes (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"

describeReservedNodes_reservationId :: Lens' DescribeReservedNodes (Maybe Text) Source #

The reserved node identifier filter value. Use this parameter to show only the reservation that matches the specified reservation ID.

describeReservedNodes_reservedNodesOfferingId :: Lens' DescribeReservedNodes (Maybe Text) Source #

The offering identifier filter value. Use this parameter to show only purchased reservations matching the specified offering identifier.

Destructuring the Response

data DescribeReservedNodesResponse Source #

See: newDescribeReservedNodesResponse smart constructor.

Constructors

DescribeReservedNodesResponse'

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.
reservedNodes :: Maybe [ReservedNode]
Returns information about reserved nodes for this account, or about a specified reserved node.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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

newDescribeReservedNodesResponse Source #

Arguments

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

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

DescribeReservedNodes, describeReservedNodesResponse_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:reservedNodes:DescribeReservedNodesResponse', describeReservedNodesResponse_reservedNodes - Returns information about reserved nodes for this account, or about a specified reserved node.

$sel:httpStatus:DescribeReservedNodesResponse', describeReservedNodesResponse_httpStatus - The response's http status code.

Response Lenses

describeReservedNodesResponse_nextToken :: Lens' DescribeReservedNodesResponse (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.

describeReservedNodesResponse_reservedNodes :: Lens' DescribeReservedNodesResponse (Maybe [ReservedNode]) Source #

Returns information about reserved nodes for this account, or about a specified reserved node.

describeReservedNodesResponse_httpStatus :: Lens' DescribeReservedNodesResponse Int Source #

The response's http status code.