ListDeployments - AWS AppConfig


Lists the deployments for an environment in descending deployment number order.

Request Syntax

GET /applications/ApplicationId/environments/EnvironmentId/deployments?max_results=MaxResults&next_token=NextToken HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.


The application ID.

Pattern: [a-z0-9]{4,7}

Required: Yes


The environment ID.

Pattern: [a-z0-9]{4,7}

Required: Yes


The maximum number of items that may be returned for this call. If there are items that have not yet been returned, the response will include a non-null NextToken that you can provide in a subsequent call to get the next set of results.

Valid Range: Minimum value of 1. Maximum value of 50.


The token returned by a prior call to this operation indicating the next set of results to be returned. If not specified, the operation will return the first set of results.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Items": [ { "CompletedAt": "string", "ConfigurationName": "string", "ConfigurationVersion": "string", "DeploymentDurationInMinutes": number, "DeploymentNumber": number, "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "PercentageComplete": number, "StartedAt": "string", "State": "string", "VersionLabel": "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.


The elements from this collection.

Type: Array of DeploymentSummary objects


The token for the next set of items to return. Use this token to get the next set of results.

Type: String

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


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


The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400


There was an internal failure in the AWS AppConfig service.

HTTP Status Code: 500


The requested resource could not be found.

HTTP Status Code: 404



This example illustrates one usage of ListDeployments.

Sample Request

GET /applications/abc1234/environments/54j1r29/deployments HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/2.2.4 Python/3.8.8 Linux/5.4.134-73.228.amzn2int.x86_64 exe/x86_64.amzn.2 prompt/off command/appconfig.list-deployments X-Amz-Date: 20210920T182141Z Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE

Sample Response

{ "Items": [ { "DeploymentNumber": 1, "ConfigurationName": "Example-Configuration-Profile", "ConfigurationVersion": "1", "DeploymentDurationInMinutes": 15, "GrowthType": "LINEAR", "GrowthFactor": 25.0, "FinalBakeTimeInMinutes": 0, "State": "COMPLETE", "PercentageComplete": 100.0, "StartedAt": "2021-09-17T21:43:54.205000+00:00", "CompletedAt": "2021-09-17T21:59:03.888000+00:00" } ] }

See Also

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