Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

ListDeployments

Lists the deployments in a deployment group for an application registered with the user or AWS account.

Request Syntax


{
   "applicationName": "string",
   "createTimeRange": { 
      "end": number,
      "start": number
   },
   "deploymentGroupName": "string",
   "externalId": "string",
   "includeOnlyStatuses": [ "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.

applicationName

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

Note

If applicationName is specified, then deploymentGroupName must be specified. If it is not specified, then deploymentGroupName must not be specified.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

createTimeRange

A time range (start and end) for returning a subset of the list of deployments.

Type: TimeRange object

Required: No

deploymentGroupName

The name of a deployment group for the specified application.

Note

If deploymentGroupName is specified, then applicationName must be specified. If it is not specified, then applicationName must not be specified.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Required: No

externalId

The unique ID of an external resource for returning deployments linked to the external resource.

Type: String

Required: No

includeOnlyStatuses

A subset of deployments to list by status:

Created: Include created deployments in the resulting list.
Queued: Include queued deployments in the resulting list.
In Progress: Include in-progress deployments in the resulting list.
Succeeded: Include successful deployments in the resulting list.
Failed: Include failed deployments in the resulting list.
Stopped: Include stopped deployments in the resulting list.

Type: Array of strings

Required: No

nextToken

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

Type: String

Required: No

Response Syntax


{
   "deployments": [ "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.

deployments

A list of deployment IDs.

Type: Array of strings

nextToken

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

Type: String

Errors

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

ApplicationDoesNotExistException

The application does not exist with the user or AWS account.

HTTP Status Code: 400

ApplicationNameRequiredException

The minimum number of required application names was not specified.

HTTP Status Code: 400

DeploymentGroupDoesNotExistException

The named deployment group with the user or AWS account does not exist.

HTTP Status Code: 400

DeploymentGroupNameRequiredException

The deployment group name was not specified.

HTTP Status Code: 400

InvalidApplicationNameException

The application name was specified in an invalid format.

HTTP Status Code: 400

InvalidDeploymentGroupNameException

The deployment group name was specified in an invalid format.

HTTP Status Code: 400

InvalidDeploymentStatusException

The specified deployment status doesn't exist or cannot be determined.

HTTP Status Code: 400

InvalidExternalIdException

The external ID was specified in an invalid format.

HTTP Status Code: 400

InvalidInputException

The input was specified in an invalid format.

HTTP Status Code: 400

InvalidNextTokenException

The next token was specified in an invalid format.

HTTP Status Code: 400

InvalidTimeRangeException

The specified time range was specified in an invalid format.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of ListDeployments.

Sample Request


POST / HTTP/1.1
Host: codedeploy.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 99
X-Amz-Target: CodeDeploy_20141006.ListDeployments
X-Amz-Date: 20160707T021907Z
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

{
	"applicationName": "TestApp-us-east-1",
	"deploymentGroupName": "dep-group-def-456"
}

Sample Response


HTTP/1.1 200 OK
x-amzn-RequestId: c15efe85-88e3-11e5-8ce3-2704437d0309
Content-Type: application/x-amz-json-1.1
Content-Length: 45

{
    "deployments": [
        "d-74D87AS7C",
        "d-D1EGTDV4C"
    ]
}