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 |
Returns information about Neptune global database clusters. This API supports pagination.
This operation returns paginated results.
Synopsis
- data DescribeGlobalClusters = DescribeGlobalClusters' {}
- newDescribeGlobalClusters :: DescribeGlobalClusters
- describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text)
- describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text)
- describeGlobalClusters_maxRecords :: Lens' DescribeGlobalClusters (Maybe Int)
- data DescribeGlobalClustersResponse = DescribeGlobalClustersResponse' {
- globalClusters :: Maybe [GlobalCluster]
- marker :: Maybe Text
- httpStatus :: Int
- newDescribeGlobalClustersResponse :: Int -> DescribeGlobalClustersResponse
- describeGlobalClustersResponse_globalClusters :: Lens' DescribeGlobalClustersResponse (Maybe [GlobalCluster])
- describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text)
- describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int
Creating a Request
data DescribeGlobalClusters Source #
See: newDescribeGlobalClusters
smart constructor.
DescribeGlobalClusters' | |
|
Instances
newDescribeGlobalClusters :: DescribeGlobalClusters Source #
Create a value of DescribeGlobalClusters
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:
DescribeGlobalClusters
, describeGlobalClusters_globalClusterIdentifier
- The user-supplied DB cluster identifier. If this parameter is specified,
only information about the specified DB cluster is returned. This
parameter is not case-sensitive.
Constraints: If supplied, must match an existing DB cluster identifier.
DescribeGlobalClusters
, describeGlobalClusters_marker
- (Optional) A pagination token returned by a previous call to
DescribeGlobalClusters
. If this parameter is specified, the response
will only include records beyond the marker, up to the number specified
by MaxRecords
.
$sel:maxRecords:DescribeGlobalClusters'
, describeGlobalClusters_maxRecords
- The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination marker
token is included in the response that you can use to retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Request Lenses
describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text) Source #
The user-supplied DB cluster identifier. If this parameter is specified, only information about the specified DB cluster is returned. This parameter is not case-sensitive.
Constraints: If supplied, must match an existing DB cluster identifier.
describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text) Source #
(Optional) A pagination token returned by a previous call to
DescribeGlobalClusters
. If this parameter is specified, the response
will only include records beyond the marker, up to the number specified
by MaxRecords
.
describeGlobalClusters_maxRecords :: Lens' DescribeGlobalClusters (Maybe Int) Source #
The maximum number of records to include in the response. If more
records exist than the specified MaxRecords
value, a pagination marker
token is included in the response that you can use to retrieve the
remaining results.
Default: 100
Constraints: Minimum 20, maximum 100.
Destructuring the Response
data DescribeGlobalClustersResponse Source #
See: newDescribeGlobalClustersResponse
smart constructor.
DescribeGlobalClustersResponse' | |
|
Instances
newDescribeGlobalClustersResponse Source #
Create a value of DescribeGlobalClustersResponse
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:globalClusters:DescribeGlobalClustersResponse'
, describeGlobalClustersResponse_globalClusters
- The list of global clusters and instances returned by this request.
DescribeGlobalClusters
, describeGlobalClustersResponse_marker
- A pagination token. If this parameter is returned in the response, more
records are available, which can be retrieved by one or more additional
calls to DescribeGlobalClusters
.
$sel:httpStatus:DescribeGlobalClustersResponse'
, describeGlobalClustersResponse_httpStatus
- The response's http status code.
Response Lenses
describeGlobalClustersResponse_globalClusters :: Lens' DescribeGlobalClustersResponse (Maybe [GlobalCluster]) Source #
The list of global clusters and instances returned by this request.
describeGlobalClustersResponse_marker :: Lens' DescribeGlobalClustersResponse (Maybe Text) Source #
A pagination token. If this parameter is returned in the response, more
records are available, which can be retrieved by one or more additional
calls to DescribeGlobalClusters
.
describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int Source #
The response's http status code.