CodeDeploy / Client / delete_deployment_group

delete_deployment_group#

CodeDeploy.Client.delete_deployment_group(**kwargs)#

Deletes a deployment group.

See also: AWS API Documentation

Request Syntax

response = client.delete_deployment_group(
    applicationName='string',
    deploymentGroupName='string'
)

Parameters:

applicationName (string) –
[REQUIRED]

The name of an CodeDeploy application associated with the IAM user or Amazon Web Services account.
deploymentGroupName (string) –
[REQUIRED]

The name of a deployment group for the specified application.

Return type:

dict

Returns:

Response Syntax

{
    'hooksNotCleanedUp': [
        {
            'name': 'string',
            'hook': 'string'
        },
    ]
}

Response Structure

(dict) –

Represents the output of a DeleteDeploymentGroup operation.
- hooksNotCleanedUp (list) –
  
  If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, 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, CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.
  - (dict) –
    
    Information about an Auto Scaling group.
    - name (string) –
      
      The Auto Scaling group name.
    - hook (string) –
      
      An Auto Scaling lifecycle event hook name.

Exceptions

CodeDeploy.Client.exceptions.ApplicationNameRequiredException
CodeDeploy.Client.exceptions.InvalidApplicationNameException
CodeDeploy.Client.exceptions.DeploymentGroupNameRequiredException
CodeDeploy.Client.exceptions.InvalidDeploymentGroupNameException
CodeDeploy.Client.exceptions.InvalidRoleException