Stops the running cluster that is specified by DBClusterIdentifier. The
cluster must be in the available state. For more information, see
Stopping and
Starting an Amazon DocumentDB Cluster.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- DBClusterIdentifier
-
The identifier of the cluster to stop. Example:
docdb-2019-05-28-15-24-52Type: String
Required: Yes
Response Elements
The following element is returned by the service.
- DBCluster
-
Detailed information about a cluster.
Type: DBCluster object
Errors
For information about the errors that are common to all actions, see Common Errors.
- DBClusterNotFoundFault
-
DBClusterIdentifierdoesn't refer to an existing cluster.HTTP Status Code: 404
- InvalidDBClusterStateFault
-
The cluster isn't in a valid state.
HTTP Status Code: 400
- InvalidDBInstanceState
-
The specified instance isn't in the available state.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
