StopDeployment
Stops a deployment. This API action works only on deployments that have a status of
DEPLOYING
, unless an AllowRevert
parameter is supplied. If the
AllowRevert
parameter is supplied, the status of an in-progress deployment
will be ROLLED_BACK
. The status of a completed deployment will be
REVERTED
. Amazon AppConfig only allows a revert within 72 hours of
deployment completion.
Request Syntax
DELETE /applications/ApplicationId
/environments/EnvironmentId
/deployments/DeploymentNumber
HTTP/1.1
Allow-Revert: AllowRevert
URI Request Parameters
The request uses the following URI parameters.
- AllowRevert
-
A Boolean that enables Amazon AppConfig to rollback a
COMPLETED
deployment to the previous configuration version. This action moves the deployment to a status ofREVERTED
. - ApplicationId
-
The application ID.
Pattern:
[a-z0-9]{4,7}
Required: Yes
- DeploymentNumber
-
The sequence number of the deployment.
Required: Yes
- EnvironmentId
-
The environment ID.
Pattern:
[a-z0-9]{4,7}
Required: Yes
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 202
Content-type: application/json
{
"ApplicationId": "string",
"AppliedExtensions": [
{
"ExtensionAssociationId": "string",
"ExtensionId": "string",
"Parameters": {
"string" : "string"
},
"VersionNumber": number
}
],
"CompletedAt": "string",
"ConfigurationLocationUri": "string",
"ConfigurationName": "string",
"ConfigurationProfileId": "string",
"ConfigurationVersion": "string",
"DeploymentDurationInMinutes": number,
"DeploymentNumber": number,
"DeploymentStrategyId": "string",
"Description": "string",
"EnvironmentId": "string",
"EventLog": [
{
"ActionInvocations": [
{
"ActionName": "string",
"ErrorCode": "string",
"ErrorMessage": "string",
"ExtensionIdentifier": "string",
"InvocationId": "string",
"RoleArn": "string",
"Uri": "string"
}
],
"Description": "string",
"EventType": "string",
"OccurredAt": "string",
"TriggeredBy": "string"
}
],
"FinalBakeTimeInMinutes": number,
"GrowthFactor": number,
"GrowthType": "string",
"KmsKeyArn": "string",
"KmsKeyIdentifier": "string",
"PercentageComplete": number,
"StartedAt": "string",
"State": "string",
"VersionLabel": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 202 response.
The following data is returned in JSON format by the service.
- ApplicationId
-
The ID of the application that was deployed.
Type: String
Pattern:
[a-z0-9]{4,7}
- AppliedExtensions
-
A list of extensions that were processed as part of the deployment. The extensions that were previously associated to the configuration profile, environment, or the application when
StartDeployment
was called.Type: Array of AppliedExtension objects
- CompletedAt
-
The time the deployment completed.
Type: Timestamp
- ConfigurationLocationUri
-
Information about the source location of the configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- ConfigurationName
-
The name of the configuration.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
- ConfigurationProfileId
-
The ID of the configuration profile that was deployed.
Type: String
Pattern:
[a-z0-9]{4,7}
- ConfigurationVersion
-
The configuration version that was deployed.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
- DeploymentDurationInMinutes
-
Total amount of time the deployment lasted.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1440.
- DeploymentNumber
-
The sequence number of the deployment.
Type: Integer
- DeploymentStrategyId
-
The ID of the deployment strategy that was deployed.
Type: String
Pattern:
[a-z0-9]{4,7}
- Description
-
The description of the deployment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 1024.
- EnvironmentId
-
The ID of the environment that was deployed.
Type: String
Pattern:
[a-z0-9]{4,7}
- EventLog
-
A list containing all events related to a deployment. The most recent events are displayed first.
Type: Array of DeploymentEvent objects
- FinalBakeTimeInMinutes
-
The amount of time that Amazon AppConfig monitored for alarms before considering the deployment to be complete and no longer eligible for automatic rollback.
Type: Integer
Valid Range: Minimum value of 0. Maximum value of 1440.
- GrowthFactor
-
The percentage of targets to receive a deployed configuration during each interval.
Type: Float
Valid Range: Minimum value of 1.0. Maximum value of 100.0.
- GrowthType
-
The algorithm used to define how percentage grew over time.
Type: String
Valid Values:
LINEAR | EXPONENTIAL
- KmsKeyArn
-
The Amazon Resource Name of the Amazon Key Management Service key used to encrypt configuration data. You can encrypt secrets stored in Amazon Secrets Manager, Amazon Simple Storage Service (Amazon S3) objects encrypted with SSE-KMS, or secure string parameters stored in Amazon Systems Manager Parameter Store.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
arn:(aws[a-zA-Z-]*)?:[a-z]+:([a-z]{2}((-gov)|(-iso([a-z]?)))?-[a-z]+-\d{1})?:(\d{12})?:[a-zA-Z0-9-_/:.]+
- KmsKeyIdentifier
-
The Amazon Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 2048.
- PercentageComplete
-
The percentage of targets for which the deployment is available.
Type: Float
Valid Range: Minimum value of 1.0. Maximum value of 100.0.
- StartedAt
-
The time the deployment started.
Type: Timestamp
- State
-
The state of the deployment.
Type: String
Valid Values:
BAKING | VALIDATING | DEPLOYING | COMPLETE | ROLLING_BACK | ROLLED_BACK | REVERTED
- VersionLabel
-
A user-defined label for an Amazon AppConfig hosted configuration version.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
.*[^0-9].*
Errors
For information about the errors that are common to all actions, see Common Errors.
- BadRequestException
-
The input fails to satisfy the constraints specified by an Amazon service.
HTTP Status Code: 400
- InternalServerException
-
There was an internal failure in the Amazon AppConfig service.
HTTP Status Code: 500
- ResourceNotFoundException
-
The requested resource could not be found.
HTTP Status Code: 404
Examples
Example
This example illustrates one usage of StopDeployment.
Sample Request
DELETE /applications/abc1234/environments/54j1r29/deployments/2 HTTP/1.1
Host: appconfig.us-east-1.amazonaws.com
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.stop-deployment
X-Amz-Date: 20210920T210612Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20210920/us-east-1/appconfig/aws4_request, SignedHeaders=host;x-amz-date, Signature=39c3b3042cd2aEXAMPLE
Content-Length: 0
Sample Response
{
"DeploymentNumber": 0,
"DeploymentDurationInMinutes": 0,
"GrowthFactor": 0.0,
"FinalBakeTimeInMinutes": 0,
"PercentageComplete": 0.0
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: