GetDeploymentStrategy - AWS AppConfig

GetDeploymentStrategy

Retrieve information about a deployment strategy. A deployment strategy defines important criteria for rolling out your configuration to the designated targets. A deployment strategy includes: the overall duration required, a percentage of targets to receive the deployment during each interval, an algorithm that defines how percentage grows, and bake time.

Request Syntax

GET /deploymentstrategies/DeploymentStrategyId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

DeploymentStrategyId

The ID of the deployment strategy to get.

Pattern: (^[a-z0-9]{4,7}$|^AppConfig\.[A-Za-z0-9]{9,40}$)

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "DeploymentDurationInMinutes": number, "Description": "string", "FinalBakeTimeInMinutes": number, "GrowthFactor": number, "GrowthType": "string", "Id": "string", "Name": "string", "ReplicateTo": "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.

DeploymentDurationInMinutes

Total amount of time the deployment lasted.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1440.

Description

The description of the deployment strategy.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

FinalBakeTimeInMinutes

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

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 1440.

GrowthFactor

The percentage of targets that received 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

Id

The deployment strategy ID.

Type: String

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

Name

The name of the deployment strategy.

Type: String

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

ReplicateTo

Save the deployment strategy to a Systems Manager (SSM) document.

Type: String

Valid Values: NONE | SSM_DOCUMENT

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 AWS service.

HTTP Status Code: 400

InternalServerException

There was an internal failure in the AppConfig service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

See Also

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