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

BatchGetApplications

Gets information about one or more applications.

Request Syntax

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

applicationNames

A list of application names separated by spaces.

Type: Array of strings

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

Required: Yes

Response Syntax

{
   "applicationsInfo": [ 
      { 
         "applicationId": "string",
         "applicationName": "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.

applicationsInfo

Information about the applications.

Type: Array of ApplicationInfo objects

Errors

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

ApplicationDoesNotExistException

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

HTTP Status Code: 400

ApplicationNameRequiredException

The minimum number of required application names was not specified.

HTTP Status Code: 400

BatchLimitExceededException

The maximum number of names or IDs allowed for this request (100) was exceeded.

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: 81
X-Amz-Target: CodeDeploy_20141006.BatchGetApplications
X-Amz-Date: 20160707T230945Z
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

{
    "applicationNames": [
        "ProductionApp-us-east-1",
        "ProductionApp-us-west-2"
    ]
}

Sample Response

HTTP/1.1 200 OK
x-amzn-RequestId: 4ccc9cf0-88c9-11e5-8ce3-2704437d0309
Content-Type: application/x-amz-json-1.1
Content-Length: 335

{
    "applicationsInfo": [
        {
            "applicationId": "d8347436-bc51-459e-9c44-f98abEXAMPLE",
            "applicationName": "ProductionApp-us-west-2",
            "createTime": 1446136767.311,
            "linkedToGitHub": false
        },
        {
            "applicationId": "1ecfe802-63f1-4038-8f0d-06688EXAMPLE",
            "applicationName": "ProductionApp-us-east-1",
            "createTime": 1439488406.152,
            "linkedToGitHub": false
        }
    ]
}

See Also

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