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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns the descriptions of the reserved nodes.

This operation returns paginated results.

Synopsis

data DescribeReservedNodes = DescribeReservedNodes' {
- marker :: Maybe Text
- maxRecords :: Maybe Int
- reservedNodeId :: Maybe Text
}
newDescribeReservedNodes :: DescribeReservedNodes
describeReservedNodes_marker :: Lens' DescribeReservedNodes (Maybe Text)
describeReservedNodes_maxRecords :: Lens' DescribeReservedNodes (Maybe Int)
describeReservedNodes_reservedNodeId :: Lens' DescribeReservedNodes (Maybe Text)
data DescribeReservedNodesResponse = DescribeReservedNodesResponse' {
- marker :: Maybe Text
- reservedNodes :: Maybe [ReservedNode]
- httpStatus :: Int
}
newDescribeReservedNodesResponse :: Int -> DescribeReservedNodesResponse
describeReservedNodesResponse_marker :: 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

marker :: Maybe Text
An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.
maxRecords :: Maybe Int
The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.
Default: 100
Constraints: minimum 20, maximum 100.
reservedNodeId :: Maybe Text
Identifier for the node reservation.

Instances

Instances details

ToHeaders DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods toHeaders :: DescribeReservedNodes -> [Header] #
ToPath DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods toPath :: DescribeReservedNodes -> ByteString #
ToQuery DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods toQuery :: DescribeReservedNodes -> QueryString #
AWSPager DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods page :: DescribeReservedNodes -> AWSResponse DescribeReservedNodes -> Maybe DescribeReservedNodes #
AWSRequest DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.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.Redshift.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.Redshift.DescribeReservedNodes Methods readsPrec :: Int -> ReadS DescribeReservedNodes # readList :: ReadS [DescribeReservedNodes] # readPrec :: ReadPrec DescribeReservedNodes # readListPrec :: ReadPrec [DescribeReservedNodes] #
Show DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods showsPrec :: Int -> DescribeReservedNodes -> ShowS # show :: DescribeReservedNodes -> String # showList :: [DescribeReservedNodes] -> ShowS #
NFData DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods rnf :: DescribeReservedNodes -> () #
Eq DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods (==) :: DescribeReservedNodes -> DescribeReservedNodes -> Bool # (/=) :: DescribeReservedNodes -> DescribeReservedNodes -> Bool #
Hashable DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods hashWithSalt :: Int -> DescribeReservedNodes -> Int # hash :: DescribeReservedNodes -> Int #
type AWSResponse DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes type AWSResponse DescribeReservedNodes = DescribeReservedNodesResponse
type Rep DescribeReservedNodes Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes type Rep DescribeReservedNodes = D1 ('MetaData "DescribeReservedNodes" "Amazonka.Redshift.DescribeReservedNodes" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeReservedNodes'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "reservedNodeId") '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_marker - An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

$sel:maxRecords:DescribeReservedNodes', describeReservedNodes_maxRecords - The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

DescribeReservedNodes, describeReservedNodes_reservedNodeId - Identifier for the node reservation.

Request Lenses

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

An optional parameter that specifies the starting point to return a set of response records. When the results of a DescribeReservedNodes request exceed the value specified in MaxRecords, Amazon Web Services returns a value in the Marker field of the response. You can retrieve the next set of response records by providing the returned marker value in the Marker parameter and retrying the request.

describeReservedNodes_maxRecords :: Lens' DescribeReservedNodes (Maybe Int) Source #

The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified MaxRecords value, a value is returned in a marker field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.

Default: 100

Constraints: minimum 20, maximum 100.

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

Identifier for the node reservation.

Destructuring the Response

data DescribeReservedNodesResponse Source #

See: newDescribeReservedNodesResponse smart constructor.

Constructors

DescribeReservedNodesResponse'

Fields

marker :: Maybe Text
A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.
reservedNodes :: Maybe [ReservedNode]
The list of ReservedNode objects.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Generic DescribeReservedNodesResponse Source #
Instance details Defined in Amazonka.Redshift.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.Redshift.DescribeReservedNodes Methods readsPrec :: Int -> ReadS DescribeReservedNodesResponse # readList :: ReadS [DescribeReservedNodesResponse] # readPrec :: ReadPrec DescribeReservedNodesResponse # readListPrec :: ReadPrec [DescribeReservedNodesResponse] #
Show DescribeReservedNodesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods showsPrec :: Int -> DescribeReservedNodesResponse -> ShowS # show :: DescribeReservedNodesResponse -> String # showList :: [DescribeReservedNodesResponse] -> ShowS #
NFData DescribeReservedNodesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods rnf :: DescribeReservedNodesResponse -> () #
Eq DescribeReservedNodesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes Methods (==) :: DescribeReservedNodesResponse -> DescribeReservedNodesResponse -> Bool # (/=) :: DescribeReservedNodesResponse -> DescribeReservedNodesResponse -> Bool #
type Rep DescribeReservedNodesResponse Source #
Instance details Defined in Amazonka.Redshift.DescribeReservedNodes type Rep DescribeReservedNodesResponse = D1 ('MetaData "DescribeReservedNodesResponse" "Amazonka.Redshift.DescribeReservedNodes" "amazonka-redshift-2.0-4tocKxBWIuj2GdXa6djdUl" 'False) (C1 ('MetaCons "DescribeReservedNodesResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "marker") '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_marker - A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

$sel:reservedNodes:DescribeReservedNodesResponse', describeReservedNodesResponse_reservedNodes - The list of ReservedNode objects.

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

Response Lenses

describeReservedNodesResponse_marker :: Lens' DescribeReservedNodesResponse (Maybe Text) Source #

A value that indicates the starting point for the next set of response records in a subsequent request. If a value is returned in a response, you can retrieve the next set of records by providing this returned marker value in the Marker parameter and retrying the command. If the Marker field is empty, all response records have been retrieved for the request.

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

The list of ReservedNode objects.

describeReservedNodesResponse_httpStatus :: Lens' DescribeReservedNodesResponse Int Source #

The response's http status code.