DescribeDBClusters - Amazon Relational Database Service
AWS services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with AWS services in China.


Returns information about provisioned Aurora DB clusters. This API supports pagination.

For more information on Amazon Aurora, see What Is Amazon Aurora? in the Amazon Aurora User Guide.


This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.


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


  • If supplied, must match an existing DBClusterIdentifier.

Type: String

Required: No


A filter that specifies one or more DB clusters to describe.

Supported filters:

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

Type: Array of Filter objects

Required: No


Optional Boolean parameter that specifies whether the output includes information about clusters shared from other AWS accounts.

Type: Boolean

Required: No


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

Type: String

Required: No


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 you can retrieve the remaining results.

Default: 100

Constraints: Minimum 20, maximum 100.

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.


Contains a list of DB clusters for the user.

Type: Array of DBCluster objects


A pagination token that can be used in a later DescribeDBClusters request.

Type: String


For information about the errors that are common to all actions, see Common Errors.


DBClusterIdentifier doesn't refer to an existing DB cluster.

HTTP Status Code: 404



This example illustrates one usage of DescribeDBClusters.

Sample Request ?Action=DescribeDBClusters &MaxRecords=100 &SignatureMethod=HmacSHA256 &SignatureVersion=4 &Version=2014-10-31 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140722/us-east-1/rds/aws4_request &X-Amz-Date=20140722T200807Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=2d4f2b9e8abc31122b5546f94c0499bba47de813cb875f9b9c78e8e19c9afe1b

Sample Response

<DescribeDBClustersResponse xmlns=""> <DescribeDBClustersResult> <DBClusters> <DBCluster> <AssociatedRoles> <DBClusterRole> <RoleArn>arn:aws:iam::123456789012:role/sample-role</RoleArn> <Status>ACTIVE</Status> </DBClusterRole> </AssociatedRoles> <Engine>aurora</Engine> <Status>available</Status> <BackupRetentionPeriod>0</BackupRetentionPeriod> <DBSubnetGroup>my-subgroup</DBSubnetGroup> <EngineVersion>5.6.10a</EngineVersion> <Endpoint></Endpoint> <DBClusterIdentifier>sample-cluster2</DBClusterIdentifier> <PreferredBackupWindow>04:45-05:15</PreferredBackupWindow> <PreferredMaintenanceWindow>sat:05:56-sat:06:26</PreferredMaintenanceWindow> <DBClusterMembers/> <AllocatedStorage>15</AllocatedStorage> <MasterUsername>awsuser</MasterUsername> </DBCluster> <DBCluster> <AssociatedRoles /> <Engine>aurora5.6</Engine> <Status>available</Status> <BackupRetentionPeriod>0</BackupRetentionPeriod> <DBSubnetGroup>my-subgroup</DBSubnetGroup> <EngineVersion>5.6.10a</EngineVersion> <Endpoint></Endpoint> <DBClusterIdentifier>sample-cluster3</DBClusterIdentifier> <PreferredBackupWindow>07:06-07:36</PreferredBackupWindow> <PreferredMaintenanceWindow>tue:10:18-tue:10:48</PreferredMaintenanceWindow> <DBClusterMembers> <DBClusterMember> <IsClusterWriter>true</IsClusterWriter> <DBInstanceIdentifier>sample-cluster3-master</DBInstanceIdentifier> </DBClusterMember> <DBClusterMember> <IsClusterWriter>false</IsClusterWriter> <DBInstanceIdentifier>sample-cluster3-read1</DBInstanceIdentifier> </DBClusterMember> </DBClusterMembers> <AllocatedStorage>15</AllocatedStorage> <MasterUsername>awsuser</MasterUsername> </DBCluster> </DBClusters> </DescribeDBClustersResult> <ResponseMetadata> <RequestId>d682b02c-1383-11b4-a6bb-172dfac7f170</RequestId> </ResponseMetadata> </DescribeDBClustersResponse>

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: