ListDeploymentInstances - Amazon CodeDeploy
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).



The newer BatchGetDeploymentTargets should be used instead because it works with all compute types. ListDeploymentInstances throws an exception if it is used with a compute platform other than EC2/On-premises or Amazon Lambda.

Lists the instance for a deployment associated with the user or Amazon Web Services account.

Request Syntax

{ "deploymentId": "string", "instanceStatusFilter": [ "string" ], "instanceTypeFilter": [ "string" ], "nextToken": "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.


The unique ID of a deployment.

Type: String

Required: Yes


A subset of instances to list by status:

  • Pending: Include those instances with pending deployments.

  • InProgress: Include those instances where deployments are still in progress.

  • Succeeded: Include those instances with successful deployments.

  • Failed: Include those instances with failed deployments.

  • Skipped: Include those instances with skipped deployments.

  • Unknown: Include those instances with deployments in an unknown state.

Type: Array of strings

Valid Values: Pending | InProgress | Succeeded | Failed | Skipped | Unknown | Ready

Required: No


The set of instances in a blue/green deployment, either those in the original environment ("BLUE") or those in the replacement environment ("GREEN"), for which you want to view instance information.

Type: Array of strings

Valid Values: Blue | Green

Required: No


An identifier returned from the previous list deployment instances call. It can be used to return the next set of deployment instances in the list.

Type: String

Required: No

Response Syntax

{ "instancesList": [ "string" ], "nextToken": "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.


A list of instance IDs.

Type: Array of strings


If a large amount of information is returned, an identifier is also returned. It can be used in a subsequent list deployment instances call to return the next set of deployment instances in the list.

Type: String


For information about the errors that are common to all actions, see Common Errors.


The deployment with the user or Amazon Web Services account does not exist.

HTTP Status Code: 400


At least one deployment ID must be specified.

HTTP Status Code: 400


The specified deployment has not started.

HTTP Status Code: 400


The computePlatform is invalid. The computePlatform should be Lambda, Server, or ECS.

HTTP Status Code: 400


At least one of the deployment IDs was specified in an invalid format.

HTTP Status Code: 400


An instance type was specified for an in-place deployment. Instance types are supported for blue/green deployments only.

HTTP Status Code: 400


The specified instance status does not exist.

HTTP Status Code: 400


An invalid instance type was specified for instances in a blue/green deployment. Valid values include "Blue" for an original environment and "Green" for a replacement environment.

HTTP Status Code: 400


The next token was specified in an invalid format.

HTTP Status Code: 400


The target filter name is invalid.

HTTP Status Code: 400



This example illustrates one usage of ListDeploymentInstances.

Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 31 X-Amz-Target: CodeDeploy_20141006.ListDeploymentInstances X-Amz-Date: 20160707T021610Z 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 { "deploymentId": "d-74D25NS7C" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: 57a7b3d6-88e3-11e5-8ce3-2704437d0309 Content-Type: application/x-amz-json-1.1 Content-Length: 32 { "instancesList": [ "i-b2f7jf0d00EXAMPLE" ] }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: