| 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.DocumentDB.DescribeGlobalClusters
Description
Returns information about Amazon DocumentDB global clusters. This API supports pagination.
This action only applies to Amazon DocumentDB clusters.
This operation returns paginated results.
Synopsis
- data DescribeGlobalClusters = DescribeGlobalClusters' {}
- newDescribeGlobalClusters :: DescribeGlobalClusters
- describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text)
- describeGlobalClusters_filters :: Lens' DescribeGlobalClusters (Maybe [Filter])
- 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.
Constructors
| DescribeGlobalClusters' | |
Fields
| |
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:
$sel:globalClusterIdentifier:DescribeGlobalClusters', describeGlobalClusters_globalClusterIdentifier - The user-supplied cluster identifier. If this parameter is specified,
information from only the specific cluster is returned. This parameter
isn't case-sensitive.
$sel:filters:DescribeGlobalClusters', describeGlobalClusters_filters - A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id accepts cluster identifiers and
cluster Amazon Resource Names (ARNs). The results list will only include
information about the clusters identified by these ARNs.
$sel:marker:DescribeGlobalClusters', describeGlobalClusters_marker - An optional pagination token provided by a previous
DescribeGlobalClusters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
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 token
called a marker is included in the response so that you can retrieve the
remaining results.
Request Lenses
describeGlobalClusters_globalClusterIdentifier :: Lens' DescribeGlobalClusters (Maybe Text) Source #
The user-supplied cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case-sensitive.
describeGlobalClusters_filters :: Lens' DescribeGlobalClusters (Maybe [Filter]) Source #
A filter that specifies one or more global DB clusters to describe.
Supported filters: db-cluster-id accepts cluster identifiers and
cluster Amazon Resource Names (ARNs). The results list will only include
information about the clusters identified by these ARNs.
describeGlobalClusters_marker :: Lens' DescribeGlobalClusters (Maybe Text) Source #
An optional pagination token provided by a previous
DescribeGlobalClusters request. If this parameter is specified, the
response includes only records beyond the marker, up to the value
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 token
called a marker is included in the response so that you can retrieve the
remaining results.
Destructuring the Response
data DescribeGlobalClustersResponse Source #
See: newDescribeGlobalClustersResponse smart constructor.
Constructors
| DescribeGlobalClustersResponse' | |
Fields
| |
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 -
$sel:marker:DescribeGlobalClusters', describeGlobalClustersResponse_marker -
$sel:httpStatus:DescribeGlobalClustersResponse', describeGlobalClustersResponse_httpStatus - The response's http status code.
Response Lenses
describeGlobalClustersResponse_globalClusters :: Lens' DescribeGlobalClustersResponse (Maybe [GlobalCluster]) Source #
describeGlobalClustersResponse_httpStatus :: Lens' DescribeGlobalClustersResponse Int Source #
The response's http status code.