| Copyright | (c) 2013-2021 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
Amazonka.Redshift.DescribeReservedNodes
Description
Returns the descriptions of the reserved nodes.
This operation returns paginated results.
Synopsis
- data DescribeReservedNodes = DescribeReservedNodes' {
- reservedNodeId :: Maybe Text
- marker :: Maybe Text
- maxRecords :: Maybe Int
- newDescribeReservedNodes :: DescribeReservedNodes
- describeReservedNodes_reservedNodeId :: Lens' DescribeReservedNodes (Maybe Text)
- describeReservedNodes_marker :: Lens' DescribeReservedNodes (Maybe Text)
- describeReservedNodes_maxRecords :: Lens' DescribeReservedNodes (Maybe Int)
- data DescribeReservedNodesResponse = DescribeReservedNodesResponse' {
- reservedNodes :: Maybe [ReservedNode]
- marker :: Maybe Text
- httpStatus :: Int
- newDescribeReservedNodesResponse :: Int -> DescribeReservedNodesResponse
- describeReservedNodesResponse_reservedNodes :: Lens' DescribeReservedNodesResponse (Maybe [ReservedNode])
- describeReservedNodesResponse_marker :: Lens' DescribeReservedNodesResponse (Maybe Text)
- describeReservedNodesResponse_httpStatus :: Lens' DescribeReservedNodesResponse Int
Creating a Request
data DescribeReservedNodes Source #
See: newDescribeReservedNodes smart constructor.
Constructors
| DescribeReservedNodes' | |
Fields
| |
Instances
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:
$sel:reservedNodeId:DescribeReservedNodes', describeReservedNodes_reservedNodeId - Identifier for the node reservation.
$sel:marker: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.
Request Lenses
describeReservedNodes_reservedNodeId :: Lens' DescribeReservedNodes (Maybe Text) Source #
Identifier for the node reservation.
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.
Destructuring the Response
data DescribeReservedNodesResponse Source #
See: newDescribeReservedNodesResponse smart constructor.
Constructors
| DescribeReservedNodesResponse' | |
Fields
| |
Instances
newDescribeReservedNodesResponse Source #
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:
$sel:reservedNodes:DescribeReservedNodesResponse', describeReservedNodesResponse_reservedNodes - The list of ReservedNode objects.
$sel:marker: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:httpStatus:DescribeReservedNodesResponse', describeReservedNodesResponse_httpStatus - The response's http status code.
Response Lenses
describeReservedNodesResponse_reservedNodes :: Lens' DescribeReservedNodesResponse (Maybe [ReservedNode]) Source #
The list of ReservedNode objects.
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_httpStatus :: Lens' DescribeReservedNodesResponse Int Source #
The response's http status code.