BatchGetProjects
Gets information about one or more 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 or ARNs of the build projects. To get information about a project shared with your AWS account, its ARN must be specified. You cannot specify a shared project using its name.
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": {
"artifactIdentifier": "string",
"bucketOwnerAccess": "string",
"encryptionDisabled": boolean,
"location": "string",
"name": "string",
"namespaceType": "string",
"overrideArtifactName": boolean,
"packaging": "string",
"path": "string",
"type": "string"
},
"badge": {
"badgeEnabled": boolean,
"badgeRequestUrl": "string"
},
"buildBatchConfig": {
"batchReportMode": "string",
"combineArtifacts": boolean,
"restrictions": {
"computeTypesAllowed": [ "string" ],
"maximumBuildsAllowed": number
},
"serviceRole": "string",
"timeoutInMins": number
},
"cache": {
"location": "string",
"modes": [ "string" ],
"type": "string"
},
"concurrentBuildLimit": number,
"created": number,
"description": "string",
"encryptionKey": "string",
"environment": {
"certificate": "string",
"computeType": "string",
"environmentVariables": [
{
"name": "string",
"type": "string",
"value": "string"
}
],
"fleet": {
"fleetArn": "string"
},
"image": "string",
"imagePullCredentialsType": "string",
"privilegedMode": boolean,
"registryCredential": {
"credential": "string",
"credentialProvider": "string"
},
"type": "string"
},
"fileSystemLocations": [
{
"identifier": "string",
"location": "string",
"mountOptions": "string",
"mountPoint": "string",
"type": "string"
}
],
"lastModified": number,
"logsConfig": {
"cloudWatchLogs": {
"groupName": "string",
"status": "string",
"streamName": "string"
},
"s3Logs": {
"bucketOwnerAccess": "string",
"encryptionDisabled": boolean,
"location": "string",
"status": "string"
}
},
"name": "string",
"projectVisibility": "string",
"publicProjectAlias": "string",
"queuedTimeoutInMinutes": number,
"resourceAccessRole": "string",
"secondaryArtifacts": [
{
"artifactIdentifier": "string",
"bucketOwnerAccess": "string",
"encryptionDisabled": boolean,
"location": "string",
"name": "string",
"namespaceType": "string",
"overrideArtifactName": boolean,
"packaging": "string",
"path": "string",
"type": "string"
}
],
"secondarySources": [
{
"auth": {
"resource": "string",
"type": "string"
},
"buildspec": "string",
"buildStatusConfig": {
"context": "string",
"targetUrl": "string"
},
"gitCloneDepth": number,
"gitSubmodulesConfig": {
"fetchSubmodules": boolean
},
"insecureSsl": boolean,
"location": "string",
"reportBuildStatus": boolean,
"sourceIdentifier": "string",
"type": "string"
}
],
"secondarySourceVersions": [
{
"sourceIdentifier": "string",
"sourceVersion": "string"
}
],
"serviceRole": "string",
"source": {
"auth": {
"resource": "string",
"type": "string"
},
"buildspec": "string",
"buildStatusConfig": {
"context": "string",
"targetUrl": "string"
},
"gitCloneDepth": number,
"gitSubmodulesConfig": {
"fetchSubmodules": boolean
},
"insecureSsl": boolean,
"location": "string",
"reportBuildStatus": boolean,
"sourceIdentifier": "string",
"type": "string"
},
"sourceVersion": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"timeoutInMinutes": number,
"vpcConfig": {
"securityGroupIds": [ "string" ],
"subnets": [ "string" ],
"vpcId": "string"
},
"webhook": {
"branchFilter": "string",
"buildType": "string",
"filterGroups": [
[
{
"excludeMatchedPattern": boolean,
"pattern": "string",
"type": "string"
}
]
],
"lastModifiedSecret": number,
"payloadUrl": "string",
"secret": "string",
"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:
