StopCluster
Stops the running elastic cluster that is specified by clusterArn
.
The elastic cluster must be in the available state.
Request Syntax
POST /cluster/clusterArn
/stop HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- clusterArn
-
The ARN identifier of the elastic cluster.
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"cluster": {
"adminUserName": "string",
"authType": "string",
"backupRetentionPeriod": number,
"clusterArn": "string",
"clusterEndpoint": "string",
"clusterName": "string",
"createTime": "string",
"kmsKeyId": "string",
"preferredBackupWindow": "string",
"preferredMaintenanceWindow": "string",
"shardCapacity": number,
"shardCount": number,
"shardInstanceCount": number,
"shards": [
{
"createTime": "string",
"shardId": "string",
"status": "string"
}
],
"status": "string",
"subnetIds": [ "string" ],
"vpcSecurityGroupIds": [ "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
An exception that occurs when there are not sufficient permissions to perform an action.
HTTP Status Code: 403
- InternalServerException
-
There was an internal server error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be located.
HTTP Status Code: 404
- ThrottlingException
-
ThrottlingException will be thrown when request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
A structure defining a validation exception.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: