Amazon Relational Database Service
API Reference (API Version 2014-10-31)


Stops a DB instance. When you stop a DB instance, Amazon RDS retains the DB instance's metadata, including its endpoint, DB parameter group, and option group membership. Amazon RDS also retains the transaction logs so you can do a point-in-time restore if necessary. For more information, see Stopping and Starting a DB instance in the AWS RDS user guide.


This command doesn't apply to Aurora MySQL and Aurora PostgreSQL.

Request Parameters

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


The user-supplied instance identifier.

Type: String

Required: Yes


The user-supplied instance identifier of the DB Snapshot created immediately before the DB instance is stopped.

Type: String

Required: No

Response Elements

The following element is returned by the service.


Contains the details of an Amazon RDS DB instance.

This data type is used as a response element in the DescribeDBInstances action.

Type: DBInstance object


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


DBInstanceIdentifier does not refer to an existing DB instance.

HTTP Status Code: 404


DBSnapshotIdentifier is already used by an existing snapshot.

HTTP Status Code: 400


The DB cluster is not in a valid state.

HTTP Status Code: 400


The specified DB instance is not in the available state.

HTTP Status Code: 400


Request would result in user exceeding the allowed number of DB snapshots.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: