DescribeGlobalClusters
Returns information about Aurora global database clusters. This API supports pagination.
For more information on Amazon Aurora, see What is Amazon Aurora? in the Amazon Aurora User Guide.
Note
This action only applies to Aurora DB 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 database clusters to describe. This parameter is case-sensitive.
Currently, the only supported filter is
region
.If used, the request returns information about any global cluster with at least one member (primary or secondary) in the specified AWS Regions.
Type: Array of Filter objects
Required: No
- GlobalClusterIdentifier
-
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.
Constraints:
-
If supplied, must match an existing DBClusterIdentifier.
Type: String
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 byMaxRecords
.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.Default: 100
Constraints: Minimum 20, maximum 100.
Type: Integer
Required: No
Response Elements
The following elements are returned by the service.
- GlobalClusters.GlobalClusterMember.N
-
The list of global clusters returned by this request.
Type: Array of GlobalCluster objects
- 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 byMaxRecords
.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 database cluster.HTTP Status Code: 404
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: