Class ListDeploymentsCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { AppConfigClient, ListDeploymentsCommand } from "@aws-sdk/client-appconfig"; // ES Modules import
// const { AppConfigClient, ListDeploymentsCommand } = require("@aws-sdk/client-appconfig"); // CommonJS import
const client = new AppConfigClient(config);
const input = { // ListDeploymentsRequest
  ApplicationId: "STRING_VALUE", // required
  EnvironmentId: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListDeploymentsCommand(input);
const response = await client.send(command);
// { // Deployments
//   Items: [ // DeploymentList
//     { // DeploymentSummary
//       DeploymentNumber: Number("int"),
//       ConfigurationName: "STRING_VALUE",
//       ConfigurationVersion: "STRING_VALUE",
//       DeploymentDurationInMinutes: Number("int"),
//       GrowthType: "LINEAR" || "EXPONENTIAL",
//       GrowthFactor: Number("float"),
//       FinalBakeTimeInMinutes: Number("int"),
//       State: "BAKING" || "VALIDATING" || "DEPLOYING" || "COMPLETE" || "ROLLING_BACK" || "ROLLED_BACK",
//       PercentageComplete: Number("float"),
//       StartedAt: new Date("TIMESTAMP"),
//       CompletedAt: new Date("TIMESTAMP"),
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListDeploymentsCommandInput

Returns

ListDeploymentsCommandOutput

See

• ListDeploymentsCommandInput for command's input shape.
• ListDeploymentsCommandOutput for command's response shape.
• config for AppConfigClient's config shape.

Throws

BadRequestException (client fault)

The input fails to satisfy the constraints specified by an Amazon Web Services service.

Throws

InternalServerException (server fault)

There was an internal failure in the AppConfig service.

Throws

ResourceNotFoundException (client fault)

The requested resource could not be found.

Throws

AppConfigServiceException

Base exception class for all service exceptions from AppConfig service.

Example

To list the available deployments

// The following list-deployments example lists the available deployments in your AWS account for the specified application and environment.
const input = {
  "ApplicationId": "339ohji",
  "EnvironmentId": "54j1r29"
};
const command = new ListDeploymentsCommand(input);
const response = await client.send(command);
/* response ==
{
  "Items": [
    {
      "CompletedAt": "2021-09-17T21:59:03.888000+00:00",
      "ConfigurationName": "Example-Configuration-Profile",
      "ConfigurationVersion": "1",
      "DeploymentDurationInMinutes": 15,
      "DeploymentNumber": 1,
      "FinalBakeTimeInMinutes": 0,
      "GrowthFactor": 25,
      "GrowthType": "LINEAR",
      "PercentageComplete": 100,
      "StartedAt": "2021-09-17T21:43:54.205000+00:00",
      "State": "COMPLETE"
    }
  ]
}
*/
// example id: to-list-the-available-deployments-1632267282025