DescribeDBClustersCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { DocDBClient, DescribeDBClustersCommand } from "@aws-sdk/client-docdb"; // ES Modules import
// const { DocDBClient, DescribeDBClustersCommand } = require("@aws-sdk/client-docdb"); // CommonJS import
const client = new DocDBClient(config);
const input = { // DescribeDBClustersMessage
  DBClusterIdentifier: "STRING_VALUE",
  Filters: [ // FilterList
    { // Filter
      Name: "STRING_VALUE", // required
      Values: [ // FilterValueList // required
        "STRING_VALUE",
      ],
    },
  ],
  MaxRecords: Number("int"),
  Marker: "STRING_VALUE",
};
const command = new DescribeDBClustersCommand(input);
const response = await client.send(command);
// { // DBClusterMessage
//   Marker: "STRING_VALUE",
//   DBClusters: [ // DBClusterList
//     { // DBCluster
//       AvailabilityZones: [ // AvailabilityZones
//         "STRING_VALUE",
//       ],
//       BackupRetentionPeriod: Number("int"),
//       DBClusterIdentifier: "STRING_VALUE",
//       DBClusterParameterGroup: "STRING_VALUE",
//       DBSubnetGroup: "STRING_VALUE",
//       Status: "STRING_VALUE",
//       PercentProgress: "STRING_VALUE",
//       EarliestRestorableTime: new Date("TIMESTAMP"),
//       Endpoint: "STRING_VALUE",
//       ReaderEndpoint: "STRING_VALUE",
//       MultiAZ: true || false,
//       Engine: "STRING_VALUE",
//       EngineVersion: "STRING_VALUE",
//       LatestRestorableTime: new Date("TIMESTAMP"),
//       Port: Number("int"),
//       MasterUsername: "STRING_VALUE",
//       PreferredBackupWindow: "STRING_VALUE",
//       PreferredMaintenanceWindow: "STRING_VALUE",
//       ReplicationSourceIdentifier: "STRING_VALUE",
//       ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
//         "STRING_VALUE",
//       ],
//       DBClusterMembers: [ // DBClusterMemberList
//         { // DBClusterMember
//           DBInstanceIdentifier: "STRING_VALUE",
//           IsClusterWriter: true || false,
//           DBClusterParameterGroupStatus: "STRING_VALUE",
//           PromotionTier: Number("int"),
//         },
//       ],
//       VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
//         { // VpcSecurityGroupMembership
//           VpcSecurityGroupId: "STRING_VALUE",
//           Status: "STRING_VALUE",
//         },
//       ],
//       HostedZoneId: "STRING_VALUE",
//       StorageEncrypted: true || false,
//       KmsKeyId: "STRING_VALUE",
//       DbClusterResourceId: "STRING_VALUE",
//       DBClusterArn: "STRING_VALUE",
//       AssociatedRoles: [ // DBClusterRoles
//         { // DBClusterRole
//           RoleArn: "STRING_VALUE",
//           Status: "STRING_VALUE",
//         },
//       ],
//       CloneGroupId: "STRING_VALUE",
//       ClusterCreateTime: new Date("TIMESTAMP"),
//       EnabledCloudwatchLogsExports: [ // LogTypeList
//         "STRING_VALUE",
//       ],
//       DeletionProtection: true || false,
//       StorageType: "STRING_VALUE",
//       MasterUserSecret: { // ClusterMasterUserSecret
//         SecretArn: "STRING_VALUE",
//         SecretStatus: "STRING_VALUE",
//         KmsKeyId: "STRING_VALUE",
//       },
//     },
//   ],
// };

DescribeDBClustersCommand Input

See DescribeDBClustersCommandInput for more details

Parameter
Type
Description
DBClusterIdentifier
string | undefined

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
Filter[] | undefined

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
string | undefined

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
number | undefined

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.

DescribeDBClustersCommand Output

See DescribeDBClustersCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
DBClusters
DBCluster[] | undefined

A list of clusters.

Marker
string | undefined

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.

Throws

Name
Fault
Details
DBClusterNotFoundFault
client

DBClusterIdentifier doesn't refer to an existing cluster.

DocDBServiceException
Base exception class for all service exceptions from DocDB service.