delete-deployment-group¶

Description¶

Deletes a deployment group.

Synopsis¶

  delete-deployment-group
--application-name <value>
--deployment-group-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--application-name (string)

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

--deployment-group-name (string)

The name of a deployment group for the specified application.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To delete a deployment group

The following delete-deployment-group example deletes a deployment group that is associated with the specified application.

aws deploy delete-deployment-group \
    --application-name WordPress_App \
    --deployment-group-name WordPress_DG

Output:

{
    "hooksNotCleanedUp": []
}

Output¶

hooksNotCleanedUp -> (list)

If the output contains no data, and the corresponding deployment group contained at least one Auto Scaling group, AWS 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, AWS CodeDeploy could not remove some Auto Scaling lifecycle event hooks from the Amazon EC2 instances in the Auto Scaling group.

(structure)

Information about an Auto Scaling group.

name -> (string)

The Auto Scaling group name.

hook -> (string)

An Auto Scaling lifecycle event hook name.

Table of Contents

Feedback

User Guide