AWS CodeDeploy
API Reference (API Version 2014-10-06)


Gets information about a deployment configuration.

Request Syntax

{ "deploymentConfigName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.


The name of a deployment configuration associated with the applicable IAM user or AWS account.

Type: String

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

Required: Yes

Response Syntax

{ "deploymentConfigInfo": { "computePlatform": "string", "createTime": number, "deploymentConfigId": "string", "deploymentConfigName": "string", "minimumHealthyHosts": { "type": "string", "value": number }, "trafficRoutingConfig": { "timeBasedCanary": { "canaryInterval": number, "canaryPercentage": number }, "timeBasedLinear": { "linearInterval": number, "linearPercentage": number }, "type": "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.


Information about the deployment configuration.

Type: DeploymentConfigInfo object


For information about the errors that are common to all actions, see Common Errors.


The deployment configuration does not exist with the applicable IAM user or AWS account.

HTTP Status Code: 400


The deployment configuration name was not specified.

HTTP Status Code: 400


The deployment configuration name was specified in an invalid format.

HTTP Status Code: 400


Sample Request

POST / HTTP/1.1 Host: Accept-Encoding: identity Content-Length: 56 X-Amz-Target: CodeDeploy_20141006.GetDeploymentConfig X-Amz-Date: 20160707T015738Z User-Agent: aws-cli/1.10.6 Python/2.7.9 Windows/7 botocore/1.3.28 Content-Type: application/x-amz-json-1.1 Authorization: AWS4-HMAC-SHA256 Credential=AKIAIOSFODNN7EXAMPLE/20160707/us-east-1/codedeploy/aws4_request, SignedHeaders=content-type;host;user-agent;x-amz-date;x-amz-target, Signature=39c3b3042cd2aEXAMPLE { "deploymentConfigName": "CodeDeployDefault.OneAtATime" }

Sample Response

HTTP/1.1 200 OK x-amzn-RequestId: c177704f-88e0-11e5-b497-75c493756c4d Content-Type: application/x-amz-json-1.1 Content-Length: 200 { "deploymentConfigInfo": { "createTime": 1446744188.711, "deploymentConfigId": "00000000-0000-0000-0000-000000000001", "deploymentConfigName": "CodeDeployDefault.OneAtATime", "minimumHealthyHosts": { "type": "MOST_CONCURRENCY", "value": 1 } } }

See Also

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