Menu
AWS CodeBuild
API Reference (API Version 2016-10-06)

BatchGetProjects

Gets information about build projects.

Request Syntax

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

Note

In the following list, the required parameters are described first.

names

The names of the build projects.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1.

Required: Yes

Response Syntax

{ "projects": [ { "arn": "string", "artifacts": { "location": "string", "name": "string", "namespaceType": "string", "packaging": "string", "path": "string", "type": "string" }, "badge": { "badgeEnabled": boolean, "badgeRequestUrl": "string" }, "cache": { "location": "string", "type": "string" }, "created": number, "description": "string", "encryptionKey": "string", "environment": { "computeType": "string", "environmentVariables": [ { "name": "string", "type": "string", "value": "string" } ], "image": "string", "privilegedMode": boolean, "type": "string" }, "lastModified": number, "name": "string", "serviceRole": "string", "source": { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "location": "string", "type": "string" }, "tags": [ { "key": "string", "value": "string" } ], "timeoutInMinutes": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnets": [ "string" ], "vpcId": "string" }, "webhook": { "url": "string" } } ], "projectsNotFound": [ "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.

projects

Information about the requested build projects.

Type: Array of Project objects

projectsNotFound

The names of build projects for which information could not be found.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1.

Errors

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

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

See Also

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