DeleteDeploymentGroup
Deletes a deployment group.
Request Syntax
{
"applicationName": "string
",
"deploymentGroupName": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- applicationName
-
The name of an Amazon CodeDeploy application associated with the user or Amazon Web Services account.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
- deploymentGroupName
-
The name of a deployment group for the specified application.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
Response Syntax
{
"hooksNotCleanedUp": [
{
"hook": "string",
"name": "string",
"terminationHook": "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.
- hooksNotCleanedUp
-
If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, Amazon CodeDeploy successfully removed all corresponding Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group. If the output contains data, Amazon CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
Type: Array of AutoScalingGroup objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- ApplicationNameRequiredException
-
The minimum number of required application names was not specified.
HTTP Status Code: 400
- DeploymentGroupNameRequiredException
-
The deployment group name was not specified.
HTTP Status Code: 400
- InvalidApplicationNameException
-
The application name was specified in an invalid format.
HTTP Status Code: 400
- InvalidDeploymentGroupNameException
-
The deployment group name was specified in an invalid format.
HTTP Status Code: 400
- InvalidRoleException
-
The service role ARN was specified in an invalid format. Or, if an Auto Scaling group was specified, the specified service role does not grant the appropriate permissions to Amazon EC2 Auto Scaling.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DeleteDeploymentGroup.
Sample Request
POST / HTTP/1.1
Host: codedeploy.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 71
X-Amz-Target: CodeDeploy_20141006.DeleteDeploymentGroup
X-Amz-Date: 20160707T013700Z
User-Agent: aws-cli/1.10.6 Python/2.7.9 Windows/7 botocore/1.3.28
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160707/us-east-1/codedeploy/aws4_request,
SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE
{
"applicationName": "TestApp-eu-west-1",
"deploymentGroupName": "dep-group-abc-123"
}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: dec21774-88dd-11e5-96e5-8bf4ee0ce84e
Content-Type: application/x-amz-json-1.1
Content-Length: 24
{
"hooksNotCleanedUp": []
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: