Skip to content

RDS  >  Operations  >  describe_db_clusters

describe_db_clusters

Operation

describe_db_clusters async

describe_db_clusters(request: DescribeDBClustersInput | DescribeDBClustersInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeDBClustersOutput
describe_db_clusters(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeDBClustersInputDict]) -> DescribeDBClustersOutput

Describes existing Amazon Aurora DB clusters and Multi-AZ DB clusters. This API supports pagination.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

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

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DescribeDBClustersOutput

An instance of DescribeDBClustersOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DescribeDBClustersInput dataclass

Bases: _SerdeShape

Attributes
db_cluster_identifier class-attribute instance-attribute
db_cluster_identifier: str | None = ...

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DB cluster identifier.
filters class-attribute instance-attribute
filters: list[Filter] | None = ...

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

Supported Filters:

  • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

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

  • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

  • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

include_shared class-attribute instance-attribute
include_shared: bool | None = ...

Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

marker class-attribute instance-attribute
marker: str | None = ...

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.

max_records class-attribute instance-attribute
max_records: int | None = ...

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

Dictionaries

DescribeDBClustersInputDict

Bases: TypedDict

Dictionary form of DescribeDBClustersInput.

Attributes
db_cluster_identifier instance-attribute
db_cluster_identifier: str | None

The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

Constraints:

  • If supplied, must match an existing DB cluster identifier.
filters instance-attribute
filters: Sequence[Filter | FilterDict] | None

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

Supported Filters:

  • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

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

  • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

  • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

  • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

include_shared instance-attribute
include_shared: bool | None

Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

marker instance-attribute
marker: str | None

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.

max_records instance-attribute
max_records: int | None

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

Output

DescribeDBClustersOutput dataclass

Bases: _SerdeShape

Contains the result of a successful invocation of the DescribeDBClusters action.

Attributes

db_clusters class-attribute instance-attribute
db_clusters: list[DBCluster] | None = ...

Contains a list of DB clusters for the user.

marker class-attribute instance-attribute
marker: str | None = ...

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

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.