DescribeMultiRegionClusters
Returns details about one or more multi-Region clusters.
Request Syntax
{
"MaxResults": number,
"MultiRegionClusterName": "string",
"NextToken": "string",
"ShowClusterDetails": boolean
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- MaxResults
-
The maximum number of results to return.
Type: Integer
Required: No
- MultiRegionClusterName
-
The name of a specific multi-Region cluster to describe.
Type: String
Required: No
- NextToken
-
A token to specify where to start paginating.
Type: String
Required: No
- ShowClusterDetails
-
Details about the multi-Region cluster.
Type: Boolean
Required: No
Response Syntax
{
"MultiRegionClusters": [
{
"ARN": "string",
"Clusters": [
{
"ARN": "string",
"ClusterName": "string",
"Region": "string",
"Status": "string"
}
],
"Description": "string",
"Engine": "string",
"EngineVersion": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"NodeType": "string",
"NumberOfShards": number,
"Status": "string",
"TLSEnabled": boolean
}
],
"NextToken": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- MultiRegionClusters
-
A list of multi-Region clusters.
Type: Array of MultiRegionCluster objects
- NextToken
-
A token to use to retrieve the next page of results.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- ClusterNotFoundFault
-
HTTP Status Code: 400
- InvalidParameterCombinationException
-
HTTP Status Code: 400
- InvalidParameterValueException
-
HTTP Status Code: 400
- MultiRegionClusterNotFoundFault
-
The specified multi-Region cluster does not exist.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
