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.DescribeDBClusters

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Returns information about provisioned Amazon DocumentDB clusters. This API operation supports pagination. For certain management features such as cluster and instance lifecycle management, Amazon DocumentDB leverages operational technology that is shared with Amazon RDS and Amazon Neptune. Use the filterName=engine,Values=docdb filter parameter to return only Amazon DocumentDB clusters.

This operation returns paginated results.

Synopsis

data DescribeDBClusters = DescribeDBClusters' {
- dbClusterIdentifier :: Maybe Text
- filters :: Maybe [Filter]
- marker :: Maybe Text
- maxRecords :: Maybe Int
}
newDescribeDBClusters :: DescribeDBClusters
describeDBClusters_dbClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text)
describeDBClusters_filters :: Lens' DescribeDBClusters (Maybe [Filter])
describeDBClusters_marker :: Lens' DescribeDBClusters (Maybe Text)
describeDBClusters_maxRecords :: Lens' DescribeDBClusters (Maybe Int)
data DescribeDBClustersResponse = DescribeDBClustersResponse' {
- dbClusters :: Maybe [DBCluster]
- marker :: Maybe Text
- httpStatus :: Int
}
newDescribeDBClustersResponse :: Int -> DescribeDBClustersResponse
describeDBClustersResponse_dbClusters :: Lens' DescribeDBClustersResponse (Maybe [DBCluster])
describeDBClustersResponse_marker :: Lens' DescribeDBClustersResponse (Maybe Text)
describeDBClustersResponse_httpStatus :: Lens' DescribeDBClustersResponse Int

Creating a Request

data DescribeDBClusters Source #

Represents the input to DescribeDBClusters.

See: newDescribeDBClusters smart constructor.

Constructors

DescribeDBClusters'

Fields

dbClusterIdentifier :: Maybe Text
The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.
Constraints:
- If provided, must match an existing DBClusterIdentifier.
filters :: Maybe [Filter]
A filter that specifies one or more clusters to describe.
Supported filters:
- db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.
marker :: Maybe Text
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
maxRecords :: Maybe Int
The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.

Instances

Instances details

Eq DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods (==) :: DescribeDBClusters -> DescribeDBClusters -> Bool # (/=) :: DescribeDBClusters -> DescribeDBClusters -> Bool #
Read DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods readsPrec :: Int -> ReadS DescribeDBClusters # readList :: ReadS [DescribeDBClusters] # readPrec :: ReadPrec DescribeDBClusters # readListPrec :: ReadPrec [DescribeDBClusters] #
Show DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods showsPrec :: Int -> DescribeDBClusters -> ShowS # show :: DescribeDBClusters -> String # showList :: [DescribeDBClusters] -> ShowS #
Generic DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Associated Types type Rep DescribeDBClusters :: Type -> Type # Methods from :: DescribeDBClusters -> Rep DescribeDBClusters x # to :: Rep DescribeDBClusters x -> DescribeDBClusters #
NFData DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods rnf :: DescribeDBClusters -> () #
Hashable DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods hashWithSalt :: Int -> DescribeDBClusters -> Int # hash :: DescribeDBClusters -> Int #
AWSPager DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods page :: DescribeDBClusters -> AWSResponse DescribeDBClusters -> Maybe DescribeDBClusters #
AWSRequest DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Associated Types type AWSResponse DescribeDBClusters # Methods request :: DescribeDBClusters -> Request DescribeDBClusters # response :: MonadResource m => Logger -> Service -> Proxy DescribeDBClusters -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeDBClusters))) #
ToHeaders DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods toHeaders :: DescribeDBClusters -> [Header] #
ToPath DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods toPath :: DescribeDBClusters -> ByteString #
ToQuery DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods toQuery :: DescribeDBClusters -> QueryString #
type Rep DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters type Rep DescribeDBClusters = D1 ('MetaData "DescribeDBClusters" "Amazonka.DocumentDB.DescribeDBClusters" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeDBClusters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dbClusterIdentifier") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Filter]))) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "maxRecords") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))))
type AWSResponse DescribeDBClusters Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters type AWSResponse DescribeDBClusters = DescribeDBClustersResponse

newDescribeDBClusters :: DescribeDBClusters Source #

Create a value of DescribeDBClusters 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:dbClusterIdentifier:DescribeDBClusters', describeDBClusters_dbClusterIdentifier - The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

If provided, must match an existing DBClusterIdentifier.

$sel:filters:DescribeDBClusters', describeDBClusters_filters - A filter that specifies one or more clusters to describe.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

$sel:marker:DescribeDBClusters', describeDBClusters_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:maxRecords:DescribeDBClusters', describeDBClusters_maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Request Lenses

describeDBClusters_dbClusterIdentifier :: Lens' DescribeDBClusters (Maybe Text) Source #

The user-provided cluster identifier. If this parameter is specified, information from only the specific cluster is returned. This parameter isn't case sensitive.

Constraints:

If provided, must match an existing DBClusterIdentifier.

describeDBClusters_filters :: Lens' DescribeDBClusters (Maybe [Filter]) Source #

A filter that specifies one or more clusters to describe.

Supported filters:

db-cluster-id - Accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list only includes information about the clusters identified by these ARNs.

describeDBClusters_marker :: Lens' DescribeDBClusters (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClusters_maxRecords :: Lens' DescribeDBClusters (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 (marker) is included in the response so that the remaining results can be retrieved.

Default: 100

Constraints: Minimum 20, maximum 100.

Destructuring the Response

data DescribeDBClustersResponse Source #

Represents the output of DescribeDBClusters.

See: newDescribeDBClustersResponse smart constructor.

Constructors

DescribeDBClustersResponse'
Fields dbClusters :: Maybe [DBCluster] A list of clusters. marker :: Maybe Text An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by `MaxRecords`. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq DescribeDBClustersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods (==) :: DescribeDBClustersResponse -> DescribeDBClustersResponse -> Bool # (/=) :: DescribeDBClustersResponse -> DescribeDBClustersResponse -> Bool #
Read DescribeDBClustersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods readsPrec :: Int -> ReadS DescribeDBClustersResponse # readList :: ReadS [DescribeDBClustersResponse] # readPrec :: ReadPrec DescribeDBClustersResponse # readListPrec :: ReadPrec [DescribeDBClustersResponse] #
Show DescribeDBClustersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods showsPrec :: Int -> DescribeDBClustersResponse -> ShowS # show :: DescribeDBClustersResponse -> String # showList :: [DescribeDBClustersResponse] -> ShowS #
Generic DescribeDBClustersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Associated Types type Rep DescribeDBClustersResponse :: Type -> Type # Methods from :: DescribeDBClustersResponse -> Rep DescribeDBClustersResponse x # to :: Rep DescribeDBClustersResponse x -> DescribeDBClustersResponse #
NFData DescribeDBClustersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters Methods rnf :: DescribeDBClustersResponse -> () #
type Rep DescribeDBClustersResponse Source #
Instance details Defined in Amazonka.DocumentDB.DescribeDBClusters type Rep DescribeDBClustersResponse = D1 ('MetaData "DescribeDBClustersResponse" "Amazonka.DocumentDB.DescribeDBClusters" "libZSservicesZSamazonka-docdbZSamazonka-docdb" 'False) (C1 ('MetaCons "DescribeDBClustersResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "dbClusters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [DBCluster])) :: (S1 ('MetaSel ('Just "marker") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeDBClustersResponse Source #

Arguments

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

Create a value of DescribeDBClustersResponse 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:dbClusters:DescribeDBClustersResponse', describeDBClustersResponse_dbClusters - A list of clusters.

$sel:marker:DescribeDBClusters', describeDBClustersResponse_marker - An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

$sel:httpStatus:DescribeDBClustersResponse', describeDBClustersResponse_httpStatus - The response's http status code.

Response Lenses

describeDBClustersResponse_dbClusters :: Lens' DescribeDBClustersResponse (Maybe [DBCluster]) Source #

A list of clusters.

describeDBClustersResponse_marker :: Lens' DescribeDBClustersResponse (Maybe Text) Source #

An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

describeDBClustersResponse_httpStatus :: Lens' DescribeDBClustersResponse Int Source #

The response's http status code.