Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443136141.7 KB

Starts a deployment.

post/applications/{ApplicationId}/environments/{EnvironmentId}/deployments

Path parameters

ApplicationIdstring required

The application ID.

EnvironmentIdstring required

The environment ID.

Request body

DeploymentStrategyIdstring required

The deployment strategy ID.

ConfigurationProfileIdstring required

The configuration profile ID.

ConfigurationVersionstring required

The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label.

Descriptionstring

A description of the deployment.

Tagsobject

Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

KmsKeyIdentifierstring

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

Response

Success

ApplicationIdstring

The ID of the application that was deployed.

EnvironmentIdstring

The ID of the environment that was deployed.

DeploymentStrategyIdstring

The ID of the deployment strategy that was deployed.

ConfigurationProfileIdstring

The ID of the configuration profile that was deployed.

DeploymentNumberinteger

The sequence number of the deployment.

ConfigurationNamestring

The name of the configuration.

ConfigurationLocationUristring

Information about the source location of the configuration.

ConfigurationVersionstring

The configuration version that was deployed.

Descriptionstring

The description of the deployment.

DeploymentDurationInMinutesinteger

Total amount of time the deployment lasted.

GrowthType'LINEAR' | 'EXPONENTIAL'

The algorithm used to define how percentage grew over time.

GrowthFactornumber float

The percentage of targets to receive a deployed configuration during each interval.

FinalBakeTimeInMinutesinteger

The amount of time that AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.

State'BAKING' | 'VALIDATING' | 'DEPLOYING' | 'COMPLETE' | 'ROLLING_BACK' | 'ROLLED_BACK'

The state of the deployment.

PercentageCompletenumber float

The percentage of targets for which the deployment is available.

StartedAtstring date-time

The time the deployment started.

CompletedAtstring date-time

The time the deployment completed.

KmsKeyArnstring

The Amazon Resource Name of the Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Web Services Systems Manager Parameter Store.

KmsKeyIdentifierstring

The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

Example response

{
  "DeploymentDurationInMinutes": 15,
  "DeploymentNumber": 2,
  "FinalBakeTimeInMinutes": 0,
  "GrowthFactor": 25,
  "PercentageComplete": 1
}