batch-get-deployment-targets¶

Description¶

Returns an array of one or more targets associated with a deployment. This method works with all compute types and should be used instead of the deprecated BatchGetDeploymentInstances . The maximum number of targets that can be returned is 25.

The type of targets returned depends on the deployment’s compute platform or deployment method:

EC2/On-premises : Information about EC2 instance targets.
AWS Lambda : Information about Lambda functions targets.
Amazon ECS : Information about Amazon ECS service targets.
CloudFormation : Information about targets of blue/green deployments initiated by a CloudFormation stack update.

Synopsis¶

  batch-get-deployment-targets
[--deployment-id <value>]
[--target-ids <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--deployment-id (string)

The unique ID of a deployment.

--target-ids (list)

The unique IDs of the deployment targets. The compute platform of the deployment determines the type of the targets and their formats. The maximum number of deployment target IDs you can specify is 25.

For deployments that use the EC2/On-premises compute platform, the target IDs are EC2 or on-premises instances IDs, and their target type is instanceTarget .

For deployments that use the AWS Lambda compute platform, the target IDs are the names of Lambda functions, and their target type is instanceTarget .

For deployments that use the Amazon ECS compute platform, the target IDs are pairs of Amazon ECS clusters and services specified using the format <clustername>:<servicename> . Their target type is ecsTarget .

For deployments that are deployed with AWS CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is cloudFormationTarget .

(string)

Syntax:

"string" "string" ...

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples¶

To retrieve the targets associated with a deployment

The following batch-get-deployment-targets example returns information about one of the targets associated with the specified deployment.

aws deploy batch-get-deployment-targets \
    --deployment-id "d-1A2B3C4D5" \
    --target-ids "i-01a2b3c4d5e6f1111"

Output:

{
    "deploymentTargets": [
        {
            "deploymentTargetType": "InstanceTarget",
            "instanceTarget": {
                "lifecycleEvents": [
                    {
                        "startTime": 1556918592.162,
                        "lifecycleEventName": "ApplicationStop",
                        "status": "Succeeded",
                        "endTime": 1556918592.247,
                        "diagnostics": {
                            "scriptName": "",
                            "errorCode": "Success",
                            "logTail": "",
                            "message": "Succeeded"
                        }
                    },
                    {
                        "startTime": 1556918593.193,
                        "lifecycleEventName": "DownloadBundle",
                        "status": "Succeeded",
                        "endTime": 1556918593.981,
                        "diagnostics": {
                            "scriptName": "",
                            "errorCode": "Success",
                            "logTail": "",
                            "message": "Succeeded"
                        }
                    },
                    {
                        "startTime": 1556918594.805,
                        "lifecycleEventName": "BeforeInstall",
                        "status": "Succeeded",
                        "endTime": 1556918681.807,
                        "diagnostics": {
                            "scriptName": "",
                            "errorCode": "Success",
                            "logTail": "",
                            "message": "Succeeded"
                        }
                    }
                ],
                "targetArn": "arn:aws:ec2:us-west-2:123456789012:instance/i-01a2b3c4d5e6f1111",
                "deploymentId": "d-1A2B3C4D5",
                "lastUpdatedAt": 1556918687.504,
                "targetId": "i-01a2b3c4d5e6f1111",
                "status": "Succeeded"
            }
        }
    ]
}

For more information, see BatchGetDeploymentTargets in the AWS CodeDeploy API Reference.

Output¶

deploymentTargets -> (list)

A list of target objects for a deployment. Each target object contains details about the target, such as its status and lifecycle events. The type of the target objects depends on the deployment’ compute platform.

EC2/On-premises : Each target object is an EC2 or on-premises instance.

AWS Lambda : The target object is a specific version of an AWS Lambda function.

Amazon ECS : The target object is an Amazon ECS service.

CloudFormation : The target object is an AWS CloudFormation blue/green deployment.

(structure)

Information about the deployment target.

deploymentTargetType -> (string)

The deployment type that is specific to the deployment’s compute platform or deployments initiated by a CloudFormation stack update.

instanceTarget -> (structure)

Information about the target for a deployment that uses the EC2/On-premises compute platform.

deploymentId -> (string)

The unique ID of a deployment.

targetId -> (string)

The unique ID of a deployment target that has a type of instanceTarget .

targetArn -> (string)

The Amazon Resource Name (ARN) of the target.

status -> (string)

The status an EC2/On-premises deployment’s target instance.

lastUpdatedAt -> (timestamp)

The date and time when the target instance was updated by a deployment.

lifecycleEvents -> (list)

The lifecycle events of the deployment to this target instance.

(structure)

Information about a deployment lifecycle event.

lifecycleEventName -> (string)

The deployment lifecycle event name, such as ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart , or ValidateService .

diagnostics -> (structure)

Diagnostic information about the deployment lifecycle event.

errorCode -> (string)

The associated error code:

Success: The specified script ran.

ScriptMissing: The specified script was not found in the specified location.

ScriptNotExecutable: The specified script is not a recognized executable file type.

ScriptTimedOut: The specified script did not finish running in the specified time period.

ScriptFailed: The specified script failed to run as expected.

UnknownError: The specified script did not run for an unknown reason.

scriptName -> (string)

The name of the script.

message -> (string)

The message associated with the error.

logTail -> (string)

The last portion of the diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

startTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event started.

endTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event ended.

status -> (string)

The deployment lifecycle event status:

Pending: The deployment lifecycle event is pending.

InProgress: The deployment lifecycle event is in progress.

Succeeded: The deployment lifecycle event ran successfully.

Failed: The deployment lifecycle event has failed.

Skipped: The deployment lifecycle event has been skipped.

Unknown: The deployment lifecycle event is unknown.

instanceLabel -> (string)

A label that identifies whether the instance is an original target (BLUE ) or a replacement target (GREEN ).

lambdaTarget -> (structure)

Information about the target for a deployment that uses the AWS Lambda compute platform.

deploymentId -> (string)

The unique ID of a deployment.

targetId -> (string)

The unique ID of a deployment target that has a type of lambdaTarget .

targetArn -> (string)

The Amazon Resource Name (ARN) of the target.

status -> (string)

The status an AWS Lambda deployment’s target Lambda function.

lastUpdatedAt -> (timestamp)

The date and time when the target Lambda function was updated by a deployment.

lifecycleEvents -> (list)

The lifecycle events of the deployment to this target Lambda function.

(structure)

Information about a deployment lifecycle event.

lifecycleEventName -> (string)

The deployment lifecycle event name, such as ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart , or ValidateService .

diagnostics -> (structure)

Diagnostic information about the deployment lifecycle event.

errorCode -> (string)

The associated error code:

Success: The specified script ran.

ScriptMissing: The specified script was not found in the specified location.

ScriptNotExecutable: The specified script is not a recognized executable file type.

ScriptTimedOut: The specified script did not finish running in the specified time period.

ScriptFailed: The specified script failed to run as expected.

UnknownError: The specified script did not run for an unknown reason.

scriptName -> (string)

The name of the script.

message -> (string)

The message associated with the error.

logTail -> (string)

The last portion of the diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

startTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event started.

endTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event ended.

status -> (string)

The deployment lifecycle event status:

Pending: The deployment lifecycle event is pending.

InProgress: The deployment lifecycle event is in progress.

Succeeded: The deployment lifecycle event ran successfully.

Failed: The deployment lifecycle event has failed.

Skipped: The deployment lifecycle event has been skipped.

Unknown: The deployment lifecycle event is unknown.

lambdaFunctionInfo -> (structure)

A LambdaFunctionInfo object that describes a target Lambda function.

functionName -> (string)

The name of a Lambda function.

functionAlias -> (string)

The alias of a Lambda function. For more information, see AWS Lambda Function Aliases in the AWS Lambda Developer Guide .

currentVersion -> (string)

The version of a Lambda function that production traffic points to.

targetVersion -> (string)

The version of a Lambda function that production traffic points to after the Lambda function is deployed.

targetVersionWeight -> (double)

The percentage of production traffic that the target version of a Lambda function receives.

ecsTarget -> (structure)

Information about the target for a deployment that uses the Amazon ECS compute platform.

deploymentId -> (string)

The unique ID of a deployment.

targetId -> (string)

The unique ID of a deployment target that has a type of ecsTarget .

targetArn -> (string)

The Amazon Resource Name (ARN) of the target.

lastUpdatedAt -> (timestamp)

The date and time when the target Amazon ECS application was updated by a deployment.

lifecycleEvents -> (list)

The lifecycle events of the deployment to this target Amazon ECS application.

(structure)

Information about a deployment lifecycle event.

lifecycleEventName -> (string)

The deployment lifecycle event name, such as ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart , or ValidateService .

diagnostics -> (structure)

Diagnostic information about the deployment lifecycle event.

errorCode -> (string)

The associated error code:

Success: The specified script ran.

ScriptMissing: The specified script was not found in the specified location.

ScriptNotExecutable: The specified script is not a recognized executable file type.

ScriptTimedOut: The specified script did not finish running in the specified time period.

ScriptFailed: The specified script failed to run as expected.

UnknownError: The specified script did not run for an unknown reason.

scriptName -> (string)

The name of the script.

message -> (string)

The message associated with the error.

logTail -> (string)

The last portion of the diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

startTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event started.

endTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event ended.

status -> (string)

The deployment lifecycle event status:

Pending: The deployment lifecycle event is pending.

InProgress: The deployment lifecycle event is in progress.

Succeeded: The deployment lifecycle event ran successfully.

Failed: The deployment lifecycle event has failed.

Skipped: The deployment lifecycle event has been skipped.

Unknown: The deployment lifecycle event is unknown.

status -> (string)

The status an Amazon ECS deployment’s target ECS application.

taskSetsInfo -> (list)

The ECSTaskSet objects associated with the ECS target.

(structure)

Information about a set of Amazon ECS tasks in an AWS CodeDeploy deployment. An Amazon ECS task set includes details such as the desired number of tasks, how many tasks are running, and whether the task set serves production traffic. An AWS CodeDeploy application that uses the Amazon ECS compute platform deploys a containerized application in an Amazon ECS service as a task set.

identifer -> (string)

A unique ID of an ECSTaskSet .

desiredCount -> (long)

The number of tasks in a task set. During a deployment that uses the Amazon ECS compute type, CodeDeploy instructs Amazon ECS to create a new task set and uses this value to determine how many tasks to create. After the updated task set is created, CodeDeploy shifts traffic to the new task set.

pendingCount -> (long)

The number of tasks in the task set that are in the PENDING status during an Amazon ECS deployment. A task in the PENDING state is preparing to enter the RUNNING state. A task set enters the PENDING status when it launches for the first time, or when it is restarted after being in the STOPPED state.

runningCount -> (long)

The number of tasks in the task set that are in the RUNNING status during an Amazon ECS deployment. A task in the RUNNING state is running and ready for use.

status -> (string)

The status of the task set. There are three valid task set statuses:

PRIMARY : Indicates the task set is serving production traffic.

ACTIVE : Indicates the task set is not serving production traffic.

DRAINING : Indicates the tasks in the task set are being stopped and their corresponding targets are being deregistered from their target group.

trafficWeight -> (double)

The percentage of traffic served by this task set.

targetGroup -> (structure)

The target group associated with the task set. The target group is used by AWS CodeDeploy to manage traffic to a task set.

name -> (string)

For blue/green deployments, the name of the target group that instances in the original environment are deregistered from, and instances in the replacement environment are registered with. For in-place deployments, the name of the target group that instances are deregistered from, so they are not serving traffic during a deployment, and then re-registered with after the deployment is complete.

taskSetLabel -> (string)

A label that identifies whether the ECS task set is an original target (BLUE ) or a replacement target (GREEN ).

cloudFormationTarget -> (structure)

Information about the target to be updated by an AWS CloudFormation blue/green deployment. This target type is used for all deployments initiated by a CloudFormation stack update.

deploymentId -> (string)

The unique ID of an AWS CloudFormation blue/green deployment.

targetId -> (string)

The unique ID of a deployment target that has a type of CloudFormationTarget .

lastUpdatedAt -> (timestamp)

The date and time when the target application was updated by an AWS CloudFormation blue/green deployment.

lifecycleEvents -> (list)

The lifecycle events of the AWS CloudFormation blue/green deployment to this target application.

(structure)

Information about a deployment lifecycle event.

lifecycleEventName -> (string)

The deployment lifecycle event name, such as ApplicationStop , BeforeInstall , AfterInstall , ApplicationStart , or ValidateService .

diagnostics -> (structure)

Diagnostic information about the deployment lifecycle event.

errorCode -> (string)

The associated error code:

Success: The specified script ran.

ScriptMissing: The specified script was not found in the specified location.

ScriptNotExecutable: The specified script is not a recognized executable file type.

ScriptTimedOut: The specified script did not finish running in the specified time period.

ScriptFailed: The specified script failed to run as expected.

UnknownError: The specified script did not run for an unknown reason.

scriptName -> (string)

The name of the script.

message -> (string)

The message associated with the error.

logTail -> (string)

The last portion of the diagnostic log.

If available, AWS CodeDeploy returns up to the last 4 KB of the diagnostic log.

startTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event started.

endTime -> (timestamp)

A timestamp that indicates when the deployment lifecycle event ended.

status -> (string)

The deployment lifecycle event status:

Pending: The deployment lifecycle event is pending.

InProgress: The deployment lifecycle event is in progress.

Succeeded: The deployment lifecycle event ran successfully.

Failed: The deployment lifecycle event has failed.

Skipped: The deployment lifecycle event has been skipped.

Unknown: The deployment lifecycle event is unknown.

status -> (string)

The status of an AWS CloudFormation blue/green deployment’s target application.

resourceType -> (string)

The resource type for the AWS CloudFormation blue/green deployment.

targetVersionWeight -> (double)

The percentage of production traffic that the target version of an AWS CloudFormation blue/green deployment receives.

Table of Contents

Feedback

User Guide