Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

StopApplication

Request is an operation to stop an application.

Parameter ApplicationId is required. Parameters StopConnectedEntity and IncludeEc2InstanceShutdown are optional.

Request Syntax


POST /stop-application HTTP/1.1
Content-type: application/json

{
   "ApplicationId": "string",
   "IncludeEc2InstanceShutdown": boolean,
   "StopConnectedEntity": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

ApplicationId

The ID of the application.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 60.

Pattern: [\w\d\.-]+

Required: Yes

IncludeEc2InstanceShutdown

Boolean. If included and if set to True, the StopApplication operation will shut down the associated Amazon EC2 instance in addition to the application.

Type: Boolean

Required: No

StopConnectedEntity

Specify the ConnectedEntityType. Accepted type is DBMS.

If this parameter is included, the connected DBMS (Database Management System) will be stopped.

Type: String

Valid Values: DBMS

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "OperationId": "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.

OperationId

The ID of the operation.

Type: String

Pattern: [{]?[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}[}]?

Errors

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

ConflictException

A conflict has occurred.

HTTP Status Code: 409

InternalServerException

An internal error has occurred.

HTTP Status Code: 500

ResourceNotFoundException

The resource is not available.

HTTP Status Code: 404

ValidationException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400