DeleteDeployment
Deletes a deployment.
Request Syntax
POST /deleteDeployment HTTP/1.1
Content-type: application/json
{
"deploymentId": "string
"
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- deploymentId
-
The ID of the deployment.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-]+$
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"status": "string",
"statusReason": "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.
- status
-
The status of the deployment.
Type: String
Valid Values:
COMPLETED | CREATING | DELETE_IN_PROGRESS | DELETE_INITIATING | DELETE_FAILED | DELETED | FAILED | IN_PROGRESS | VALIDATING
- statusReason
-
The reason for the deployment status.
Type: String
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServerException
-
An internal error has occurred. Retry your request, but if the problem persists, contact us with details by posting a question on re:Post
. HTTP Status Code: 500
- ResourceLimitException
-
You have exceeded an AWS Launch Wizard resource limit. For example, you might have too many deployments in progress.
HTTP Status Code: 400
- ResourceNotFoundException
-
The specified workload or deployment resource can't be found.
HTTP Status Code: 404
- ValidationException
-
The input fails to satisfy the constraints specified by an AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: