AWS SDK for PHP 3.x (original) (raw)

The input value that was provided is not valid.

BatchGetBuildBatches

result=result = result=client->batchGetBuildBatches([/* ... /]); promise=promise = promise=client->batchGetBuildBatchesAsync([/ ... */]);

Retrieves information about one or more batch builds.

Parameter Syntax

result=result = result=client->batchGetBuildBatches([ 'ids' => ['', ...], // REQUIRED ]);

Parameter Details

Members

ids

Required: Yes

Type: Array of strings

An array that contains the batch build identifiers to retrieve.

Result Syntax

[ 'buildBatches' => [ [ 'arn' => '', 'artifacts' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], 'buildBatchConfig' => [ 'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH', 'combineArtifacts' => true || false, 'restrictions' => [ 'computeTypesAllowed' => ['', ...], 'fleetsAllowed' => ['', ...], 'maximumBuildsAllowed' => , ], 'serviceRole' => '', 'timeoutInMins' => , ], 'buildBatchNumber' => , 'buildBatchStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'buildGroups' => [ [ 'currentBuildSummary' => [ 'arn' => '', 'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'primaryArtifact' => [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], 'requestedOn' => , 'secondaryArtifacts' => [ [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], // ... ], ], 'dependsOn' => ['', ...], 'identifier' => '', 'ignoreFailure' => true || false, 'priorBuildSummaryList' => [ [ 'arn' => '', 'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'primaryArtifact' => [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], 'requestedOn' => , 'secondaryArtifacts' => [ [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], // ... ], ], // ... ], ], // ... ], 'buildTimeoutInMinutes' => , 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', ], 'complete' => true || false, 'currentPhase' => '', 'debugSessionEnabled' => true || false, 'encryptionKey' => '', 'endTime' => , 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'id' => '', 'initiator' => '', 'logConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], ], 'phases' => [ [ 'contexts' => [ [ 'message' => '', 'statusCode' => '', ], // ... ], 'durationInSeconds' => , 'endTime' => , 'phaseStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'phaseType' => 'SUBMITTED|DOWNLOAD_BATCHSPEC|IN_PROGRESS|COMBINE_ARTIFACTS|SUCCEEDED|FAILED|STOPPED', 'startTime' => , ], // ... ], 'projectName' => '', 'queuedTimeoutInMinutes' => , 'reportArns' => ['', ...], 'resolvedSourceVersion' => '', 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'startTime' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ], // ... ], 'buildBatchesNotFound' => ['', ...], ]

Result Details

Members

buildBatches

Type: Array of BuildBatch structures

An array of BuildBatch objects that represent the retrieved batch builds.

buildBatchesNotFound

An array that contains the identifiers of any batch builds that are not found.

Errors

The input value that was provided is not valid.

BatchGetBuilds

result=result = result=client->batchGetBuilds([/* ... /]); promise=promise = promise=client->batchGetBuildsAsync([/ ... */]);

Gets information about one or more builds.

Parameter Syntax

result=result = result=client->batchGetBuilds([ 'ids' => ['', ...], // REQUIRED ]);

Parameter Details

Members

ids

Required: Yes

Type: Array of strings

The IDs of the builds.

Result Syntax

[ 'builds' => [ [ 'arn' => '', 'artifacts' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], 'autoRetryConfig' => [ 'autoRetryLimit' => , 'autoRetryNumber' => , 'nextAutoRetry' => '', 'previousAutoRetry' => '', ], 'buildBatchArn' => '', 'buildComplete' => true || false, 'buildNumber' => , 'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', ], 'currentPhase' => '', 'debugSession' => [ 'sessionEnabled' => true || false, 'sessionTarget' => '', ], 'encryptionKey' => '', 'endTime' => , 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'exportedEnvironmentVariables' => [ [ 'name' => '', 'value' => '', ], // ... ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'id' => '', 'initiator' => '', 'logs' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 'cloudWatchLogsArn' => '', 'deepLink' => '', 'groupName' => '', 's3DeepLink' => '', 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], 's3LogsArn' => '', 'streamName' => '', ], 'networkInterface' => [ 'networkInterfaceId' => '', 'subnetId' => '', ], 'phases' => [ [ 'contexts' => [ [ 'message' => '', 'statusCode' => '', ], // ... ], 'durationInSeconds' => , 'endTime' => , 'phaseStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'phaseType' => 'SUBMITTED|QUEUED|PROVISIONING|DOWNLOAD_SOURCE|INSTALL|PRE_BUILD|BUILD|POST_BUILD|UPLOAD_ARTIFACTS|FINALIZING|COMPLETED', 'startTime' => , ], // ... ], 'projectName' => '', 'queuedTimeoutInMinutes' => , 'reportArns' => ['', ...], 'resolvedSourceVersion' => '', 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'startTime' => , 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ], // ... ], 'buildsNotFound' => ['', ...], ]

Result Details

Members

builds

Type: Array of Build structures

Information about the requested builds.

buildsNotFound

The IDs of builds for which information could not be found.

Errors

The input value that was provided is not valid.

BatchGetCommandExecutions

result=result = result=client->batchGetCommandExecutions([/* ... /]); promise=promise = promise=client->batchGetCommandExecutionsAsync([/ ... */]);

Gets information about the command executions.

Parameter Syntax

result=result = result=client->batchGetCommandExecutions([ 'commandExecutionIds' => ['', ...], // REQUIRED 'sandboxId' => '', // REQUIRED ]);

Parameter Details

Members

commandExecutionIds

Required: Yes

Type: Array of strings

A comma separated list of commandExecutionIds.

sandboxId

Required: Yes

Type: string

A sandboxId or sandboxArn.

Result Syntax

[ 'commandExecutions' => [ [ 'command' => '', 'endTime' => , 'exitCode' => '', 'id' => '', 'logs' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 'cloudWatchLogsArn' => '', 'deepLink' => '', 'groupName' => '', 's3DeepLink' => '', 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], 's3LogsArn' => '', 'streamName' => '', ], 'sandboxArn' => '', 'sandboxId' => '', 'standardErrContent' => '', 'standardOutputContent' => '', 'startTime' => , 'status' => '', 'submitTime' => , 'type' => 'SHELL', ], // ... ], 'commandExecutionsNotFound' => ['', ...], ]

Result Details

Members

commandExecutions

Type: Array of CommandExecution structures

Information about the requested command executions.

commandExecutionsNotFound

The IDs of command executions for which information could not be found.

Errors

The input value that was provided is not valid.

BatchGetFleets

result=result = result=client->batchGetFleets([/* ... /]); promise=promise = promise=client->batchGetFleetsAsync([/ ... */]);

Gets information about one or more compute fleets.

Parameter Syntax

result=result = result=client->batchGetFleets([ 'names' => ['', ...], // REQUIRED ]);

Parameter Details

Members

names

Required: Yes

Type: Array of strings

The names or ARNs of the compute fleets.

Result Syntax

[ 'fleets' => [ [ 'arn' => '', 'baseCapacity' => , 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'created' => , 'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', 'fleetServiceRole' => '', 'id' => '', 'imageId' => '', 'lastModified' => , 'name' => '', 'overflowBehavior' => 'QUEUE|ON_DEMAND', 'proxyConfiguration' => [ 'defaultBehavior' => 'ALLOW_ALL|DENY_ALL', 'orderedProxyRules' => [ [ 'effect' => 'ALLOW|DENY', 'entities' => ['', ...], 'type' => 'DOMAIN|IP', ], // ... ], ], 'scalingConfiguration' => [ 'desiredCapacity' => , 'maxCapacity' => , 'scalingType' => 'TARGET_TRACKING_SCALING', 'targetTrackingScalingConfigs' => [ [ 'metricType' => 'FLEET_UTILIZATION_RATE', 'targetValue' => , ], // ... ], ], 'status' => [ 'context' => 'CREATE_FAILED|UPDATE_FAILED|ACTION_REQUIRED|PENDING_DELETION|INSUFFICIENT_CAPACITY', 'message' => '', 'statusCode' => 'CREATING|UPDATING|ROTATING|PENDING_DELETION|DELETING|CREATE_FAILED|UPDATE_ROLLBACK_FAILED|ACTIVE', ], 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ], // ... ], 'fleetsNotFound' => ['', ...], ]

Result Details

Members

fleets

Type: Array of Fleet structures

Information about the requested compute fleets.

fleetsNotFound

The names of compute fleets for which information could not be found.

Errors

The input value that was provided is not valid.

BatchGetProjects

result=result = result=client->batchGetProjects([/* ... /]); promise=promise = promise=client->batchGetProjectsAsync([/ ... */]);

Gets information about one or more build projects.

Parameter Syntax

result=result = result=client->batchGetProjects([ 'names' => ['', ...], // REQUIRED ]);

Parameter Details

Members

names

Required: Yes

Type: Array of strings

The names or ARNs of the build projects. To get information about a project shared with your Amazon Web Services account, its ARN must be specified. You cannot specify a shared project using its name.

Result Syntax

[ 'projects' => [ [ 'arn' => '', 'artifacts' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], 'autoRetryLimit' => , 'badge' => [ 'badgeEnabled' => true || false, 'badgeRequestUrl' => '', ], 'buildBatchConfig' => [ 'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH', 'combineArtifacts' => true || false, 'restrictions' => [ 'computeTypesAllowed' => ['', ...], 'fleetsAllowed' => ['', ...], 'maximumBuildsAllowed' => , ], 'serviceRole' => '', 'timeoutInMins' => , ], 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', ], 'concurrentBuildLimit' => , 'created' => , 'description' => '', 'encryptionKey' => '', 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'lastModified' => , 'logsConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], ], 'name' => '', 'projectVisibility' => 'PUBLIC_READ|PRIVATE', 'publicProjectAlias' => '', 'queuedTimeoutInMinutes' => , 'resourceAccessRole' => '', 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], 'webhook' => [ 'branchFilter' => '', 'buildType' => 'BUILD|BUILD_BATCH|RUNNER_BUILDKITE_BUILD', 'filterGroups' => [ [ [ 'excludeMatchedPattern' => true || false, 'pattern' => '', 'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME|ORGANIZATION_NAME', ], // ... ], // ... ], 'lastModifiedSecret' => , 'manualCreation' => true || false, 'payloadUrl' => '', 'scopeConfiguration' => [ 'domain' => '', 'name' => '', 'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP', ], 'secret' => '', 'status' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING', 'statusMessage' => '', 'url' => '', ], ], // ... ], 'projectsNotFound' => ['', ...], ]

Result Details

Members

projects

Type: Array of Project structures

Information about the requested build projects.

projectsNotFound

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

Errors

The input value that was provided is not valid.

BatchGetReportGroups

result=result = result=client->batchGetReportGroups([/* ... /]); promise=promise = promise=client->batchGetReportGroupsAsync([/ ... */]);

Returns an array of report groups.

Parameter Syntax

result=result = result=client->batchGetReportGroups([ 'reportGroupArns' => ['', ...], // REQUIRED ]);

Parameter Details

Members

reportGroupArns

Required: Yes

Type: Array of strings

An array of report group ARNs that identify the report groups to return.

Result Syntax

[ 'reportGroups' => [ [ 'arn' => '', 'created' => , 'exportConfig' => [ 'exportConfigType' => 'S3|NO_EXPORT', 's3Destination' => [ 'bucket' => '', 'bucketOwner' => '', 'encryptionDisabled' => true || false, 'encryptionKey' => '', 'packaging' => 'ZIP|NONE', 'path' => '', ], ], 'lastModified' => , 'name' => '', 'status' => 'ACTIVE|DELETING', 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'type' => 'TEST|CODE_COVERAGE', ], // ... ], 'reportGroupsNotFound' => ['', ...], ]

Result Details

Members

reportGroups

Type: Array of ReportGroup structures

The array of report groups returned by BatchGetReportGroups.

reportGroupsNotFound

An array of ARNs passed to BatchGetReportGroups that are not associated with a ReportGroup.

Errors

The input value that was provided is not valid.

BatchGetReports

result=result = result=client->batchGetReports([/* ... /]); promise=promise = promise=client->batchGetReportsAsync([/ ... */]);

Returns an array of reports.

Parameter Syntax

result=result = result=client->batchGetReports([ 'reportArns' => ['', ...], // REQUIRED ]);

Parameter Details

Members

reportArns

Required: Yes

Type: Array of strings

An array of ARNs that identify the Report objects to return.

Result Syntax

[ 'reports' => [ [ 'arn' => '', 'codeCoverageSummary' => [ 'branchCoveragePercentage' => , 'branchesCovered' => , 'branchesMissed' => , 'lineCoveragePercentage' => , 'linesCovered' => , 'linesMissed' => , ], 'created' => , 'executionId' => '', 'expired' => , 'exportConfig' => [ 'exportConfigType' => 'S3|NO_EXPORT', 's3Destination' => [ 'bucket' => '', 'bucketOwner' => '', 'encryptionDisabled' => true || false, 'encryptionKey' => '', 'packaging' => 'ZIP|NONE', 'path' => '', ], ], 'name' => '', 'reportGroupArn' => '', 'status' => 'GENERATING|SUCCEEDED|FAILED|INCOMPLETE|DELETING', 'testSummary' => [ 'durationInNanoSeconds' => , 'statusCounts' => [, ...], 'total' => , ], 'truncated' => true || false, 'type' => 'TEST|CODE_COVERAGE', ], // ... ], 'reportsNotFound' => ['', ...], ]

Result Details

Members

reports

Type: Array of Report structures

The array of Report objects returned by BatchGetReports.

reportsNotFound

An array of ARNs passed to BatchGetReportGroups that are not associated with a Report.

Errors

The input value that was provided is not valid.

BatchGetSandboxes

result=result = result=client->batchGetSandboxes([/* ... /]); promise=promise = promise=client->batchGetSandboxesAsync([/ ... */]);

Gets information about the sandbox status.

Parameter Syntax

result=result = result=client->batchGetSandboxes([ 'ids' => ['', ...], // REQUIRED ]);

Parameter Details

Members

ids

Required: Yes

Type: Array of strings

A comma separated list of sandboxIds or sandboxArns.

Result Syntax

[ 'sandboxes' => [ [ 'arn' => '', 'currentSession' => [ 'currentPhase' => '', 'endTime' => , 'id' => '', 'logs' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 'cloudWatchLogsArn' => '', 'deepLink' => '', 'groupName' => '', 's3DeepLink' => '', 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], 's3LogsArn' => '', 'streamName' => '', ], 'networkInterface' => [ 'networkInterfaceId' => '', 'subnetId' => '', ], 'phases' => [ [ 'contexts' => [ [ 'message' => '', 'statusCode' => '', ], // ... ], 'durationInSeconds' => , 'endTime' => , 'phaseStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'phaseType' => '', 'startTime' => , ], // ... ], 'resolvedSourceVersion' => '', 'startTime' => , 'status' => '', ], 'encryptionKey' => '', 'endTime' => , 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'id' => '', 'logConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], ], 'projectName' => '', 'queuedTimeoutInMinutes' => , 'requestTime' => , 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'startTime' => , 'status' => '', 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ], // ... ], 'sandboxesNotFound' => ['', ...], ]

Result Details

Members

sandboxes

Type: Array of Sandbox structures

Information about the requested sandboxes.

sandboxesNotFound

The IDs of sandboxes for which information could not be found.

Errors

The input value that was provided is not valid.

CreateFleet

result=result = result=client->createFleet([/* ... /]); promise=promise = promise=client->createFleetAsync([/ ... */]);

Creates a compute fleet.

Parameter Syntax

result=result = result=client->createFleet([ 'baseCapacity' => , // REQUIRED 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', // REQUIRED 'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', // REQUIRED 'fleetServiceRole' => '', 'imageId' => '', 'name' => '', // REQUIRED 'overflowBehavior' => 'QUEUE|ON_DEMAND', 'proxyConfiguration' => [ 'defaultBehavior' => 'ALLOW_ALL|DENY_ALL', 'orderedProxyRules' => [ [ 'effect' => 'ALLOW|DENY', // REQUIRED 'entities' => ['', ...], // REQUIRED 'type' => 'DOMAIN|IP', // REQUIRED ], // ... ], ], 'scalingConfiguration' => [ 'maxCapacity' => , 'scalingType' => 'TARGET_TRACKING_SCALING', 'targetTrackingScalingConfigs' => [ [ 'metricType' => 'FLEET_UTILIZATION_RATE', 'targetValue' => , ], // ... ], ], 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ]);

Parameter Details

Members

baseCapacity

The initial number of machines allocated to the ﬂeet, which deﬁnes the number of builds that can run in parallel.

computeConfiguration

Type: ComputeConfiguration structure

The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.

computeType

Required: Yes

Type: string

Information about the compute resources the compute fleet uses. Available values include:

ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the CodeBuild User Guide.

environmentType

Required: Yes

Type: string

The environment type of the compute fleet.

The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type ARM_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type MAC_ARM is available for Medium fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), and EU (Frankfurt)
The environment type MAC_ARM is available for Large fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and Asia Pacific (Sydney).
The environment type WINDOWS_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see Build environment compute types in the CodeBuild user guide.

fleetServiceRole

imageId

The Amazon Machine Image (AMI) of the compute fleet.

name

Required: Yes

Type: string

The name of the compute fleet.

overflowBehavior

The compute fleet overflow behavior.

For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.

proxyConfiguration

Type: ProxyConfiguration structure

The proxy configuration of the compute fleet.

scalingConfiguration

Type: ScalingConfigurationInput structure

The scaling configuration of the compute fleet.

tags

Type: Array of Tag structures

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

vpcConfig

Type: VpcConfig structure

Information about the VPC configuration that CodeBuild accesses.

Result Syntax

Result Details

Members

fleet

Information about the compute fleet

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

CreateProject

result=result = result=client->createProject([/* ... /]); promise=promise = promise=client->createProjectAsync([/ ... */]);

Creates a build project.

Parameter Syntax

result=result = result=client->createProject([ 'artifacts' => [ // REQUIRED 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], 'autoRetryLimit' => , 'badgeEnabled' => true || false, 'buildBatchConfig' => [ 'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH', 'combineArtifacts' => true || false, 'restrictions' => [ 'computeTypesAllowed' => ['', ...], 'fleetsAllowed' => ['', ...], 'maximumBuildsAllowed' => , ], 'serviceRole' => '', 'timeoutInMins' => , ], 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', // REQUIRED ], 'concurrentBuildLimit' => , 'description' => '', 'encryptionKey' => '', 'environment' => [ // REQUIRED 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', // REQUIRED 'environmentVariables' => [ [ 'name' => '', // REQUIRED 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', // REQUIRED ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', // REQUIRED 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', // REQUIRED 'credentialProvider' => 'SECRETS_MANAGER', // REQUIRED ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', // REQUIRED ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'logsConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED ], ], 'name' => '', // REQUIRED 'queuedTimeoutInMinutes' => , 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', // REQUIRED 'sourceVersion' => '', // REQUIRED ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED ], // ... ], 'serviceRole' => '', // REQUIRED 'source' => [ // REQUIRED 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED ], 'sourceVersion' => '', 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ]);

Parameter Details

Members

artifacts

Required: Yes

Type: ProjectArtifacts structure

Information about the build output artifacts for the build project.

autoRetryLimit

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

badgeEnabled

Set this to true to generate a publicly accessible URL for your project's build badge.

buildBatchConfig

Type: ProjectBuildBatchConfig structure

cache

Type: ProjectCache structure

Stores recently used information so that it can be quickly accessed at a later time.

concurrentBuildLimit

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

description

A description that makes the build project easy to identify.

encryptionKey

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

environment

Required: Yes

Type: ProjectEnvironment structure

Information about the build environment for the build project.

fileSystemLocations

Type: Array of ProjectFileSystemLocation structures

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.

logsConfig

Type: LogsConfig structure

Information about logs for the build project. These can be logs in CloudWatch Logs, logs uploaded to a specified S3 bucket, or both.

name

Required: Yes

Type: string

The name of the build project.

queuedTimeoutInMinutes

The number of minutes a build is allowed to be queued before it times out.

secondaryArtifacts

Type: Array of ProjectArtifacts structures

An array of ProjectArtifacts objects.

secondarySourceVersions

Type: Array of ProjectSourceVersion structures

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take precedence over these secondarySourceVersions (at the project level).

secondarySources

Type: Array of ProjectSource structures

An array of ProjectSource objects.

serviceRole

Required: Yes

Type: string

The ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

source

Required: Yes

Type: ProjectSource structure

Information about the build input source code for the build project.

sourceVersion

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

tags

Type: Array of Tag structures

A list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

timeoutInMinutes

How long, in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before it times out any build that has not been marked as completed. The default is 60 minutes.

vpcConfig

Type: VpcConfig structure

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

If you're using compute fleets during project creation, do not provide vpcConfig.

Result Syntax

[ 'project' => [ 'arn' => '', 'artifacts' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], 'autoRetryLimit' => , 'badge' => [ 'badgeEnabled' => true || false, 'badgeRequestUrl' => '', ], 'buildBatchConfig' => [ 'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH', 'combineArtifacts' => true || false, 'restrictions' => [ 'computeTypesAllowed' => ['', ...], 'fleetsAllowed' => ['', ...], 'maximumBuildsAllowed' => , ], 'serviceRole' => '', 'timeoutInMins' => , ], 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', ], 'concurrentBuildLimit' => , 'created' => , 'description' => '', 'encryptionKey' => '', 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'lastModified' => , 'logsConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], ], 'name' => '', 'projectVisibility' => 'PUBLIC_READ|PRIVATE', 'publicProjectAlias' => '', 'queuedTimeoutInMinutes' => , 'resourceAccessRole' => '', 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], 'webhook' => [ 'branchFilter' => '', 'buildType' => 'BUILD|BUILD_BATCH|RUNNER_BUILDKITE_BUILD', 'filterGroups' => [ [ [ 'excludeMatchedPattern' => true || false, 'pattern' => '', 'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME|ORGANIZATION_NAME', ], // ... ], // ... ], 'lastModifiedSecret' => , 'manualCreation' => true || false, 'payloadUrl' => '', 'scopeConfiguration' => [ 'domain' => '', 'name' => '', 'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP', ], 'secret' => '', 'status' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING', 'statusMessage' => '', 'url' => '', ], ], ]

Result Details

Members

project

Information about the build project that was created.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

CreateReportGroup

result=result = result=client->createReportGroup([/* ... /]); promise=promise = promise=client->createReportGroupAsync([/ ... */]);

Creates a report group. A report group contains a collection of reports.

Parameter Syntax

result=result = result=client->createReportGroup([ 'exportConfig' => [ // REQUIRED 'exportConfigType' => 'S3|NO_EXPORT', 's3Destination' => [ 'bucket' => '', 'bucketOwner' => '', 'encryptionDisabled' => true || false, 'encryptionKey' => '', 'packaging' => 'ZIP|NONE', 'path' => '', ], ], 'name' => '', // REQUIRED 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'type' => 'TEST|CODE_COVERAGE', // REQUIRED ]);

Parameter Details

Members

exportConfig

Required: Yes

Type: ReportExportConfig structure

A ReportExportConfig object that contains information about where the report group test results are exported.

name

Required: Yes

Type: string

The name of the report group.

tags

Type: Array of Tag structures

A list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

type

Required: Yes

Type: string

The type of report group.

Result Syntax

[ 'reportGroup' => [ 'arn' => '', 'created' => , 'exportConfig' => [ 'exportConfigType' => 'S3|NO_EXPORT', 's3Destination' => [ 'bucket' => '', 'bucketOwner' => '', 'encryptionDisabled' => true || false, 'encryptionKey' => '', 'packaging' => 'ZIP|NONE', 'path' => '', ], ], 'lastModified' => , 'name' => '', 'status' => 'ACTIVE|DELETING', 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'type' => 'TEST|CODE_COVERAGE', ], ]

Result Details

Members

reportGroup

Type: ReportGroup structure

Information about the report group that was created.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

CreateWebhook

result=result = result=client->createWebhook([/* ... /]); promise=promise = promise=client->createWebhookAsync([/ ... */]);

If you enable webhooks for an CodeBuild project, and the project is used as a build step in CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using CodePipeline, we recommend that you disable webhooks in CodeBuild. In the CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings.

Parameter Syntax

result=result = result=client->createWebhook([ 'branchFilter' => '', 'buildType' => 'BUILD|BUILD_BATCH|RUNNER_BUILDKITE_BUILD', 'filterGroups' => [ [ [ 'excludeMatchedPattern' => true || false, 'pattern' => '', // REQUIRED 'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME|ORGANIZATION_NAME', // REQUIRED ], // ... ], // ... ], 'manualCreation' => true || false, 'projectName' => '', // REQUIRED 'scopeConfiguration' => [ 'domain' => '', 'name' => '', // REQUIRED 'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP', // REQUIRED ], ]);

Parameter Details

Members

branchFilter

A regular expression used to determine which repository branches are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If branchFilter is empty, then all branches are built.

It is recommended that you use filterGroups instead of branchFilter.

buildType

Specifies the type of build this webhook will trigger.

RUNNER_BUILDKITE_BUILD is only available for NO_SOURCE source type projects configured for Buildkite runner builds. For more information about CodeBuild-hosted Buildkite runner builds, see Tutorial: Configure a CodeBuild-hosted Buildkite runner in the CodeBuild user guide.

filterGroups

Type: Array of WebhookFilter structuress

An array of arrays of WebhookFilter objects used to determine which webhooks are triggered. At least one WebhookFilter in the array must specify EVENT as its type.

For a build to be triggered, at least one filter group in the filterGroups array must pass. For a filter group to pass, each of its filters must pass.

manualCreation

If manualCreation is true, CodeBuild doesn't create a webhook in GitHub and instead returns payloadUrl and secret values for the webhook. The payloadUrl and secret values in the output can be used to manually create a webhook within GitHub.

manualCreation is only available for GitHub webhooks.

projectName

Required: Yes

Type: string

The name of the CodeBuild project.

scopeConfiguration

Type: ScopeConfiguration structure

The scope configuration for global or organization webhooks.

Global or organization webhooks are only available for GitHub and Github Enterprise webhooks.

Result Syntax

[ 'webhook' => [ 'branchFilter' => '', 'buildType' => 'BUILD|BUILD_BATCH|RUNNER_BUILDKITE_BUILD', 'filterGroups' => [ [ [ 'excludeMatchedPattern' => true || false, 'pattern' => '', 'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME|ORGANIZATION_NAME', ], // ... ], // ... ], 'lastModifiedSecret' => , 'manualCreation' => true || false, 'payloadUrl' => '', 'scopeConfiguration' => [ 'domain' => '', 'name' => '', 'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP', ], 'secret' => '', 'status' => 'CREATING|CREATE_FAILED|ACTIVE|DELETING', 'statusMessage' => '', 'url' => '', ], ]

Result Details

Members

webhook

Information about a webhook that connects repository events to a build project in CodeBuild.

Errors

OAuthProviderException:

The input value that was provided is not valid.

There was a problem with the underlying OAuth provider.

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.

The specified Amazon Web Services resource cannot be found.

DeleteBuildBatch

result=result = result=client->deleteBuildBatch([/* ... /]); promise=promise = promise=client->deleteBuildBatchAsync([/ ... */]);

Deletes a batch build.

Parameter Syntax

result=result = result=client->deleteBuildBatch([ 'id' => '', // REQUIRED ]);

Parameter Details

Members

Required: Yes

Type: string

The identifier of the batch build to delete.

Result Syntax

[ 'buildsDeleted' => ['', ...], 'buildsNotDeleted' => [ [ 'id' => '', 'statusCode' => '', ], // ... ], 'statusCode' => '', ]

Result Details

Members

buildsDeleted

An array of strings that contain the identifiers of the builds that were deleted.

buildsNotDeleted

Type: Array of BuildNotDeleted structures

An array of BuildNotDeleted objects that specify the builds that could not be deleted.

statusCode

The status code.

Errors

The input value that was provided is not valid.

DeleteFleet

result=result = result=client->deleteFleet([/* ... /]); promise=promise = promise=client->deleteFleetAsync([/ ... */]);

Deletes a compute fleet. When you delete a compute fleet, its builds are not deleted.

Parameter Syntax

result=result = result=client->deleteFleet([ 'arn' => '', // REQUIRED ]);

Parameter Details

Members

arn

Required: Yes

Type: string

The ARN of the compute fleet.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input value that was provided is not valid.

DeleteProject

result=result = result=client->deleteProject([/* ... /]); promise=promise = promise=client->deleteProjectAsync([/ ... */]);

Deletes a build project. When you delete a project, its builds are not deleted.

Parameter Syntax

result=result = result=client->deleteProject([ 'name' => '', // REQUIRED ]);

Parameter Details

Members

name

Required: Yes

Type: string

The name of the build project.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input value that was provided is not valid.

DeleteReport

result=result = result=client->deleteReport([/* ... /]); promise=promise = promise=client->deleteReportAsync([/ ... */]);

Deletes a report.

Parameter Syntax

result=result = result=client->deleteReport([ 'arn' => '', // REQUIRED ]);

Parameter Details

Members

arn

Required: Yes

Type: string

The ARN of the report to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input value that was provided is not valid.

DeleteReportGroup

result=result = result=client->deleteReportGroup([/* ... /]); promise=promise = promise=client->deleteReportGroupAsync([/ ... */]);

Deletes a report group. Before you delete a report group, you must delete its reports.

Parameter Syntax

result=result = result=client->deleteReportGroup([ 'arn' => '', // REQUIRED 'deleteReports' => true || false, ]);

Parameter Details

Members

arn

Required: Yes

Type: string

The ARN of the report group to delete.

deleteReports

If true, deletes any reports that belong to a report group before deleting the report group.

If false, you must delete any reports in the report group. Use ListReportsForReportGroup to get the reports in a report group. Use DeleteReport to delete the reports. If you call DeleteReportGroup for a report group that contains one or more reports, an exception is thrown.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input value that was provided is not valid.

DeleteResourcePolicy

result=result = result=client->deleteResourcePolicy([/* ... /]); promise=promise = promise=client->deleteResourcePolicyAsync([/ ... */]);

Deletes a resource policy that is identified by its resource ARN.

Parameter Syntax

result=result = result=client->deleteResourcePolicy([ 'resourceArn' => '', // REQUIRED ]);

Parameter Details

Members

resourceArn

Required: Yes

Type: string

The ARN of the resource that is associated with the resource policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input value that was provided is not valid.

DeleteSourceCredentials

result=result = result=client->deleteSourceCredentials([/* ... /]); promise=promise = promise=client->deleteSourceCredentialsAsync([/ ... */]);

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

Parameter Syntax

result=result = result=client->deleteSourceCredentials([ 'arn' => '', // REQUIRED ]);

Parameter Details

Members

arn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the token.

Result Syntax

[ 'arn' => '', ]

Result Details

Members

arn

The Amazon Resource Name (ARN) of the token.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

DeleteWebhook

result=result = result=client->deleteWebhook([/* ... /]); promise=promise = promise=client->deleteWebhookAsync([/ ... */]);

Parameter Syntax

result=result = result=client->deleteWebhook([ 'projectName' => '', // REQUIRED ]);

Parameter Details

Members

projectName

Required: Yes

Type: string

The name of the CodeBuild project.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input value that was provided is not valid.

OAuthProviderException:

The specified Amazon Web Services resource cannot be found.

There was a problem with the underlying OAuth provider.

DescribeCodeCoverages

result=result = result=client->describeCodeCoverages([/* ... /]); promise=promise = promise=client->describeCodeCoveragesAsync([/ ... */]);

Retrieves one or more code coverage reports.

Parameter Syntax

result=result = result=client->describeCodeCoverages([ 'maxLineCoveragePercentage' => , 'maxResults' => , 'minLineCoveragePercentage' => , 'nextToken' => '', 'reportArn' => '', // REQUIRED 'sortBy' => 'LINE_COVERAGE_PERCENTAGE|FILE_PATH', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxLineCoveragePercentage

The maximum line coverage percentage to report.

maxResults

The maximum number of results to return.

minLineCoveragePercentage

The minimum line coverage percentage to report.

nextToken

The nextToken value returned from a previous call to DescribeCodeCoverages. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

reportArn

Required: Yes

Type: string

The ARN of the report for which test cases are returned.

sortBy

Specifies how the results are sorted. Possible values are:

FILE_PATH

The results are sorted by file path.

LINE_COVERAGE_PERCENTAGE

The results are sorted by the percentage of lines that are covered.

sortOrder

Specifies if the results are sorted in ascending or descending order.

Result Syntax

[ 'codeCoverages' => [ [ 'branchCoveragePercentage' => , 'branchesCovered' => , 'branchesMissed' => , 'expired' => , 'filePath' => '', 'id' => '', 'lineCoveragePercentage' => , 'linesCovered' => , 'linesMissed' => , 'reportARN' => '', ], // ... ], 'nextToken' => '', ]

Result Details

Members

codeCoverages

Type: Array of CodeCoverage structures

An array of CodeCoverage objects that contain the results.

nextToken

If there are more items to return, this contains a token that is passed to a subsequent call to DescribeCodeCoverages to retrieve the next set of items.

Errors

The input value that was provided is not valid.

DescribeTestCases

result=result = result=client->describeTestCases([/* ... /]); promise=promise = promise=client->describeTestCasesAsync([/ ... */]);

Returns a list of details about test cases for a report.

Parameter Syntax

result=result = result=client->describeTestCases([ 'filter' => [ 'keyword' => '', 'status' => '', ], 'maxResults' => , 'nextToken' => '', 'reportArn' => '', // REQUIRED ]);

Parameter Details

Members

filter

Type: TestCaseFilter structure

A TestCaseFilter object used to filter the returned reports.

maxResults

The maximum number of paginated test cases returned per response. Use nextToken to iterate pages in the list of returned TestCase objects. The default value is 100.

nextToken

During a previous call, the maximum number of items that can be returned is the value specified in maxResults. If there more items in the list, then a unique string called a nextToken is returned. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

reportArn

Required: Yes

Type: string

The ARN of the report for which test cases are returned.

Result Syntax

[ 'nextToken' => '', 'testCases' => [ [ 'durationInNanoSeconds' => , 'expired' => , 'message' => '', 'name' => '', 'prefix' => '', 'reportArn' => '', 'status' => '', 'testRawDataPath' => '', 'testSuiteName' => '', ], // ... ], ]

Result Details

Members

nextToken

testCases

Type: Array of TestCase structures

The returned list of test cases.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

GetReportGroupTrend

result=result = result=client->getReportGroupTrend([/* ... /]); promise=promise = promise=client->getReportGroupTrendAsync([/ ... */]);

Analyzes and accumulates test report values for the specified test reports.

Parameter Syntax

Parameter Details

Members

numOfReports

The number of reports to analyze. This operation always retrieves the most recent reports.

If this parameter is omitted, the most recent 100 reports are analyzed.

reportGroupArn

Required: Yes

Type: string

The ARN of the report group that contains the reports to analyze.

trendField

Required: Yes

Type: string

The test report value to accumulate. This must be one of the following values:

Test reports:

DURATION

Accumulate the test run times for the specified reports.

PASS_RATE

Accumulate the percentage of tests that passed for the specified test reports.

TOTAL

Accumulate the total number of tests for the specified test reports.

Code coverage reports:

BRANCH_COVERAGE

Accumulate the branch coverage percentages for the specified test reports.

BRANCHES_COVERED

Accumulate the branches covered values for the specified test reports.

BRANCHES_MISSED

Accumulate the branches missed values for the specified test reports.

LINE_COVERAGE

Accumulate the line coverage percentages for the specified test reports.

LINES_COVERED

Accumulate the lines covered values for the specified test reports.

LINES_MISSED

Accumulate the lines not covered values for the specified test reports.

Result Syntax

[ 'rawData' => [ [ 'data' => '', 'reportArn' => '', ], // ... ], 'stats' => [ 'average' => '', 'max' => '', 'min' => '', ], ]

Result Details

Members

rawData

Type: Array of ReportWithRawData structures

An array that contains the raw data for each report.

stats

Type: ReportGroupTrendStats structure

Contains the accumulated trend data.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

GetResourcePolicy

result=result = result=client->getResourcePolicy([/* ... /]); promise=promise = promise=client->getResourcePolicyAsync([/ ... */]);

Gets a resource policy that is identified by its resource ARN.

Parameter Syntax

result=result = result=client->getResourcePolicy([ 'resourceArn' => '', // REQUIRED ]);

Parameter Details

Members

resourceArn

Required: Yes

Type: string

The ARN of the resource that is associated with the resource policy.

Result Syntax

[ 'policy' => '', ]

Result Details

Members

policy

The resource policy for the resource identified by the input ARN parameter.

Errors

The specified Amazon Web Services resource cannot be found.

The input value that was provided is not valid.

ImportSourceCredentials

result=result = result=client->importSourceCredentials([/* ... /]); promise=promise = promise=client->importSourceCredentialsAsync([/ ... */]);

Imports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository.

Parameter Syntax

result=result = result=client->importSourceCredentials([ 'authType' => 'OAUTH|BASIC_AUTH|PERSONAL_ACCESS_TOKEN|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED 'serverType' => 'GITHUB|BITBUCKET|GITHUB_ENTERPRISE|GITLAB|GITLAB_SELF_MANAGED', // REQUIRED 'shouldOverwrite' => true || false, 'token' => '', // REQUIRED 'username' => '', ]);

Parameter Details

Members

authType

Required: Yes

Type: string

The type of authentication used to connect to a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository. An OAUTH connection is not supported by the API and must be created using the CodeBuild console.

serverType

Required: Yes

Type: string

The source provider used for this project.

shouldOverwrite

Set to false to prevent overwriting the repository source credentials. Set to true to overwrite the repository source credentials. The default value is true.

token

Required: Yes

Type: string

For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is either the access token or the app password. For the authType CODECONNECTIONS, this is the connectionArn. For the authType SECRETS_MANAGER, this is the secretArn.

username

The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

Result Syntax

[ 'arn' => '', ]

Result Details

Members

arn

The Amazon Resource Name (ARN) of the token.

Errors

The input value that was provided is not valid.

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

The specified Amazon Web Services resource cannot be created, because an Amazon Web Services resource with the same settings already exists.

InvalidateProjectCache

result=result = result=client->invalidateProjectCache([/* ... /]); promise=promise = promise=client->invalidateProjectCacheAsync([/ ... */]);

Resets the cache for a project.

Parameter Syntax

result=result = result=client->invalidateProjectCache([ 'projectName' => '', // REQUIRED ]);

Parameter Details

Members

projectName

Required: Yes

Type: string

The name of the CodeBuild build project that the cache is reset for.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

ListBuildBatches

result=result = result=client->listBuildBatches([/* ... /]); promise=promise = promise=client->listBuildBatchesAsync([/ ... */]);

Retrieves the identifiers of your build batches in the current region.

Parameter Syntax

Parameter Details

Members

filter

Type: BuildBatchFilter structure

A BuildBatchFilter object that specifies the filters for the search.

maxResults

The maximum number of results to return.

nextToken

The nextToken value returned from a previous call to ListBuildBatches. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

sortOrder

Specifies the sort order of the returned items. Valid values include:

ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.

Result Syntax

[ 'ids' => ['', ...], 'nextToken' => '', ]

Result Details

Members

ids

An array of strings that contains the batch build identifiers.

nextToken

If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatches to retrieve the next set of items.

Errors

The input value that was provided is not valid.

ListBuildBatchesForProject

result=result = result=client->listBuildBatchesForProject([/* ... /]); promise=promise = promise=client->listBuildBatchesForProjectAsync([/ ... */]);

Retrieves the identifiers of the build batches for a specific project.

Parameter Syntax

Parameter Details

Members

filter

Type: BuildBatchFilter structure

A BuildBatchFilter object that specifies the filters for the search.

maxResults

The maximum number of results to return.

nextToken

The nextToken value returned from a previous call to ListBuildBatchesForProject. This specifies the next item to return. To return the beginning of the list, exclude this parameter.

projectName

The name of the project.

sortOrder

Specifies the sort order of the returned items. Valid values include:

ASCENDING: List the batch build identifiers in ascending order by identifier.
DESCENDING: List the batch build identifiers in descending order by identifier.

Result Syntax

[ 'ids' => ['', ...], 'nextToken' => '', ]

Result Details

Members

ids

An array of strings that contains the batch build identifiers.

nextToken

If there are more items to return, this contains a token that is passed to a subsequent call to ListBuildBatchesForProject to retrieve the next set of items.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

ListBuilds

result=result = result=client->listBuilds([/* ... /]); promise=promise = promise=client->listBuildsAsync([/ ... */]);

Gets a list of build IDs, with each build ID representing a single build.

Parameter Syntax

result=result = result=client->listBuilds([ 'nextToken' => '', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

nextToken

During a previous call, if there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call. To get all of the items in the list, keep calling this operation with each subsequent next token that is returned, until no more next tokens are returned.

sortOrder

The order to list build IDs. Valid values include:

ASCENDING: List the build IDs in ascending order by build ID.
DESCENDING: List the build IDs in descending order by build ID.

Result Syntax

[ 'ids' => ['', ...], 'nextToken' => '', ]

Result Details

Members

ids

A list of build IDs, with each build ID representing a single build.

nextToken

If there are more than 100 items in the list, only the first 100 items are returned, along with a unique string called a nextToken. To get the next batch of items in the list, call this operation again, adding the next token to the call.

Errors

The input value that was provided is not valid.

ListBuildsForProject

result=result = result=client->listBuildsForProject([/* ... /]); promise=promise = promise=client->listBuildsForProjectAsync([/ ... */]);

Gets a list of build identifiers for the specified build project, with each build identifier representing a single build.

Parameter Syntax

result=result = result=client->listBuildsForProject([ 'nextToken' => '', 'projectName' => '', // REQUIRED 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

nextToken

projectName

Required: Yes

Type: string

The name of the CodeBuild project.

sortOrder

The order to sort the results in. The results are sorted by build number, not the build identifier. If this is not specified, the results are sorted in descending order.

Valid values include:

ASCENDING: List the build identifiers in ascending order, by build number.
DESCENDING: List the build identifiers in descending order, by build number.

If the project has more than 100 builds, setting the sort order will result in an error.

Result Syntax

[ 'ids' => ['', ...], 'nextToken' => '', ]

Result Details

Members

ids

A list of build identifiers for the specified build project, with each build ID representing a single build.

nextToken

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

ListCommandExecutionsForSandbox

result=result = result=client->listCommandExecutionsForSandbox([/* ... /]); promise=promise = promise=client->listCommandExecutionsForSandboxAsync([/ ... */]);

Gets a list of command executions for a sandbox.

Parameter Syntax

result=result = result=client->listCommandExecutionsForSandbox([ 'maxResults' => , 'nextToken' => '', 'sandboxId' => '', // REQUIRED 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxResults

The maximum number of sandbox records to be retrieved.

nextToken

The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

sandboxId

Required: Yes

Type: string

A sandboxId or sandboxArn.

sortOrder

The order in which sandbox records should be retrieved.

Result Syntax

Result Details

Members

commandExecutions

Type: Array of CommandExecution structures

Information about the requested command executions.

nextToken

Information about the next token to get paginated results.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

ListCuratedEnvironmentImages

result=result = result=client->listCuratedEnvironmentImages([/* ... /]); promise=promise = promise=client->listCuratedEnvironmentImagesAsync([/ ... */]);

Gets information about Docker images that are managed by CodeBuild.

Parameter Syntax

result=result = result=client->listCuratedEnvironmentImages([ ]);

Parameter Details

Members

Result Syntax

Result Details

Members

platforms

Type: Array of EnvironmentPlatform structures

Information about supported platforms for Docker images that are managed by CodeBuild.

Errors

There are no errors described for this operation.

ListFleets

result=result = result=client->listFleets([/* ... /]); promise=promise = promise=client->listFleetsAsync([/ ... */]);

Gets a list of compute fleet names with each compute fleet name representing a single compute fleet.

Parameter Syntax

result=result = result=client->listFleets([ 'maxResults' => , 'nextToken' => '', 'sortBy' => 'NAME|CREATED_TIME|LAST_MODIFIED_TIME', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxResults

The maximum number of paginated compute fleets returned per response. Use nextToken to iterate pages in the list of returned compute fleets.

nextToken

sortBy

The criterion to be used to list compute fleet names. Valid values include:

CREATED_TIME: List based on when each compute fleet was created.
LAST_MODIFIED_TIME: List based on when information about each compute fleet was last changed.
NAME: List based on each compute fleet's name.

Use sortOrder to specify in what order to list the compute fleet names based on the preceding criteria.

sortOrder

The order in which to list compute fleets. Valid values include:

ASCENDING: List in ascending order.
DESCENDING: List in descending order.

Use sortBy to specify the criterion to be used to list compute fleet names.

Result Syntax

[ 'fleets' => ['', ...], 'nextToken' => '', ]

Result Details

Members

fleets

The list of compute fleet names.

nextToken

Errors

The input value that was provided is not valid.

ListProjects

result=result = result=client->listProjects([/* ... /]); promise=promise = promise=client->listProjectsAsync([/ ... */]);

Gets a list of build project names, with each build project name representing a single build project.

Parameter Syntax

result=result = result=client->listProjects([ 'nextToken' => '', 'sortBy' => 'NAME|CREATED_TIME|LAST_MODIFIED_TIME', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

nextToken

sortBy

The criterion to be used to list build project names. Valid values include:

CREATED_TIME: List based on when each build project was created.
LAST_MODIFIED_TIME: List based on when information about each build project was last changed.
NAME: List based on each build project's name.

Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

sortOrder

The order in which to list build projects. Valid values include:

ASCENDING: List in ascending order.
DESCENDING: List in descending order.

Use sortBy to specify the criterion to be used to list build project names.

Result Syntax

[ 'nextToken' => '', 'projects' => ['', ...], ]

Result Details

Members

nextToken

projects

The list of build project names, with each build project name representing a single build project.

Errors

The input value that was provided is not valid.

ListReportGroups

result=result = result=client->listReportGroups([/* ... /]); promise=promise = promise=client->listReportGroupsAsync([/ ... */]);

Gets a list ARNs for the report groups in the current Amazon Web Services account.

Parameter Syntax

result=result = result=client->listReportGroups([ 'maxResults' => , 'nextToken' => '', 'sortBy' => 'NAME|CREATED_TIME|LAST_MODIFIED_TIME', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxResults

The maximum number of paginated report groups returned per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

nextToken

sortBy

The criterion to be used to list build report groups. Valid values include:

CREATED_TIME: List based on when each report group was created.
LAST_MODIFIED_TIME: List based on when each report group was last changed.
NAME: List based on each report group's name.

sortOrder

Used to specify the order to sort the list of returned report groups. Valid values are ASCENDING and DESCENDING.

Result Syntax

[ 'nextToken' => '', 'reportGroups' => ['', ...], ]

Result Details

Members

nextToken

reportGroups

The list of ARNs for the report groups in the current Amazon Web Services account.

Errors

The input value that was provided is not valid.

ListReports

result=result = result=client->listReports([/* ... /]); promise=promise = promise=client->listReportsAsync([/ ... */]);

Returns a list of ARNs for the reports in the current Amazon Web Services account.

Parameter Syntax

Parameter Details

Members

filter

Type: ReportFilter structure

A ReportFilter object used to filter the returned reports.

maxResults

The maximum number of paginated reports returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

nextToken

sortOrder

Specifies the sort order for the list of returned reports. Valid values are:

ASCENDING: return reports in chronological order based on their creation date.
DESCENDING: return reports in the reverse chronological order based on their creation date.

Result Syntax

[ 'nextToken' => '', 'reports' => ['', ...], ]

Result Details

Members

nextToken

reports

The list of returned ARNs for the reports in the current Amazon Web Services account.

Errors

The input value that was provided is not valid.

ListReportsForReportGroup

result=result = result=client->listReportsForReportGroup([/* ... /]); promise=promise = promise=client->listReportsForReportGroupAsync([/ ... */]);

Returns a list of ARNs for the reports that belong to a ReportGroup.

Parameter Syntax

result=result = result=client->listReportsForReportGroup([ 'filter' => [ 'status' => 'GENERATING|SUCCEEDED|FAILED|INCOMPLETE|DELETING', ], 'maxResults' => , 'nextToken' => '', 'reportGroupArn' => '', // REQUIRED 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

filter

Type: ReportFilter structure

A ReportFilter object used to filter the returned reports.

maxResults

The maximum number of paginated reports in this report group returned per response. Use nextToken to iterate pages in the list of returned Report objects. The default value is 100.

nextToken

reportGroupArn

Required: Yes

Type: string

The ARN of the report group for which you want to return report ARNs.

sortOrder

Use to specify whether the results are returned in ascending or descending order.

Result Syntax

[ 'nextToken' => '', 'reports' => ['', ...], ]

Result Details

Members

nextToken

reports

The list of report ARNs.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

ListSandboxes

result=result = result=client->listSandboxes([/* ... /]); promise=promise = promise=client->listSandboxesAsync([/ ... */]);

Gets a list of sandboxes.

Parameter Syntax

result=result = result=client->listSandboxes([ 'maxResults' => , 'nextToken' => '', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxResults

The maximum number of sandbox records to be retrieved.

nextToken

The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

sortOrder

The order in which sandbox records should be retrieved.

Result Syntax

[ 'ids' => ['', ...], 'nextToken' => '', ]

Result Details

Members

ids

Information about the requested sandbox IDs.

nextToken

Information about the next token to get paginated results.

Errors

The input value that was provided is not valid.

ListSandboxesForProject

result=result = result=client->listSandboxesForProject([/* ... /]); promise=promise = promise=client->listSandboxesForProjectAsync([/ ... */]);

Gets a list of sandboxes for a given project.

Parameter Syntax

result=result = result=client->listSandboxesForProject([ 'maxResults' => , 'nextToken' => '', 'projectName' => '', // REQUIRED 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxResults

The maximum number of sandbox records to be retrieved.

nextToken

The next token, if any, to get paginated results. You will get this value from previous execution of list sandboxes.

projectName

Required: Yes

Type: string

The CodeBuild project name.

sortOrder

The order in which sandbox records should be retrieved.

Result Syntax

[ 'ids' => ['', ...], 'nextToken' => '', ]

Result Details

Members

ids

Information about the requested sandbox IDs.

nextToken

Information about the next token to get paginated results.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

ListSharedProjects

result=result = result=client->listSharedProjects([/* ... /]); promise=promise = promise=client->listSharedProjectsAsync([/ ... */]);

Gets a list of projects that are shared with other Amazon Web Services accounts or users.

Parameter Syntax

result=result = result=client->listSharedProjects([ 'maxResults' => , 'nextToken' => '', 'sortBy' => 'ARN|MODIFIED_TIME', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxResults

The maximum number of paginated shared build projects returned per response. Use nextToken to iterate pages in the list of returned Project objects. The default value is 100.

nextToken

sortBy

The criterion to be used to list build projects shared with the current Amazon Web Services account or user. Valid values include:

ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared project was last changed.

sortOrder

The order in which to list shared build projects. Valid values include:

ASCENDING: List in ascending order.
DESCENDING: List in descending order.

Result Syntax

[ 'nextToken' => '', 'projects' => ['', ...], ]

Result Details

Members

nextToken

projects

The list of ARNs for the build projects shared with the current Amazon Web Services account or user.

Errors

The input value that was provided is not valid.

ListSharedReportGroups

result=result = result=client->listSharedReportGroups([/* ... /]); promise=promise = promise=client->listSharedReportGroupsAsync([/ ... */]);

Gets a list of report groups that are shared with other Amazon Web Services accounts or users.

Parameter Syntax

result=result = result=client->listSharedReportGroups([ 'maxResults' => , 'nextToken' => '', 'sortBy' => 'ARN|MODIFIED_TIME', 'sortOrder' => 'ASCENDING|DESCENDING', ]);

Parameter Details

Members

maxResults

The maximum number of paginated shared report groups per response. Use nextToken to iterate pages in the list of returned ReportGroup objects. The default value is 100.

nextToken

sortBy

The criterion to be used to list report groups shared with the current Amazon Web Services account or user. Valid values include:

ARN: List based on the ARN.
MODIFIED_TIME: List based on when information about the shared report group was last changed.

sortOrder

The order in which to list shared report groups. Valid values include:

ASCENDING: List in ascending order.
DESCENDING: List in descending order.

Result Syntax

[ 'nextToken' => '', 'reportGroups' => ['', ...], ]

Result Details

Members

nextToken

reportGroups

The list of ARNs for the report groups shared with the current Amazon Web Services account or user.

Errors

The input value that was provided is not valid.

ListSourceCredentials

result=result = result=client->listSourceCredentials([/* ... /]); promise=promise = promise=client->listSourceCredentialsAsync([/ ... */]);

Returns a list of SourceCredentialsInfo objects.

Parameter Syntax

result=result = result=client->listSourceCredentials([ ]);

Parameter Details

Members

Result Syntax

Result Details

Members

sourceCredentialsInfos

Type: Array of SourceCredentialsInfo structures

A list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

Errors

The input value that was provided is not valid.

PutResourcePolicy

result=result = result=client->putResourcePolicy([/* ... /]); promise=promise = promise=client->putResourcePolicyAsync([/ ... */]);

Stores a resource policy for the ARN of a Project or ReportGroup object.

Parameter Syntax

result=result = result=client->putResourcePolicy([ 'policy' => '', // REQUIRED 'resourceArn' => '', // REQUIRED ]);

Parameter Details

Members

policy

Required: Yes

Type: string

resourceArn

Required: Yes

Type: string

The ARN of the Project or ReportGroup resource you want to associate with a resource policy.

Result Syntax

[ 'resourceArn' => '', ]

Result Details

Members

resourceArn

The ARN of the Project or ReportGroup resource that is associated with a resource policy.

Errors

The specified Amazon Web Services resource cannot be found.

The input value that was provided is not valid.

RetryBuild

result=result = result=client->retryBuild([/* ... /]); promise=promise = promise=client->retryBuildAsync([/ ... */]);

Restarts a build.

Parameter Syntax

result=result = result=client->retryBuild([ 'id' => '', 'idempotencyToken' => '', ]);

Parameter Details

Members

Specifies the identifier of the build to restart.

idempotencyToken

A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuild request. The token is included in the RetryBuild request and is valid for five minutes. If you repeat the RetryBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

Result Syntax

[ 'build' => [ 'arn' => '', 'artifacts' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], 'autoRetryConfig' => [ 'autoRetryLimit' => , 'autoRetryNumber' => , 'nextAutoRetry' => '', 'previousAutoRetry' => '', ], 'buildBatchArn' => '', 'buildComplete' => true || false, 'buildNumber' => , 'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', ], 'currentPhase' => '', 'debugSession' => [ 'sessionEnabled' => true || false, 'sessionTarget' => '', ], 'encryptionKey' => '', 'endTime' => , 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'exportedEnvironmentVariables' => [ [ 'name' => '', 'value' => '', ], // ... ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'id' => '', 'initiator' => '', 'logs' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 'cloudWatchLogsArn' => '', 'deepLink' => '', 'groupName' => '', 's3DeepLink' => '', 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], 's3LogsArn' => '', 'streamName' => '', ], 'networkInterface' => [ 'networkInterfaceId' => '', 'subnetId' => '', ], 'phases' => [ [ 'contexts' => [ [ 'message' => '', 'statusCode' => '', ], // ... ], 'durationInSeconds' => , 'endTime' => , 'phaseStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'phaseType' => 'SUBMITTED|QUEUED|PROVISIONING|DOWNLOAD_SOURCE|INSTALL|PRE_BUILD|BUILD|POST_BUILD|UPLOAD_ARTIFACTS|FINALIZING|COMPLETED', 'startTime' => , ], // ... ], 'projectName' => '', 'queuedTimeoutInMinutes' => , 'reportArns' => ['', ...], 'resolvedSourceVersion' => '', 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'startTime' => , 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ], ]

Result Details

Members

build

Information about a build.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

RetryBuildBatch

result=result = result=client->retryBuildBatch([/* ... /]); promise=promise = promise=client->retryBuildBatchAsync([/ ... */]);

Restarts a failed batch build. Only batch builds that have failed can be retried.

Parameter Syntax

result=result = result=client->retryBuildBatch([ 'id' => '', 'idempotencyToken' => '', 'retryType' => 'RETRY_ALL_BUILDS|RETRY_FAILED_BUILDS', ]);

Parameter Details

Members

Specifies the identifier of the batch build to restart.

idempotencyToken

A unique, case sensitive identifier you provide to ensure the idempotency of the RetryBuildBatch request. The token is included in the RetryBuildBatch request and is valid for five minutes. If you repeat the RetryBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

retryType

Specifies the type of retry to perform.

Result Syntax

[ 'buildBatch' => [ 'arn' => '', 'artifacts' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], 'buildBatchConfig' => [ 'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH', 'combineArtifacts' => true || false, 'restrictions' => [ 'computeTypesAllowed' => ['', ...], 'fleetsAllowed' => ['', ...], 'maximumBuildsAllowed' => , ], 'serviceRole' => '', 'timeoutInMins' => , ], 'buildBatchNumber' => , 'buildBatchStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'buildGroups' => [ [ 'currentBuildSummary' => [ 'arn' => '', 'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'primaryArtifact' => [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], 'requestedOn' => , 'secondaryArtifacts' => [ [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], // ... ], ], 'dependsOn' => ['', ...], 'identifier' => '', 'ignoreFailure' => true || false, 'priorBuildSummaryList' => [ [ 'arn' => '', 'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'primaryArtifact' => [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], 'requestedOn' => , 'secondaryArtifacts' => [ [ 'identifier' => '', 'location' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', ], // ... ], ], // ... ], ], // ... ], 'buildTimeoutInMinutes' => , 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', ], 'complete' => true || false, 'currentPhase' => '', 'debugSessionEnabled' => true || false, 'encryptionKey' => '', 'endTime' => , 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'id' => '', 'initiator' => '', 'logConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], ], 'phases' => [ [ 'contexts' => [ [ 'message' => '', 'statusCode' => '', ], // ... ], 'durationInSeconds' => , 'endTime' => , 'phaseStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'phaseType' => 'SUBMITTED|DOWNLOAD_BATCHSPEC|IN_PROGRESS|COMBINE_ARTIFACTS|SUCCEEDED|FAILED|STOPPED', 'startTime' => , ], // ... ], 'projectName' => '', 'queuedTimeoutInMinutes' => , 'reportArns' => ['', ...], 'resolvedSourceVersion' => '', 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'md5sum' => '', 'overrideArtifactName' => true || false, 'sha256sum' => '', ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'startTime' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ], ]

Result Details

Members

buildBatch

Type: BuildBatch structure

Contains information about a batch build.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

StartBuild

result=result = result=client->startBuild([/* ... /]); promise=promise = promise=client->startBuildAsync([/ ... */]);

Starts running a build with the settings defined in the project. These setting include: how to run a build, where to get the source code, which build environment to use, which build commands to run, and where to store the build output.

You can also start a build run by overriding some of the build settings in the project. The overrides only apply for that specific start build request. The settings in the project are unaltered.

Parameter Syntax

result=result = result=client->startBuild([ 'artifactsOverride' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], 'autoRetryLimitOverride' => , 'buildStatusConfigOverride' => [ 'context' => '', 'targetUrl' => '', ], 'buildspecOverride' => '', 'cacheOverride' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', // REQUIRED ], 'certificateOverride' => '', 'computeTypeOverride' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'debugSessionEnabled' => true || false, 'encryptionKeyOverride' => '', 'environmentTypeOverride' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', 'environmentVariablesOverride' => [ [ 'name' => '', // REQUIRED 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', // REQUIRED ], // ... ], 'fleetOverride' => [ 'fleetArn' => '', ], 'gitCloneDepthOverride' => , 'gitSubmodulesConfigOverride' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'idempotencyToken' => '', 'imageOverride' => '', 'imagePullCredentialsTypeOverride' => 'CODEBUILD|SERVICE_ROLE', 'insecureSslOverride' => true || false, 'logsConfigOverride' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED ], ], 'privilegedModeOverride' => true || false, 'projectName' => '', // REQUIRED 'queuedTimeoutInMinutesOverride' => , 'registryCredentialOverride' => [ 'credential' => '', // REQUIRED 'credentialProvider' => 'SECRETS_MANAGER', // REQUIRED ], 'reportBuildStatusOverride' => true || false, 'secondaryArtifactsOverride' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], // ... ], 'secondarySourcesOverride' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED ], // ... ], 'secondarySourcesVersionOverride' => [ [ 'sourceIdentifier' => '', // REQUIRED 'sourceVersion' => '', // REQUIRED ], // ... ], 'serviceRoleOverride' => '', 'sourceAuthOverride' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'sourceLocationOverride' => '', 'sourceTypeOverride' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', 'sourceVersion' => '', 'timeoutInMinutesOverride' => , ]);

Parameter Details

Members

artifactsOverride

Type: ProjectArtifacts structure

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

autoRetryLimitOverride

buildStatusConfigOverride

Type: BuildStatusConfig structure

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

buildspecOverride

A buildspec file declaration that overrides the latest one defined in the build project, for this build only. The buildspec defined on the project is not changed.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same Amazon Web Services Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Since this property allows you to change the build commands that will run in the container, you should note that an IAM principal with the ability to call this API and set this parameter can override the default settings. Moreover, we encourage that you use a trustworthy buildspec location like a file in your source repository or a Amazon S3 bucket.

cacheOverride

Type: ProjectCache structure

A ProjectCache object specified for this build that overrides the one defined in the build project.

certificateOverride

The name of a certificate for this build that overrides the one specified in the build project.

computeTypeOverride

The name of a compute type for this build that overrides the one specified in the build project.

debugSessionEnabled

encryptionKeyOverride

The Key Management Service customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

environmentTypeOverride

A container type for this build that overrides the one specified in the build project.

environmentVariablesOverride

Type: Array of EnvironmentVariable structures

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

fleetOverride

Type: ProjectFleet structure

A ProjectFleet object specified for this build that overrides the one defined in the build project.

gitCloneDepthOverride

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

gitSubmodulesConfigOverride

Type: GitSubmodulesConfig structure

Information about the Git submodules configuration for this build of an CodeBuild build project.

idempotencyToken

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

imageOverride

The name of an image for this build that overrides the one specified in the build project.

imagePullCredentialsTypeOverride

The type of credentials CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

insecureSslOverride

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

logsConfigOverride

Type: LogsConfig structure

Log settings for this build that override the log settings defined in the build project.

privilegedModeOverride

Enable this flag to override privileged mode in the build project.

projectName

Required: Yes

Type: string

The name of the CodeBuild build project to start running a build.

queuedTimeoutInMinutesOverride

The number of minutes a build is allowed to be queued before it times out.

registryCredentialOverride

Type: RegistryCredential structure

The credentials for access to a private registry.

reportBuildStatusOverride

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket, an invalidInputException is thrown.

To be able to report the build status to the source provider, the user associated with the source provider must have write access to the repo. If the user does not have write access, the build status cannot be updated. For more information, see Source provider access in the CodeBuild User Guide.

The status of a build triggered by a webhook is always reported to your source provider.

secondaryArtifactsOverride

Type: Array of ProjectArtifacts structures

An array of ProjectArtifacts objects.

secondarySourcesOverride

Type: Array of ProjectSource structures

An array of ProjectSource objects.

secondarySourcesVersionOverride

Type: Array of ProjectSourceVersion structures

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

serviceRoleOverride

The name of a service role for this build that overrides the one specified in the build project.

sourceAuthOverride

Type: SourceAuth structure

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket, GitHub, GitLab, or GitLab Self Managed.

sourceLocationOverride

A location that overrides, for this build, the source location for the one defined in the build project.

sourceTypeOverride

A source input type, for this build, that overrides the source input defined in the build project.

sourceVersion

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

GitLab

The commit ID, branch, or Git tag to use.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

timeoutInMinutesOverride

The number of build timeout minutes, from 5 to 2160 (36 hours), that overrides, for this build only, the latest setting already defined in the build project.

Result Syntax

Result Details

Members

build

Information about the build to be run.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

StartBuildBatch

result=result = result=client->startBuildBatch([/* ... /]); promise=promise = promise=client->startBuildBatchAsync([/ ... */]);

Starts a batch build for a project.

Parameter Syntax

result=result = result=client->startBuildBatch([ 'artifactsOverride' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], 'buildBatchConfigOverride' => [ 'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH', 'combineArtifacts' => true || false, 'restrictions' => [ 'computeTypesAllowed' => ['', ...], 'fleetsAllowed' => ['', ...], 'maximumBuildsAllowed' => , ], 'serviceRole' => '', 'timeoutInMins' => , ], 'buildTimeoutInMinutesOverride' => , 'buildspecOverride' => '', 'cacheOverride' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', // REQUIRED ], 'certificateOverride' => '', 'computeTypeOverride' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'debugSessionEnabled' => true || false, 'encryptionKeyOverride' => '', 'environmentTypeOverride' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', 'environmentVariablesOverride' => [ [ 'name' => '', // REQUIRED 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', // REQUIRED ], // ... ], 'gitCloneDepthOverride' => , 'gitSubmodulesConfigOverride' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'idempotencyToken' => '', 'imageOverride' => '', 'imagePullCredentialsTypeOverride' => 'CODEBUILD|SERVICE_ROLE', 'insecureSslOverride' => true || false, 'logsConfigOverride' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED ], ], 'privilegedModeOverride' => true || false, 'projectName' => '', // REQUIRED 'queuedTimeoutInMinutesOverride' => , 'registryCredentialOverride' => [ 'credential' => '', // REQUIRED 'credentialProvider' => 'SECRETS_MANAGER', // REQUIRED ], 'reportBuildBatchStatusOverride' => true || false, 'secondaryArtifactsOverride' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], // ... ], 'secondarySourcesOverride' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED ], // ... ], 'secondarySourcesVersionOverride' => [ [ 'sourceIdentifier' => '', // REQUIRED 'sourceVersion' => '', // REQUIRED ], // ... ], 'serviceRoleOverride' => '', 'sourceAuthOverride' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'sourceLocationOverride' => '', 'sourceTypeOverride' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', 'sourceVersion' => '', ]);

Parameter Details

Members

artifactsOverride

Type: ProjectArtifacts structure

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

buildBatchConfigOverride

Type: ProjectBuildBatchConfig structure

A BuildBatchConfigOverride object that contains batch build configuration overrides.

buildTimeoutInMinutesOverride

Overrides the build timeout specified in the batch build project.

buildspecOverride

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

cacheOverride

Type: ProjectCache structure

A ProjectCache object that specifies cache overrides.

certificateOverride

The name of a certificate for this batch build that overrides the one specified in the batch build project.

computeTypeOverride

The name of a compute type for this batch build that overrides the one specified in the batch build project.

debugSessionEnabled

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager. Batch session debugging is not supported for matrix batch builds.

encryptionKeyOverride

The Key Management Service customer master key (CMK) that overrides the one specified in the batch build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

environmentTypeOverride

A container type for this batch build that overrides the one specified in the batch build project.

environmentVariablesOverride

Type: Array of EnvironmentVariable structures

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

gitCloneDepthOverride

The user-defined depth of history, with a minimum value of 0, that overrides, for this batch build only, any previous depth of history defined in the batch build project.

gitSubmodulesConfigOverride

Type: GitSubmodulesConfig structure

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

idempotencyToken

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuildBatch request. The token is included in the StartBuildBatch request and is valid for five minutes. If you repeat the StartBuildBatch request with the same token, but change a parameter, CodeBuild returns a parameter mismatch error.

imageOverride

The name of an image for this batch build that overrides the one specified in the batch build project.

imagePullCredentialsTypeOverride

The type of credentials CodeBuild uses to pull images in your batch build. There are two valid values:

CODEBUILD

Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.

SERVICE_ROLE

Specifies that CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an CodeBuild curated image, you must use CODEBUILD credentials.

insecureSslOverride

Enable this flag to override the insecure SSL setting that is specified in the batch build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

logsConfigOverride

Type: LogsConfig structure

A LogsConfig object that override the log settings defined in the batch build project.

privilegedModeOverride

Enable this flag to override privileged mode in the batch build project.

projectName

Required: Yes

Type: string

The name of the project.

queuedTimeoutInMinutesOverride

The number of minutes a batch build is allowed to be queued before it times out.

registryCredentialOverride

Type: RegistryCredential structure

A RegistryCredential object that overrides credentials for access to a private registry.

reportBuildBatchStatusOverride

Set to true to report to your source provider the status of a batch build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

secondaryArtifactsOverride

Type: Array of ProjectArtifacts structures

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

secondarySourcesOverride

Type: Array of ProjectSource structures

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

secondarySourcesVersionOverride

Type: Array of ProjectSourceVersion structures

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

serviceRoleOverride

The name of a service role for this batch build that overrides the one specified in the batch build project.

sourceAuthOverride

Type: SourceAuth structure

A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project's source is BitBucket or GitHub.

sourceLocationOverride

A location that overrides, for this batch build, the source location defined in the batch build project.

sourceTypeOverride

The source input type that overrides the source input defined in the batch build project.

sourceVersion

The version of the batch build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

Bitbucket

Amazon S3

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

Result Syntax

Result Details

Members

buildBatch

Type: BuildBatch structure

A BuildBatch object that contains information about the batch build.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

StartCommandExecution

result=result = result=client->startCommandExecution([/* ... /]); promise=promise = promise=client->startCommandExecutionAsync([/ ... */]);

Starts a command execution.

Parameter Syntax

result=result = result=client->startCommandExecution([ 'command' => '', // REQUIRED 'sandboxId' => '', // REQUIRED 'type' => 'SHELL', ]);

Parameter Details

Members

command

Required: Yes

Type: string

The command that needs to be executed.

sandboxId

Required: Yes

Type: string

A sandboxId or sandboxArn.

type

The command type.

Result Syntax

[ 'commandExecution' => [ 'command' => '', 'endTime' => , 'exitCode' => '', 'id' => '', 'logs' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 'cloudWatchLogsArn' => '', 'deepLink' => '', 'groupName' => '', 's3DeepLink' => '', 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], 's3LogsArn' => '', 'streamName' => '', ], 'sandboxArn' => '', 'sandboxId' => '', 'standardErrContent' => '', 'standardOutputContent' => '', 'startTime' => , 'status' => '', 'submitTime' => , 'type' => 'SHELL', ], ]

Result Details

Members

commandExecution

Type: CommandExecution structure

Information about the requested command executions.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

StartSandbox

result=result = result=client->startSandbox([/* ... /]); promise=promise = promise=client->startSandboxAsync([/ ... */]);

Starts a sandbox.

Parameter Syntax

result=result = result=client->startSandbox([ 'idempotencyToken' => '', 'projectName' => '', ]);

Parameter Details

Members

idempotencyToken

A unique client token.

projectName

The CodeBuild project name.

Result Syntax

[ 'sandbox' => [ 'arn' => '', 'currentSession' => [ 'currentPhase' => '', 'endTime' => , 'id' => '', 'logs' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 'cloudWatchLogsArn' => '', 'deepLink' => '', 'groupName' => '', 's3DeepLink' => '', 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], 's3LogsArn' => '', 'streamName' => '', ], 'networkInterface' => [ 'networkInterfaceId' => '', 'subnetId' => '', ], 'phases' => [ [ 'contexts' => [ [ 'message' => '', 'statusCode' => '', ], // ... ], 'durationInSeconds' => , 'endTime' => , 'phaseStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED', 'phaseType' => '', 'startTime' => , ], // ... ], 'resolvedSourceVersion' => '', 'startTime' => , 'status' => '', ], 'encryptionKey' => '', 'endTime' => , 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentVariables' => [ [ 'name' => '', 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', 'credentialProvider' => 'SECRETS_MANAGER', ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'id' => '', 'logConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', ], ], 'projectName' => '', 'queuedTimeoutInMinutes' => , 'requestTime' => , 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', 'sourceVersion' => '', ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', ], 'sourceVersion' => '', 'startTime' => , 'status' => '', 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ], ]

Result Details

Members

sandbox

Information about the requested sandbox.

Errors

The input value that was provided is not valid.

AccountSuspendedException:

The specified Amazon Web Services resource cannot be found.

The CodeBuild access has been suspended for the calling Amazon Web Services account.

StartSandboxConnection

result=result = result=client->startSandboxConnection([/* ... /]); promise=promise = promise=client->startSandboxConnectionAsync([/ ... */]);

Starts a sandbox connection.

Parameter Syntax

result=result = result=client->startSandboxConnection([ 'sandboxId' => '', // REQUIRED ]);

Parameter Details

Members

sandboxId

Required: Yes

Type: string

A sandboxId or sandboxArn.

Result Syntax

[ 'ssmSession' => [ 'sessionId' => '', 'streamUrl' => '', 'tokenValue' => '', ], ]

Result Details

Members

ssmSession

Type: SSMSession structure

Information about the Session Manager session.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

StopBuild

result=result = result=client->stopBuild([/* ... /]); promise=promise = promise=client->stopBuildAsync([/ ... */]);

Attempts to stop running a build.

Parameter Syntax

result=result = result=client->stopBuild([ 'id' => '', // REQUIRED ]);

Parameter Details

Members

Required: Yes

Type: string

The ID of the build.

Result Syntax

Result Details

Members

build

Information about the build.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

StopBuildBatch

result=result = result=client->stopBuildBatch([/* ... /]); promise=promise = promise=client->stopBuildBatchAsync([/ ... */]);

Stops a running batch build.

Parameter Syntax

result=result = result=client->stopBuildBatch([ 'id' => '', // REQUIRED ]);

Parameter Details

Members

Required: Yes

Type: string

The identifier of the batch build to stop.

Result Syntax

Result Details

Members

buildBatch

Type: BuildBatch structure

Contains information about a batch build.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

StopSandbox

result=result = result=client->stopSandbox([/* ... /]); promise=promise = promise=client->stopSandboxAsync([/ ... */]);

Stops a sandbox.

Parameter Syntax

result=result = result=client->stopSandbox([ 'id' => '', // REQUIRED ]);

Parameter Details

Members

Required: Yes

Type: string

Information about the requested sandbox ID.

Result Syntax

Result Details

Members

sandbox

Information about the requested sandbox.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

UpdateFleet

result=result = result=client->updateFleet([/* ... /]); promise=promise = promise=client->updateFleetAsync([/ ... */]);

Updates a compute fleet.

Parameter Syntax

result=result = result=client->updateFleet([ 'arn' => '', // REQUIRED 'baseCapacity' => , 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', 'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', 'fleetServiceRole' => '', 'imageId' => '', 'overflowBehavior' => 'QUEUE|ON_DEMAND', 'proxyConfiguration' => [ 'defaultBehavior' => 'ALLOW_ALL|DENY_ALL', 'orderedProxyRules' => [ [ 'effect' => 'ALLOW|DENY', // REQUIRED 'entities' => ['', ...], // REQUIRED 'type' => 'DOMAIN|IP', // REQUIRED ], // ... ], ], 'scalingConfiguration' => [ 'maxCapacity' => , 'scalingType' => 'TARGET_TRACKING_SCALING', 'targetTrackingScalingConfigs' => [ [ 'metricType' => 'FLEET_UTILIZATION_RATE', 'targetValue' => , ], // ... ], ], 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ]);

Parameter Details

Members

arn

Required: Yes

Type: string

The ARN of the compute fleet.

baseCapacity

The initial number of machines allocated to the compute ﬂeet, which deﬁnes the number of builds that can run in parallel.

computeConfiguration

Type: ComputeConfiguration structure

The compute configuration of the compute fleet. This is only required if computeType is set to ATTRIBUTE_BASED_COMPUTE.

computeType

Information about the compute resources the compute fleet uses. Available values include:

ATTRIBUTE_BASED_COMPUTE: Specify the amount of vCPUs, memory, disk space, and the type of machine.
If you use ATTRIBUTE_BASED_COMPUTE, you must define your attributes by using computeConfiguration. CodeBuild will select the cheapest instance that satisfies your specified attributes. For more information, see Reserved capacity environment types in the CodeBuild User Guide.
BUILD_GENERAL1_SMALL: Use up to 4 GiB memory and 2 vCPUs for builds.
BUILD_GENERAL1_MEDIUM: Use up to 8 GiB memory and 4 vCPUs for builds.
BUILD_GENERAL1_LARGE: Use up to 16 GiB memory and 8 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_XLARGE: Use up to 72 GiB memory and 36 vCPUs for builds, depending on your environment type.
BUILD_GENERAL1_2XLARGE: Use up to 144 GiB memory, 72 vCPUs, and 824 GB of SSD storage for builds. This compute type supports Docker images up to 100 GB uncompressed.
BUILD_LAMBDA_1GB: Use up to 1 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_2GB: Use up to 2 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_4GB: Use up to 4 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_8GB: Use up to 8 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.
BUILD_LAMBDA_10GB: Use up to 10 GiB memory for builds. Only available for environment type LINUX_LAMBDA_CONTAINER and ARM_LAMBDA_CONTAINER.

If you use BUILD_GENERAL1_SMALL:

For environment type LINUX_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 16 GiB memory, 4 vCPUs, and 1 NVIDIA A10G Tensor Core GPU for builds.
For environment type ARM_CONTAINER, you can use up to 4 GiB memory and 2 vCPUs on ARM-based processors for builds.

If you use BUILD_GENERAL1_LARGE:

For environment type LINUX_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs for builds.
For environment type LINUX_GPU_CONTAINER, you can use up to 255 GiB memory, 32 vCPUs, and 4 NVIDIA Tesla V100 GPUs for builds.
For environment type ARM_CONTAINER, you can use up to 16 GiB memory and 8 vCPUs on ARM-based processors for builds.

For more information, see On-demand environment types in the CodeBuild User Guide.

environmentType

The environment type of the compute fleet.

The environment type ARM_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), Asia Pacific (Mumbai), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), EU (Frankfurt), and South America (São Paulo).
The environment type ARM_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type LINUX_GPU_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), and Asia Pacific (Sydney).
The environment type MAC_ARM is available for Medium fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), and EU (Frankfurt)
The environment type MAC_ARM is available for Large fleets only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), and Asia Pacific (Sydney).
The environment type WINDOWS_EC2 is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Tokyo), Asia Pacific (Singapore), Asia Pacific (Sydney), South America (São Paulo), and Asia Pacific (Mumbai).
The environment type WINDOWS_SERVER_2019_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), Asia Pacific (Sydney), Asia Pacific (Tokyo), Asia Pacific (Mumbai) and EU (Ireland).
The environment type WINDOWS_SERVER_2022_CONTAINER is available only in regions US East (N. Virginia), US East (Ohio), US West (Oregon), EU (Ireland), EU (Frankfurt), Asia Pacific (Sydney), Asia Pacific (Singapore), Asia Pacific (Tokyo), South America (São Paulo) and Asia Pacific (Mumbai).

For more information, see Build environment compute types in the CodeBuild user guide.

fleetServiceRole

imageId

The Amazon Machine Image (AMI) of the compute fleet.

overflowBehavior

The compute fleet overflow behavior.

For overflow behavior QUEUE, your overflow builds need to wait on the existing fleet instance to become available.
For overflow behavior ON_DEMAND, your overflow builds run on CodeBuild on-demand.
If you choose to set your overflow behavior to on-demand while creating a VPC-connected fleet, make sure that you add the required VPC permissions to your project service role. For more information, see Example policy statement to allow CodeBuild access to Amazon Web Services services required to create a VPC network interface.

proxyConfiguration

Type: ProxyConfiguration structure

The proxy configuration of the compute fleet.

scalingConfiguration

Type: ScalingConfigurationInput structure

The scaling configuration of the compute fleet.

tags

Type: Array of Tag structures

A list of tag key and value pairs associated with this compute fleet.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

vpcConfig

Type: VpcConfig structure

Information about the VPC configuration that CodeBuild accesses.

Result Syntax

Result Details

Members

fleet

A Fleet object.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

An Amazon Web Services service limit was exceeded for the calling Amazon Web Services account.

UpdateProject

result=result = result=client->updateProject([/* ... /]); promise=promise = promise=client->updateProjectAsync([/ ... */]);

Changes the settings of a build project.

Parameter Syntax

result=result = result=client->updateProject([ 'artifacts' => [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], 'autoRetryLimit' => , 'badgeEnabled' => true || false, 'buildBatchConfig' => [ 'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH', 'combineArtifacts' => true || false, 'restrictions' => [ 'computeTypesAllowed' => ['', ...], 'fleetsAllowed' => ['', ...], 'maximumBuildsAllowed' => , ], 'serviceRole' => '', 'timeoutInMins' => , ], 'cache' => [ 'cacheNamespace' => '', 'location' => '', 'modes' => ['', ...], 'type' => 'NO_CACHE|S3|LOCAL', // REQUIRED ], 'concurrentBuildLimit' => , 'description' => '', 'encryptionKey' => '', 'environment' => [ 'certificate' => '', 'computeConfiguration' => [ 'disk' => , 'instanceType' => '', 'machineType' => 'GENERAL|NVME', 'memory' => , 'vCpu' => , ], 'computeType' => 'BUILD_GENERAL1_SMALL|BUILD_GENERAL1_MEDIUM|BUILD_GENERAL1_LARGE|BUILD_GENERAL1_XLARGE|BUILD_GENERAL1_2XLARGE|BUILD_LAMBDA_1GB|BUILD_LAMBDA_2GB|BUILD_LAMBDA_4GB|BUILD_LAMBDA_8GB|BUILD_LAMBDA_10GB|ATTRIBUTE_BASED_COMPUTE|CUSTOM_INSTANCE_TYPE', // REQUIRED 'environmentVariables' => [ [ 'name' => '', // REQUIRED 'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER', 'value' => '', // REQUIRED ], // ... ], 'fleet' => [ 'fleetArn' => '', ], 'image' => '', // REQUIRED 'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE', 'privilegedMode' => true || false, 'registryCredential' => [ 'credential' => '', // REQUIRED 'credentialProvider' => 'SECRETS_MANAGER', // REQUIRED ], 'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|WINDOWS_SERVER_2022_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|LINUX_EC2|ARM_EC2|WINDOWS_EC2|MAC_ARM', // REQUIRED ], 'fileSystemLocations' => [ [ 'identifier' => '', 'location' => '', 'mountOptions' => '', 'mountPoint' => '', 'type' => 'EFS', ], // ... ], 'logsConfig' => [ 'cloudWatchLogs' => [ 'groupName' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED 'streamName' => '', ], 's3Logs' => [ 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'status' => 'ENABLED|DISABLED', // REQUIRED ], ], 'name' => '', // REQUIRED 'queuedTimeoutInMinutes' => , 'secondaryArtifacts' => [ [ 'artifactIdentifier' => '', 'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL', 'encryptionDisabled' => true || false, 'location' => '', 'name' => '', 'namespaceType' => 'NONE|BUILD_ID', 'overrideArtifactName' => true || false, 'packaging' => 'NONE|ZIP', 'path' => '', 'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED ], // ... ], 'secondarySourceVersions' => [ [ 'sourceIdentifier' => '', // REQUIRED 'sourceVersion' => '', // REQUIRED ], // ... ], 'secondarySources' => [ [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED ], // ... ], 'serviceRole' => '', 'source' => [ 'auth' => [ 'resource' => '', 'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED ], 'buildStatusConfig' => [ 'context' => '', 'targetUrl' => '', ], 'buildspec' => '', 'gitCloneDepth' => , 'gitSubmodulesConfig' => [ 'fetchSubmodules' => true || false, // REQUIRED ], 'insecureSsl' => true || false, 'location' => '', 'reportBuildStatus' => true || false, 'sourceIdentifier' => '', 'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED ], 'sourceVersion' => '', 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], 'timeoutInMinutes' => , 'vpcConfig' => [ 'securityGroupIds' => ['', ...], 'subnets' => ['', ...], 'vpcId' => '', ], ]);

Parameter Details

Members

artifacts

Type: ProjectArtifacts structure

Information to be changed about the build output artifacts for the build project.

autoRetryLimit

badgeEnabled

Set this to true to generate a publicly accessible URL for your project's build badge.

buildBatchConfig

Type: ProjectBuildBatchConfig structure

Contains configuration information about a batch build project.

cache

Type: ProjectCache structure

Stores recently used information so that it can be quickly accessed at a later time.

concurrentBuildLimit

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

description

A new or replacement description of the build project.

encryptionKey

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

environment

Type: ProjectEnvironment structure

Information to be changed about the build environment for the build project.

fileSystemLocations

Type: Array of ProjectFileSystemLocation structures

logsConfig

Type: LogsConfig structure

Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

name

Required: Yes

Type: string

The name of the build project.

You cannot change a build project's name.

queuedTimeoutInMinutes

The number of minutes a build is allowed to be queued before it times out.

secondaryArtifacts

Type: Array of ProjectArtifacts structures

An array of ProjectArtifact objects.

secondarySourceVersions

Type: Array of ProjectSourceVersion structures

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

secondarySources

Type: Array of ProjectSource structures

An array of ProjectSource objects.

serviceRole

The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

source

Type: ProjectSource structure

Information to be changed about the build input source code for the build project.

sourceVersion

A version of the build input to be built for this project. If not specified, the latest version is used. If specified, it must be one of:

For CodeCommit: the commit ID, branch, or Git tag to use.
For GitHub: the commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For GitLab: the commit ID, branch, or Git tag to use.
For Bitbucket: the commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.
For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

tags

Type: Array of Tag structures

An updated list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

timeoutInMinutes

The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

vpcConfig

Type: VpcConfig structure

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

Result Syntax

Result Details

Members

project

Information about the build project that was changed.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

UpdateProjectVisibility

result=result = result=client->updateProjectVisibility([/* ... /]); promise=promise = promise=client->updateProjectVisibilityAsync([/ ... */]);

Changes the public visibility for a project. The project's build results, logs, and artifacts are available to the general public. For more information, see Public build projects in the CodeBuild User Guide.

The following should be kept in mind when making your projects public:

All of a project's build results, logs, and artifacts, including builds that were run when the project was private, are available to the general public.
All build logs and artifacts are available to the public. Environment variables, source code, and other sensitive information may have been output to the build logs and artifacts. You must be careful about what information is output to the build logs. Some best practice are:
- Do not store sensitive values in environment variables. We recommend that you use an Amazon EC2 Systems Manager Parameter Store or Secrets Manager to store sensitive values.
- Follow Best practices for using webhooks in the CodeBuild User Guide to limit which entities can trigger a build, and do not store the buildspec in the project itself, to ensure that your webhooks are as secure as possible.
A malicious user can use public builds to distribute malicious artifacts. We recommend that you review all pull requests to verify that the pull request is a legitimate change. We also recommend that you validate any artifacts with their checksums to make sure that the correct artifacts are being downloaded.

Parameter Syntax

result=result = result=client->updateProjectVisibility([ 'projectArn' => '', // REQUIRED 'projectVisibility' => 'PUBLIC_READ|PRIVATE', // REQUIRED 'resourceAccessRole' => '', ]);

Parameter Details

Members

projectArn

Required: Yes

Type: string

The Amazon Resource Name (ARN) of the build project.

projectVisibility

Required: Yes

Type: string

Specifies the visibility of the project's builds. Possible values are:

PUBLIC_READ

The project builds are visible to the public.

PRIVATE

The project builds are not visible to the public.

resourceAccessRole

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

Result Syntax

[ 'projectArn' => '', 'projectVisibility' => 'PUBLIC_READ|PRIVATE', 'publicProjectAlias' => '', ]

Result Details

Members

projectArn

The Amazon Resource Name (ARN) of the build project.

projectVisibility

Specifies the visibility of the project's builds. Possible values are:

PUBLIC_READ

The project builds are visible to the public.

PRIVATE

The project builds are not visible to the public.

publicProjectAlias

Contains the project identifier used with the public build APIs.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

UpdateReportGroup

result=result = result=client->updateReportGroup([/* ... /]); promise=promise = promise=client->updateReportGroupAsync([/ ... */]);

Updates a report group.

Parameter Syntax

result=result = result=client->updateReportGroup([ 'arn' => '', // REQUIRED 'exportConfig' => [ 'exportConfigType' => 'S3|NO_EXPORT', 's3Destination' => [ 'bucket' => '', 'bucketOwner' => '', 'encryptionDisabled' => true || false, 'encryptionKey' => '', 'packaging' => 'ZIP|NONE', 'path' => '', ], ], 'tags' => [ [ 'key' => '', 'value' => '', ], // ... ], ]);

Parameter Details

Members

arn

Required: Yes

Type: string

The ARN of the report group to update.

exportConfig

Type: ReportExportConfig structure

Used to specify an updated export type. Valid values are:

S3: The report results are exported to an S3 bucket.
NO_EXPORT: The report results are not exported.

tags

Type: Array of Tag structures

An updated list of tag key and value pairs associated with this report group.

These tags are available for use by Amazon Web Services services that support CodeBuild report group tags.

Result Syntax

Result Details

Members

reportGroup

Type: ReportGroup structure

Information about the updated report group.

Errors

The input value that was provided is not valid.

The specified Amazon Web Services resource cannot be found.

UpdateWebhook

result=result = result=client->updateWebhook([/* ... /]); promise=promise = promise=client->updateWebhookAsync([/ ... */]);

Updates the webhook associated with an CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

Parameter Syntax

result=result = result=client->updateWebhook([ 'branchFilter' => '', 'buildType' => 'BUILD|BUILD_BATCH|RUNNER_BUILDKITE_BUILD', 'filterGroups' => [ [ [ 'excludeMatchedPattern' => true || false, 'pattern' => '', // REQUIRED 'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME|ORGANIZATION_NAME', // REQUIRED ], // ... ], // ... ], 'projectName' => '', // REQUIRED 'rotateSecret' => true || false, ]);

Parameter Details

Members

branchFilter

It is recommended that you use filterGroups instead of branchFilter.

buildType

Specifies the type of build this webhook will trigger.

filterGroups

Type: Array of WebhookFilter structuress

An array of arrays of WebhookFilter objects used to determine if a webhook event can trigger a build. A filter group must contain at least one EVENT WebhookFilter.

projectName

Required: Yes

Type: string

The name of the CodeBuild project.

rotateSecret

A boolean value that specifies whether the associated GitHub repository's secret token should be updated. If you use Bitbucket for your repository, rotateSecret is ignored.

Result Syntax

Result Details

Members

webhook

Information about a repository's webhook that is associated with a project in CodeBuild.

Errors

The input value that was provided is not valid.