docdb_describe_db_clusters: Returns information about provisioned Amazon DocumentDB...

View source: R/docdb_operations.R

docdb_describe_db_clustersR Documentation

Returns information about provisioned Amazon DocumentDB clusters


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.

See for full documentation.


  DBClusterIdentifier = NULL,
  Filters = NULL,
  MaxRecords = NULL,
  Marker = NULL



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


  • If provided, must match an existing DBClusterIdentifier.


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.


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.


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.

paws.database documentation built on Sept. 12, 2023, 1:21 a.m.