Request Parameters Response Elements Errors See Also

DescribeGlobalClusters

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

Note

This action only applies to Amazon DocumentDB clusters.

Request Parameters

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

Filters.Filter.N

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

Supported filters: db-cluster-id accepts cluster identifiers and cluster Amazon Resource Names (ARNs). The results list will only include information about the clusters identified by these ARNs.

Type: Array of Filter objects

Required: No

GlobalClusterIdentifier

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Pattern: [A-Za-z][0-9A-Za-z-:._]*

Required: No

Marker

An optional pagination token provided by a previous DescribeGlobalClusters 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

MaxRecords

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

Type: Integer

Required: No

Response Elements

The following elements are returned by the service.

GlobalClusters.GlobalClusterMember.N

Type: Array of GlobalCluster objects

Marker

Type: String

Errors

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

GlobalClusterNotFoundFault

The GlobalClusterIdentifier doesn't refer to an existing global cluster.

HTTP Status Code: 404