Stops a deployment. This API action works only on deployments that have a status of
- * DEPLOYING. This action moves the deployment to a status of
- * ROLLED_BACK.
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. AppConfig only allows a revert within 72 hours of
+ * deployment completion.
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
@@ -41,6 +44,7 @@ export interface StopDeploymentCommandOutput extends Deployment, __MetadataBeare
* ApplicationId: "STRING_VALUE", // required
* EnvironmentId: "STRING_VALUE", // required
* DeploymentNumber: Number("int"), // required
+ * AllowRevert: true || false,
* };
* const command = new StopDeploymentCommand(input);
* const response = await client.send(command);
@@ -58,10 +62,10 @@ export interface StopDeploymentCommandOutput extends Deployment, __MetadataBeare
* // GrowthType: "LINEAR" || "EXPONENTIAL",
* // GrowthFactor: Number("float"),
* // FinalBakeTimeInMinutes: Number("int"),
- * // State: "BAKING" || "VALIDATING" || "DEPLOYING" || "COMPLETE" || "ROLLING_BACK" || "ROLLED_BACK",
+ * // State: "BAKING" || "VALIDATING" || "DEPLOYING" || "COMPLETE" || "ROLLING_BACK" || "ROLLED_BACK" || "REVERTED",
* // EventLog: [ // DeploymentEvents
* // { // DeploymentEvent
- * // EventType: "PERCENTAGE_UPDATED" || "ROLLBACK_STARTED" || "ROLLBACK_COMPLETED" || "BAKE_TIME_STARTED" || "DEPLOYMENT_STARTED" || "DEPLOYMENT_COMPLETED",
+ * // EventType: "PERCENTAGE_UPDATED" || "ROLLBACK_STARTED" || "ROLLBACK_COMPLETED" || "BAKE_TIME_STARTED" || "DEPLOYMENT_STARTED" || "DEPLOYMENT_COMPLETED" || "REVERT_COMPLETED",
* // TriggeredBy: "USER" || "APPCONFIG" || "CLOUDWATCH_ALARM" || "INTERNAL_ERROR",
* // Description: "STRING_VALUE",
* // ActionInvocations: [ // ActionInvocations
diff --git a/clients/client-appconfig/src/commands/UpdateEnvironmentCommand.ts b/clients/client-appconfig/src/commands/UpdateEnvironmentCommand.ts
index ba3096bfe8b0..c6cf8d057e2e 100644
--- a/clients/client-appconfig/src/commands/UpdateEnvironmentCommand.ts
+++ b/clients/client-appconfig/src/commands/UpdateEnvironmentCommand.ts
@@ -54,7 +54,7 @@ export interface UpdateEnvironmentCommandOutput extends Environment, __MetadataB
* // Id: "STRING_VALUE",
* // Name: "STRING_VALUE",
* // Description: "STRING_VALUE",
- * // State: "READY_FOR_DEPLOYMENT" || "DEPLOYING" || "ROLLING_BACK" || "ROLLED_BACK",
+ * // State: "READY_FOR_DEPLOYMENT" || "DEPLOYING" || "ROLLING_BACK" || "ROLLED_BACK" || "REVERTED",
* // Monitors: [ // MonitorList
* // { // Monitor
* // AlarmArn: "STRING_VALUE", // required
diff --git a/clients/client-appconfig/src/models/models_0.ts b/clients/client-appconfig/src/models/models_0.ts
index da520786109d..e898acf907ef 100644
--- a/clients/client-appconfig/src/models/models_0.ts
+++ b/clients/client-appconfig/src/models/models_0.ts
@@ -914,6 +914,7 @@ export interface CreateEnvironmentRequest {
export const EnvironmentState = {
DEPLOYING: "DEPLOYING",
READY_FOR_DEPLOYMENT: "READY_FOR_DEPLOYMENT",
+ REVERTED: "REVERTED",
ROLLED_BACK: "ROLLED_BACK",
ROLLING_BACK: "ROLLING_BACK",
} as const;
@@ -1626,8 +1627,9 @@ export interface GetConfigurationRequest {
* ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved
* for subsequent calls to GetConfiguration.
*
- * For more information about working with configurations, see Retrieving the - * Configuration in the AppConfig User Guide.
+ *For more information about working with configurations, see Retrieving feature flags and + * configuration data in AppConfig in the AppConfig + * User Guide.
* @public */ ClientConfigurationVersion?: string; @@ -1690,6 +1692,7 @@ export const DeploymentEventType = { DEPLOYMENT_COMPLETED: "DEPLOYMENT_COMPLETED", DEPLOYMENT_STARTED: "DEPLOYMENT_STARTED", PERCENTAGE_UPDATED: "PERCENTAGE_UPDATED", + REVERT_COMPLETED: "REVERT_COMPLETED", ROLLBACK_COMPLETED: "ROLLBACK_COMPLETED", ROLLBACK_STARTED: "ROLLBACK_STARTED", } as const; @@ -1775,6 +1778,7 @@ export const DeploymentState = { BAKING: "BAKING", COMPLETE: "COMPLETE", DEPLOYING: "DEPLOYING", + REVERTED: "REVERTED", ROLLED_BACK: "ROLLED_BACK", ROLLING_BACK: "ROLLING_BACK", VALIDATING: "VALIDATING", @@ -2764,6 +2768,14 @@ export interface StopDeploymentRequest { * @public */ DeploymentNumber: number | undefined; + + /** + *A Boolean that enables AppConfig to rollback a COMPLETED
+ * deployment to the previous configuration version. This action moves the deployment to a
+ * status of REVERTED.
The configuration version returned in the most recent GetConfiguration\n response.
\nAppConfig uses the value of the ClientConfigurationVersion\n parameter to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are\n charged each time your clients receive a configuration.
To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on\n your behalf. If you choose to continue using GetConfiguration, we\n recommend that you include the ClientConfigurationVersion value with every\n call to GetConfiguration. The value to use for\n ClientConfigurationVersion comes from the\n ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved\n for subsequent calls to GetConfiguration.
For more information about working with configurations, see Retrieving the\n Configuration in the AppConfig User Guide.
", + "smithy.api#documentation": "The configuration version returned in the most recent GetConfiguration\n response.
\nAppConfig uses the value of the ClientConfigurationVersion\n parameter to identify the configuration version on your clients. If you don’t send\n ClientConfigurationVersion with each call to GetConfiguration, your clients receive the current configuration. You are\n charged each time your clients receive a configuration.
To avoid excess charges, we recommend you use the StartConfigurationSession and GetLatestConfiguration APIs, which track the client configuration version on\n your behalf. If you choose to continue using GetConfiguration, we\n recommend that you include the ClientConfigurationVersion value with every\n call to GetConfiguration. The value to use for\n ClientConfigurationVersion comes from the\n ConfigurationVersion attribute returned by GetConfiguration when there is new or updated data, and should be saved\n for subsequent calls to GetConfiguration.
For more information about working with configurations, see Retrieving feature flags and\n configuration data in AppConfig in the AppConfig\n User Guide.
", "smithy.api#httpQuery": "client_configuration_version" } } @@ -5529,7 +5547,7 @@ } ], "traits": { - "smithy.api#documentation": "Stops a deployment. This API action works only on deployments that have a status of\n DEPLOYING. This action moves the deployment to a status of\n ROLLED_BACK.
Stops a deployment. This API action works only on deployments that have a status of\n DEPLOYING, unless an AllowRevert parameter is supplied. If the\n AllowRevert parameter is supplied, the status of an in-progress deployment\n will be ROLLED_BACK. The status of a completed deployment will be\n REVERTED. AppConfig only allows a revert within 72 hours of\n deployment completion.
A Boolean that enables AppConfig to rollback a COMPLETED\n deployment to the previous configuration version. This action moves the deployment to a\n status of REVERTED.