Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14106236407.5 KB

Returns information about Amazon DocumentDB global clusters. This API supports pagination.

This action only applies to Amazon DocumentDB clusters.

get/#Action=DescribeGlobalClusters

Query parameters

GlobalClusterIdentifierstring

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

Namestring required

The name of the filter. Filter names are case sensitive.

Valuesstring[] required

One or more filter values. Filter values are case sensitive.

<p>A filter that specifies one or more global DB clusters to describe.</p> <p>Supported filters: <code>db-cluster-id</code> accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.</p>
MaxRecordsinteger

The maximum number of records to include in the response. If more records exist than the specified <code>MaxRecords</code> value, a pagination token called a marker is included in the response so that you can retrieve the remaining results.

Markerstring

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

Action'DescribeGlobalClusters' required
Version'2014-10-31' required

Response

Success