StopApplication
Stops a running application.
Request Syntax
POST /applications/applicationId/stop HTTP/1.1
Content-type: application/json
{
"forceStop": boolean
}URI Request Parameters
The request uses the following URI parameters.
- applicationId
-
The unique identifier of the application you want to stop.
Pattern:
^\S{1,80}$Required: Yes
Request Body
The request accepts the following data in JSON format.
- forceStop
-
Stopping an application process can take a long time. Setting this parameter to true lets you force stop the application so you don't need to wait until the process finishes to apply another action on the application. The default value is false.
Type: Boolean
Required: No
Response Syntax
HTTP/1.1 200
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
The account or role doesn't have the right permissions to make the request.
HTTP Status Code: 403
- ConflictException
-
The parameters provided in the request conflict with existing resources.
HTTP Status Code: 409
- InternalServerException
-
An unexpected error occurred during the processing of the request.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource was not found.
HTTP Status Code: 404
- ThrottlingException
-
The number of requests made exceeds the limit.
HTTP Status Code: 429
- ValidationException
-
One or more parameters provided in the request is not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
