AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
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:
See also: AWS API Documentation
batch-get-deployment-targets
--deployment-id <value>
--target-ids <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--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 Amazon EC2 or on-premises instances IDs, and their target type is
instanceTarget
.- For deployments that use the 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 isecsTarget
.- For deployments that are deployed with CloudFormation, the target IDs are CloudFormation stack IDs. Their target type is
cloudFormationTarget
.(string)
Syntax:
"string" "string" ...
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
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 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.
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 Amazon EC2 or on-premises instance.
- Lambda : The target object is a specific version of an Lambda function.
- Amazon ECS : The target object is an Amazon ECS service.
- CloudFormation : The target object is an 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 ofinstanceTarget
.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 asApplicationStop
,BeforeInstall
,AfterInstall
,ApplicationStart
, orValidateService
.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, 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 Lambda compute platform.
deploymentId -> (string)
The unique ID of a deployment.targetId -> (string)
The unique ID of a deployment target that has a type oflambdaTarget
.targetArn -> (string)
The Amazon Resource Name (ARN) of the target.status -> (string)
The status an 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 asApplicationStop
,BeforeInstall
,AfterInstall
,ApplicationStart
, orValidateService
.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, 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 Lambda Function Aliases in the 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 ofecsTarget
.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 asApplicationStop
,BeforeInstall
,AfterInstall
,ApplicationStart
, orValidateService
.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, 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 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 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 anECSTaskSet
.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 thePENDING
status during an Amazon ECS deployment. A task in thePENDING
state is preparing to enter theRUNNING
state. A task set enters thePENDING
status when it launches for the first time, or when it is restarted after being in theSTOPPED
state.runningCount -> (long)
The number of tasks in the task set that are in theRUNNING
status during an Amazon ECS deployment. A task in theRUNNING
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 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 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 CloudFormation blue/green deployment.targetId -> (string)
The unique ID of a deployment target that has a type ofCloudFormationTarget
.lastUpdatedAt -> (timestamp)
The date and time when the target application was updated by an CloudFormation blue/green deployment.lifecycleEvents -> (list)
The lifecycle events of the CloudFormation blue/green deployment to this target application.
(structure)
Information about a deployment lifecycle event.
lifecycleEventName -> (string)
The deployment lifecycle event name, such asApplicationStop
,BeforeInstall
,AfterInstall
,ApplicationStart
, orValidateService
.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, 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 CloudFormation blue/green deployment's target application.resourceType -> (string)
The resource type for the CloudFormation blue/green deployment.targetVersionWeight -> (double)
The percentage of production traffic that the target version of an CloudFormation blue/green deployment receives.