Sign In to the Console
AWS CodeDeploy
API Reference (API Version 2014-10-06)

AWS Documentation » AWS CodeDeploy » API Reference » Actions » GetApplication

GetApplication

Gets information about an application.

Request Syntax

{
   "applicationName": "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.

applicationName

The name of an AWS CodeDeploy application associated with the IAM user or AWS account.

Type: String

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

Required: Yes

Response Syntax

{
   "application": { 
      "applicationId": "string",
      "applicationName": "string",
      "computePlatform": "string",
      "createTime": number,
      "gitHubAccountName": "string",
      "linkedToGitHub": boolean
   }
}

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.

application

Information about the application.

Type: ApplicationInfo object

Errors

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

ApplicationDoesNotExistException

The application does not exist with the IAM user or AWS account.

HTTP Status Code: 400

ApplicationNameRequiredException

The minimum number of required application names was not specified.

HTTP Status Code: 400

InvalidApplicationNameException

The application name was specified in an invalid format.

HTTP Status Code: 400

Example

Sample Request

POST / HTTP/1.1
Host: codedeploy.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 45
X-Amz-Target: CodeDeploy_20141006.GetApplication
X-Amz-Date: 20160707T014559Z
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

{
    "applicationName": "TestApp-us-east-1"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 2010bbbd-88df-11e5-9749-bba241db97da
Content-Type: application/x-amz-json-1.1
Content-Length: 168

{
    "application": {
        "applicationId": "d3be67e5-e7l6-457b-946b-7a457EXAMPLE",
        "applicationName": "TestApp-us-east-1",
        "createTime": 1446229001.211,
        "linkedToGitHub": false
    }
}

See Also

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