BatchDeleteBuilds

$result = $client->batchDeleteBuilds([/* ... */]);
$promise = $client->batchDeleteBuildsAsync([/* ... */]);

Deletes one or more builds.

Parameter Syntax

$result = $client->batchDeleteBuilds([
    'ids' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

BatchGetBuildBatches

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

Retrieves information about one or more batch builds.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

BatchGetBuilds

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

Gets information about one or more builds.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'builds' => [
        [
            'arn' => '<string>',
            'artifacts' => [
                'artifactIdentifier' => '<string>',
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'md5sum' => '<string>',
                'overrideArtifactName' => true || false,
                'sha256sum' => '<string>',
            ],
            'autoRetryConfig' => [
                'autoRetryLimit' => <integer>,
                'autoRetryNumber' => <integer>,
                'nextAutoRetry' => '<string>',
                'previousAutoRetry' => '<string>',
            ],
            'buildBatchArn' => '<string>',
            'buildComplete' => true || false,
            'buildNumber' => <integer>,
            'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED',
            'cache' => [
                'location' => '<string>',
                'modes' => ['<string>', ...],
                'type' => 'NO_CACHE|S3|LOCAL',
            ],
            'currentPhase' => '<string>',
            'debugSession' => [
                'sessionEnabled' => true || false,
                'sessionTarget' => '<string>',
            ],
            'encryptionKey' => '<string>',
            'endTime' => <DateTime>,
            'environment' => [
                'certificate' => '<string>',
                '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',
                'environmentVariables' => [
                    [
                        'name' => '<string>',
                        'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'fleet' => [
                    'fleetArn' => '<string>',
                ],
                'image' => '<string>',
                'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
                'privilegedMode' => true || false,
                'registryCredential' => [
                    'credential' => '<string>',
                    'credentialProvider' => 'SECRETS_MANAGER',
                ],
                'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
            ],
            'exportedEnvironmentVariables' => [
                [
                    'name' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'fileSystemLocations' => [
                [
                    'identifier' => '<string>',
                    'location' => '<string>',
                    'mountOptions' => '<string>',
                    'mountPoint' => '<string>',
                    'type' => 'EFS',
                ],
                // ...
            ],
            'id' => '<string>',
            'initiator' => '<string>',
            'logs' => [
                'cloudWatchLogs' => [
                    'groupName' => '<string>',
                    'status' => 'ENABLED|DISABLED',
                    'streamName' => '<string>',
                ],
                'cloudWatchLogsArn' => '<string>',
                'deepLink' => '<string>',
                'groupName' => '<string>',
                's3DeepLink' => '<string>',
                's3Logs' => [
                    'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                    'encryptionDisabled' => true || false,
                    'location' => '<string>',
                    'status' => 'ENABLED|DISABLED',
                ],
                's3LogsArn' => '<string>',
                'streamName' => '<string>',
            ],
            'networkInterface' => [
                'networkInterfaceId' => '<string>',
                'subnetId' => '<string>',
            ],
            'phases' => [
                [
                    'contexts' => [
                        [
                            'message' => '<string>',
                            'statusCode' => '<string>',
                        ],
                        // ...
                    ],
                    'durationInSeconds' => <integer>,
                    'endTime' => <DateTime>,
                    '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' => <DateTime>,
                ],
                // ...
            ],
            'projectName' => '<string>',
            'queuedTimeoutInMinutes' => <integer>,
            'reportArns' => ['<string>', ...],
            'resolvedSourceVersion' => '<string>',
            'secondaryArtifacts' => [
                [
                    'artifactIdentifier' => '<string>',
                    'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                    'encryptionDisabled' => true || false,
                    'location' => '<string>',
                    'md5sum' => '<string>',
                    'overrideArtifactName' => true || false,
                    'sha256sum' => '<string>',
                ],
                // ...
            ],
            'secondarySourceVersions' => [
                [
                    'sourceIdentifier' => '<string>',
                    'sourceVersion' => '<string>',
                ],
                // ...
            ],
            'secondarySources' => [
                [
                    'auth' => [
                        'resource' => '<string>',
                        'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                    ],
                    'buildStatusConfig' => [
                        'context' => '<string>',
                        'targetUrl' => '<string>',
                    ],
                    'buildspec' => '<string>',
                    'gitCloneDepth' => <integer>,
                    'gitSubmodulesConfig' => [
                        'fetchSubmodules' => true || false,
                    ],
                    'insecureSsl' => true || false,
                    'location' => '<string>',
                    'reportBuildStatus' => true || false,
                    'sourceIdentifier' => '<string>',
                    'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
                ],
                // ...
            ],
            'serviceRole' => '<string>',
            'source' => [
                'auth' => [
                    'resource' => '<string>',
                    'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                ],
                'buildStatusConfig' => [
                    'context' => '<string>',
                    'targetUrl' => '<string>',
                ],
                'buildspec' => '<string>',
                'gitCloneDepth' => <integer>,
                'gitSubmodulesConfig' => [
                    'fetchSubmodules' => true || false,
                ],
                'insecureSsl' => true || false,
                'location' => '<string>',
                'reportBuildStatus' => true || false,
                'sourceIdentifier' => '<string>',
                'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
            ],
            'sourceVersion' => '<string>',
            'startTime' => <DateTime>,
            'timeoutInMinutes' => <integer>,
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnets' => ['<string>', ...],
                'vpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'buildsNotFound' => ['<string>', ...],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

BatchGetFleets

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

Gets information about one or more compute fleets.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'fleets' => [
        [
            'arn' => '<string>',
            'baseCapacity' => <integer>,
            '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',
            'created' => <DateTime>,
            'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
            'fleetServiceRole' => '<string>',
            'id' => '<string>',
            'imageId' => '<string>',
            'lastModified' => <DateTime>,
            'name' => '<string>',
            'overflowBehavior' => 'QUEUE|ON_DEMAND',
            'proxyConfiguration' => [
                'defaultBehavior' => 'ALLOW_ALL|DENY_ALL',
                'orderedProxyRules' => [
                    [
                        'effect' => 'ALLOW|DENY',
                        'entities' => ['<string>', ...],
                        'type' => 'DOMAIN|IP',
                    ],
                    // ...
                ],
            ],
            'scalingConfiguration' => [
                'desiredCapacity' => <integer>,
                'maxCapacity' => <integer>,
                'scalingType' => 'TARGET_TRACKING_SCALING',
                'targetTrackingScalingConfigs' => [
                    [
                        'metricType' => 'FLEET_UTILIZATION_RATE',
                        'targetValue' => <float>,
                    ],
                    // ...
                ],
            ],
            'status' => [
                'context' => 'CREATE_FAILED|UPDATE_FAILED|ACTION_REQUIRED|PENDING_DELETION|INSUFFICIENT_CAPACITY',
                'message' => '<string>',
                'statusCode' => 'CREATING|UPDATING|ROTATING|PENDING_DELETION|DELETING|CREATE_FAILED|UPDATE_ROLLBACK_FAILED|ACTIVE',
            ],
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnets' => ['<string>', ...],
                'vpcId' => '<string>',
            ],
        ],
        // ...
    ],
    'fleetsNotFound' => ['<string>', ...],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

BatchGetProjects

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

Gets information about one or more build projects.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'projects' => [
        [
            'arn' => '<string>',
            'artifacts' => [
                'artifactIdentifier' => '<string>',
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'name' => '<string>',
                'namespaceType' => 'NONE|BUILD_ID',
                'overrideArtifactName' => true || false,
                'packaging' => 'NONE|ZIP',
                'path' => '<string>',
                'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS',
            ],
            'autoRetryLimit' => <integer>,
            'badge' => [
                'badgeEnabled' => true || false,
                'badgeRequestUrl' => '<string>',
            ],
            'buildBatchConfig' => [
                'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH',
                'combineArtifacts' => true || false,
                'restrictions' => [
                    'computeTypesAllowed' => ['<string>', ...],
                    'maximumBuildsAllowed' => <integer>,
                ],
                'serviceRole' => '<string>',
                'timeoutInMins' => <integer>,
            ],
            'cache' => [
                'location' => '<string>',
                'modes' => ['<string>', ...],
                'type' => 'NO_CACHE|S3|LOCAL',
            ],
            'concurrentBuildLimit' => <integer>,
            'created' => <DateTime>,
            'description' => '<string>',
            'encryptionKey' => '<string>',
            'environment' => [
                'certificate' => '<string>',
                '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',
                'environmentVariables' => [
                    [
                        'name' => '<string>',
                        'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'fleet' => [
                    'fleetArn' => '<string>',
                ],
                'image' => '<string>',
                'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
                'privilegedMode' => true || false,
                'registryCredential' => [
                    'credential' => '<string>',
                    'credentialProvider' => 'SECRETS_MANAGER',
                ],
                'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
            ],
            'fileSystemLocations' => [
                [
                    'identifier' => '<string>',
                    'location' => '<string>',
                    'mountOptions' => '<string>',
                    'mountPoint' => '<string>',
                    'type' => 'EFS',
                ],
                // ...
            ],
            'lastModified' => <DateTime>,
            'logsConfig' => [
                'cloudWatchLogs' => [
                    'groupName' => '<string>',
                    'status' => 'ENABLED|DISABLED',
                    'streamName' => '<string>',
                ],
                's3Logs' => [
                    'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                    'encryptionDisabled' => true || false,
                    'location' => '<string>',
                    'status' => 'ENABLED|DISABLED',
                ],
            ],
            'name' => '<string>',
            'projectVisibility' => 'PUBLIC_READ|PRIVATE',
            'publicProjectAlias' => '<string>',
            'queuedTimeoutInMinutes' => <integer>,
            'resourceAccessRole' => '<string>',
            'secondaryArtifacts' => [
                [
                    'artifactIdentifier' => '<string>',
                    'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                    'encryptionDisabled' => true || false,
                    'location' => '<string>',
                    'name' => '<string>',
                    'namespaceType' => 'NONE|BUILD_ID',
                    'overrideArtifactName' => true || false,
                    'packaging' => 'NONE|ZIP',
                    'path' => '<string>',
                    'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS',
                ],
                // ...
            ],
            'secondarySourceVersions' => [
                [
                    'sourceIdentifier' => '<string>',
                    'sourceVersion' => '<string>',
                ],
                // ...
            ],
            'secondarySources' => [
                [
                    'auth' => [
                        'resource' => '<string>',
                        'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                    ],
                    'buildStatusConfig' => [
                        'context' => '<string>',
                        'targetUrl' => '<string>',
                    ],
                    'buildspec' => '<string>',
                    'gitCloneDepth' => <integer>,
                    'gitSubmodulesConfig' => [
                        'fetchSubmodules' => true || false,
                    ],
                    'insecureSsl' => true || false,
                    'location' => '<string>',
                    'reportBuildStatus' => true || false,
                    'sourceIdentifier' => '<string>',
                    'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
                ],
                // ...
            ],
            'serviceRole' => '<string>',
            'source' => [
                'auth' => [
                    'resource' => '<string>',
                    'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                ],
                'buildStatusConfig' => [
                    'context' => '<string>',
                    'targetUrl' => '<string>',
                ],
                'buildspec' => '<string>',
                'gitCloneDepth' => <integer>,
                'gitSubmodulesConfig' => [
                    'fetchSubmodules' => true || false,
                ],
                'insecureSsl' => true || false,
                'location' => '<string>',
                'reportBuildStatus' => true || false,
                'sourceIdentifier' => '<string>',
                'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
            ],
            'sourceVersion' => '<string>',
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'timeoutInMinutes' => <integer>,
            'vpcConfig' => [
                'securityGroupIds' => ['<string>', ...],
                'subnets' => ['<string>', ...],
                'vpcId' => '<string>',
            ],
            'webhook' => [
                'branchFilter' => '<string>',
                'buildType' => 'BUILD|BUILD_BATCH',
                'filterGroups' => [
                    [
                        [
                            'excludeMatchedPattern' => true || false,
                            'pattern' => '<string>',
                            'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME',
                        ],
                        // ...
                    ],
                    // ...
                ],
                'lastModifiedSecret' => <DateTime>,
                'manualCreation' => true || false,
                'payloadUrl' => '<string>',
                'scopeConfiguration' => [
                    'domain' => '<string>',
                    'name' => '<string>',
                    'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP',
                ],
                'secret' => '<string>',
                'url' => '<string>',
            ],
        ],
        // ...
    ],
    'projectsNotFound' => ['<string>', ...],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

BatchGetReportGroups

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

Returns an array of report groups.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

BatchGetReports

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

Returns an array of reports.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

CreateFleet

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

Creates a compute fleet.

Parameter Syntax

$result = $client->createFleet([
    'baseCapacity' => <integer>, // REQUIRED
    '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', // REQUIRED
    'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM', // REQUIRED
    'fleetServiceRole' => '<string>',
    'imageId' => '<string>',
    'name' => '<string>', // REQUIRED
    'overflowBehavior' => 'QUEUE|ON_DEMAND',
    'proxyConfiguration' => [
        'defaultBehavior' => 'ALLOW_ALL|DENY_ALL',
        'orderedProxyRules' => [
            [
                'effect' => 'ALLOW|DENY', // REQUIRED
                'entities' => ['<string>', ...], // REQUIRED
                'type' => 'DOMAIN|IP', // REQUIRED
            ],
            // ...
        ],
    ],
    'scalingConfiguration' => [
        'maxCapacity' => <integer>,
        'scalingType' => 'TARGET_TRACKING_SCALING',
        'targetTrackingScalingConfigs' => [
            [
                'metricType' => 'FLEET_UTILIZATION_RATE',
                'targetValue' => <float>,
            ],
            // ...
        ],
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...],
        'subnets' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'fleet' => [
        'arn' => '<string>',
        'baseCapacity' => <integer>,
        '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',
        'created' => <DateTime>,
        'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
        'fleetServiceRole' => '<string>',
        'id' => '<string>',
        'imageId' => '<string>',
        'lastModified' => <DateTime>,
        'name' => '<string>',
        'overflowBehavior' => 'QUEUE|ON_DEMAND',
        'proxyConfiguration' => [
            'defaultBehavior' => 'ALLOW_ALL|DENY_ALL',
            'orderedProxyRules' => [
                [
                    'effect' => 'ALLOW|DENY',
                    'entities' => ['<string>', ...],
                    'type' => 'DOMAIN|IP',
                ],
                // ...
            ],
        ],
        'scalingConfiguration' => [
            'desiredCapacity' => <integer>,
            'maxCapacity' => <integer>,
            'scalingType' => 'TARGET_TRACKING_SCALING',
            'targetTrackingScalingConfigs' => [
                [
                    'metricType' => 'FLEET_UTILIZATION_RATE',
                    'targetValue' => <float>,
                ],
                // ...
            ],
        ],
        'status' => [
            'context' => 'CREATE_FAILED|UPDATE_FAILED|ACTION_REQUIRED|PENDING_DELETION|INSUFFICIENT_CAPACITY',
            'message' => '<string>',
            'statusCode' => 'CREATING|UPDATING|ROTATING|PENDING_DELETION|DELETING|CREATE_FAILED|UPDATE_ROLLBACK_FAILED|ACTIVE',
        ],
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnets' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceAlreadyExistsException:

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

AccountLimitExceededException:

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

CreateProject

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

Creates a build project.

Parameter Syntax

$result = $client->createProject([
    'artifacts' => [ // REQUIRED
        'artifactIdentifier' => '<string>',
        'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
        'encryptionDisabled' => true || false,
        'location' => '<string>',
        'name' => '<string>',
        'namespaceType' => 'NONE|BUILD_ID',
        'overrideArtifactName' => true || false,
        'packaging' => 'NONE|ZIP',
        'path' => '<string>',
        'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED
    ],
    'autoRetryLimit' => <integer>,
    'badgeEnabled' => true || false,
    'buildBatchConfig' => [
        'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH',
        'combineArtifacts' => true || false,
        'restrictions' => [
            'computeTypesAllowed' => ['<string>', ...],
            'maximumBuildsAllowed' => <integer>,
        ],
        'serviceRole' => '<string>',
        'timeoutInMins' => <integer>,
    ],
    'cache' => [
        'location' => '<string>',
        'modes' => ['<string>', ...],
        'type' => 'NO_CACHE|S3|LOCAL', // REQUIRED
    ],
    'concurrentBuildLimit' => <integer>,
    'description' => '<string>',
    'encryptionKey' => '<string>',
    'environment' => [ // REQUIRED
        'certificate' => '<string>',
        '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', // REQUIRED
        'environmentVariables' => [
            [
                'name' => '<string>', // REQUIRED
                'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'fleet' => [
            'fleetArn' => '<string>',
        ],
        'image' => '<string>', // REQUIRED
        'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
        'privilegedMode' => true || false,
        'registryCredential' => [
            'credential' => '<string>', // REQUIRED
            'credentialProvider' => 'SECRETS_MANAGER', // REQUIRED
        ],
        'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM', // REQUIRED
    ],
    'fileSystemLocations' => [
        [
            'identifier' => '<string>',
            'location' => '<string>',
            'mountOptions' => '<string>',
            'mountPoint' => '<string>',
            'type' => 'EFS',
        ],
        // ...
    ],
    'logsConfig' => [
        'cloudWatchLogs' => [
            'groupName' => '<string>',
            'status' => 'ENABLED|DISABLED', // REQUIRED
            'streamName' => '<string>',
        ],
        's3Logs' => [
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'status' => 'ENABLED|DISABLED', // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
    'queuedTimeoutInMinutes' => <integer>,
    'secondaryArtifacts' => [
        [
            'artifactIdentifier' => '<string>',
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'name' => '<string>',
            'namespaceType' => 'NONE|BUILD_ID',
            'overrideArtifactName' => true || false,
            'packaging' => 'NONE|ZIP',
            'path' => '<string>',
            'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED
        ],
        // ...
    ],
    'secondarySourceVersions' => [
        [
            'sourceIdentifier' => '<string>', // REQUIRED
            'sourceVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'secondarySources' => [
        [
            'auth' => [
                'resource' => '<string>',
                'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED
            ],
            'buildStatusConfig' => [
                'context' => '<string>',
                'targetUrl' => '<string>',
            ],
            'buildspec' => '<string>',
            'gitCloneDepth' => <integer>,
            'gitSubmodulesConfig' => [
                'fetchSubmodules' => true || false, // REQUIRED
            ],
            'insecureSsl' => true || false,
            'location' => '<string>',
            'reportBuildStatus' => true || false,
            'sourceIdentifier' => '<string>',
            'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED
        ],
        // ...
    ],
    'serviceRole' => '<string>', // REQUIRED
    'source' => [ // REQUIRED
        'auth' => [
            'resource' => '<string>',
            'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED
        ],
        'buildStatusConfig' => [
            'context' => '<string>',
            'targetUrl' => '<string>',
        ],
        'buildspec' => '<string>',
        'gitCloneDepth' => <integer>,
        'gitSubmodulesConfig' => [
            'fetchSubmodules' => true || false, // REQUIRED
        ],
        'insecureSsl' => true || false,
        'location' => '<string>',
        'reportBuildStatus' => true || false,
        'sourceIdentifier' => '<string>',
        'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED
    ],
    'sourceVersion' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'timeoutInMinutes' => <integer>,
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...],
        'subnets' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'artifacts' => [
            'artifactIdentifier' => '<string>',
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'name' => '<string>',
            'namespaceType' => 'NONE|BUILD_ID',
            'overrideArtifactName' => true || false,
            'packaging' => 'NONE|ZIP',
            'path' => '<string>',
            'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS',
        ],
        'autoRetryLimit' => <integer>,
        'badge' => [
            'badgeEnabled' => true || false,
            'badgeRequestUrl' => '<string>',
        ],
        'buildBatchConfig' => [
            'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH',
            'combineArtifacts' => true || false,
            'restrictions' => [
                'computeTypesAllowed' => ['<string>', ...],
                'maximumBuildsAllowed' => <integer>,
            ],
            'serviceRole' => '<string>',
            'timeoutInMins' => <integer>,
        ],
        'cache' => [
            'location' => '<string>',
            'modes' => ['<string>', ...],
            'type' => 'NO_CACHE|S3|LOCAL',
        ],
        'concurrentBuildLimit' => <integer>,
        'created' => <DateTime>,
        'description' => '<string>',
        'encryptionKey' => '<string>',
        'environment' => [
            'certificate' => '<string>',
            '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',
            'environmentVariables' => [
                [
                    'name' => '<string>',
                    'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                    'value' => '<string>',
                ],
                // ...
            ],
            'fleet' => [
                'fleetArn' => '<string>',
            ],
            'image' => '<string>',
            'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
            'privilegedMode' => true || false,
            'registryCredential' => [
                'credential' => '<string>',
                'credentialProvider' => 'SECRETS_MANAGER',
            ],
            'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
        ],
        'fileSystemLocations' => [
            [
                'identifier' => '<string>',
                'location' => '<string>',
                'mountOptions' => '<string>',
                'mountPoint' => '<string>',
                'type' => 'EFS',
            ],
            // ...
        ],
        'lastModified' => <DateTime>,
        'logsConfig' => [
            'cloudWatchLogs' => [
                'groupName' => '<string>',
                'status' => 'ENABLED|DISABLED',
                'streamName' => '<string>',
            ],
            's3Logs' => [
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'status' => 'ENABLED|DISABLED',
            ],
        ],
        'name' => '<string>',
        'projectVisibility' => 'PUBLIC_READ|PRIVATE',
        'publicProjectAlias' => '<string>',
        'queuedTimeoutInMinutes' => <integer>,
        'resourceAccessRole' => '<string>',
        'secondaryArtifacts' => [
            [
                'artifactIdentifier' => '<string>',
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'name' => '<string>',
                'namespaceType' => 'NONE|BUILD_ID',
                'overrideArtifactName' => true || false,
                'packaging' => 'NONE|ZIP',
                'path' => '<string>',
                'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS',
            ],
            // ...
        ],
        'secondarySourceVersions' => [
            [
                'sourceIdentifier' => '<string>',
                'sourceVersion' => '<string>',
            ],
            // ...
        ],
        'secondarySources' => [
            [
                'auth' => [
                    'resource' => '<string>',
                    'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                ],
                'buildStatusConfig' => [
                    'context' => '<string>',
                    'targetUrl' => '<string>',
                ],
                'buildspec' => '<string>',
                'gitCloneDepth' => <integer>,
                'gitSubmodulesConfig' => [
                    'fetchSubmodules' => true || false,
                ],
                'insecureSsl' => true || false,
                'location' => '<string>',
                'reportBuildStatus' => true || false,
                'sourceIdentifier' => '<string>',
                'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
            ],
            // ...
        ],
        'serviceRole' => '<string>',
        'source' => [
            'auth' => [
                'resource' => '<string>',
                'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
            ],
            'buildStatusConfig' => [
                'context' => '<string>',
                'targetUrl' => '<string>',
            ],
            'buildspec' => '<string>',
            'gitCloneDepth' => <integer>,
            'gitSubmodulesConfig' => [
                'fetchSubmodules' => true || false,
            ],
            'insecureSsl' => true || false,
            'location' => '<string>',
            'reportBuildStatus' => true || false,
            'sourceIdentifier' => '<string>',
            'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
        ],
        'sourceVersion' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'timeoutInMinutes' => <integer>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnets' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'webhook' => [
            'branchFilter' => '<string>',
            'buildType' => 'BUILD|BUILD_BATCH',
            'filterGroups' => [
                [
                    [
                        'excludeMatchedPattern' => true || false,
                        'pattern' => '<string>',
                        'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME',
                    ],
                    // ...
                ],
                // ...
            ],
            'lastModifiedSecret' => <DateTime>,
            'manualCreation' => true || false,
            'payloadUrl' => '<string>',
            'scopeConfiguration' => [
                'domain' => '<string>',
                'name' => '<string>',
                'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP',
            ],
            'secret' => '<string>',
            'url' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceAlreadyExistsException:

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

AccountLimitExceededException:

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

CreateReportGroup

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceAlreadyExistsException:

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

AccountLimitExceededException:

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

CreateWebhook

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

For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'webhook' => [
        'branchFilter' => '<string>',
        'buildType' => 'BUILD|BUILD_BATCH',
        'filterGroups' => [
            [
                [
                    'excludeMatchedPattern' => true || false,
                    'pattern' => '<string>',
                    'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME',
                ],
                // ...
            ],
            // ...
        ],
        'lastModifiedSecret' => <DateTime>,
        'manualCreation' => true || false,
        'payloadUrl' => '<string>',
        'scopeConfiguration' => [
            'domain' => '<string>',
            'name' => '<string>',
            'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP',
        ],
        'secret' => '<string>',
        'url' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

OAuthProviderException:

There was a problem with the underlying OAuth provider.

ResourceAlreadyExistsException:

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

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

DeleteBuildBatch

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

Deletes a batch build.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

DeleteFleet

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

DeleteProject

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

DeleteReport

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

Deletes a report.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

DeleteReportGroup

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

DeleteResourcePolicy

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

DeleteSourceCredentials

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

DeleteWebhook

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

For an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

OAuthProviderException:

There was a problem with the underlying OAuth provider.

DescribeCodeCoverages

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

Retrieves one or more code coverage reports.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

DescribeTestCases

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'testCases' => [
        [
            'durationInNanoSeconds' => <integer>,
            'expired' => <DateTime>,
            'message' => '<string>',
            'name' => '<string>',
            'prefix' => '<string>',
            'reportArn' => '<string>',
            'status' => '<string>',
            'testRawDataPath' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

GetReportGroupTrend

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

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

Parameter Syntax

$result = $client->getReportGroupTrend([
    'numOfReports' => <integer>,
    'reportGroupArn' => '<string>', // REQUIRED
    'trendField' => 'PASS_RATE|DURATION|TOTAL|LINE_COVERAGE|LINES_COVERED|LINES_MISSED|BRANCH_COVERAGE|BRANCHES_COVERED|BRANCHES_MISSED', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

GetResourcePolicy

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'policy' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

InvalidInputException:

The input value that was provided is not valid.

ImportSourceCredentials

$result = $client->importSourceCredentials([/* ... */]);
$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 = $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' => '<string>', // REQUIRED
    'username' => '<string>',
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

AccountLimitExceededException:

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

ResourceAlreadyExistsException:

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

InvalidateProjectCache

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

Resets the cache for a project.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

ListBuildBatches

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

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

Parameter Syntax

$result = $client->listBuildBatches([
    'filter' => [
        'status' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListBuildBatchesForProject

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

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

Parameter Syntax

$result = $client->listBuildBatchesForProject([
    'filter' => [
        'status' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'projectName' => '<string>',
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

ListBuilds

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListBuildsForProject

$result = $client->listBuildsForProject([/* ... */]);
$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 = $client->listBuildsForProject([
    'nextToken' => '<string>',
    'projectName' => '<string>', // REQUIRED
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

ListCuratedEnvironmentImages

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

Gets information about Docker images that are managed by CodeBuild.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'platforms' => [
        [
            'languages' => [
                [
                    'images' => [
                        [
                            'description' => '<string>',
                            'name' => '<string>',
                            'versions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'language' => 'JAVA|PYTHON|NODE_JS|RUBY|GOLANG|DOCKER|ANDROID|DOTNET|BASE|PHP',
                ],
                // ...
            ],
            'platform' => 'DEBIAN|AMAZON_LINUX|UBUNTU|WINDOWS_SERVER',
        ],
        // ...
    ],
]

Result Details

Errors

There are no errors described for this operation.

ListFleets

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListProjects

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListReportGroups

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListReports

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

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

Parameter Syntax

$result = $client->listReports([
    'filter' => [
        'status' => 'GENERATING|SUCCEEDED|FAILED|INCOMPLETE|DELETING',
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortOrder' => 'ASCENDING|DESCENDING',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListReportsForReportGroup

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

ListSharedProjects

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListSharedReportGroups

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ListSourceCredentials

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

Returns a list of SourceCredentialsInfo objects.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'sourceCredentialsInfos' => [
        [
            'arn' => '<string>',
            'authType' => 'OAUTH|BASIC_AUTH|PERSONAL_ACCESS_TOKEN|CODECONNECTIONS|SECRETS_MANAGER',
            'resource' => '<string>',
            'serverType' => 'GITHUB|BITBUCKET|GITHUB_ENTERPRISE|GITLAB|GITLAB_SELF_MANAGED',
        ],
        // ...
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

PutResourcePolicy

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'resourceArn' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

InvalidInputException:

The input value that was provided is not valid.

RetryBuild

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

Restarts a build.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'build' => [
        'arn' => '<string>',
        'artifacts' => [
            'artifactIdentifier' => '<string>',
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'md5sum' => '<string>',
            'overrideArtifactName' => true || false,
            'sha256sum' => '<string>',
        ],
        'autoRetryConfig' => [
            'autoRetryLimit' => <integer>,
            'autoRetryNumber' => <integer>,
            'nextAutoRetry' => '<string>',
            'previousAutoRetry' => '<string>',
        ],
        'buildBatchArn' => '<string>',
        'buildComplete' => true || false,
        'buildNumber' => <integer>,
        'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED',
        'cache' => [
            'location' => '<string>',
            'modes' => ['<string>', ...],
            'type' => 'NO_CACHE|S3|LOCAL',
        ],
        'currentPhase' => '<string>',
        'debugSession' => [
            'sessionEnabled' => true || false,
            'sessionTarget' => '<string>',
        ],
        'encryptionKey' => '<string>',
        'endTime' => <DateTime>,
        'environment' => [
            'certificate' => '<string>',
            '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',
            'environmentVariables' => [
                [
                    'name' => '<string>',
                    'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                    'value' => '<string>',
                ],
                // ...
            ],
            'fleet' => [
                'fleetArn' => '<string>',
            ],
            'image' => '<string>',
            'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
            'privilegedMode' => true || false,
            'registryCredential' => [
                'credential' => '<string>',
                'credentialProvider' => 'SECRETS_MANAGER',
            ],
            'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
        ],
        'exportedEnvironmentVariables' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'fileSystemLocations' => [
            [
                'identifier' => '<string>',
                'location' => '<string>',
                'mountOptions' => '<string>',
                'mountPoint' => '<string>',
                'type' => 'EFS',
            ],
            // ...
        ],
        'id' => '<string>',
        'initiator' => '<string>',
        'logs' => [
            'cloudWatchLogs' => [
                'groupName' => '<string>',
                'status' => 'ENABLED|DISABLED',
                'streamName' => '<string>',
            ],
            'cloudWatchLogsArn' => '<string>',
            'deepLink' => '<string>',
            'groupName' => '<string>',
            's3DeepLink' => '<string>',
            's3Logs' => [
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'status' => 'ENABLED|DISABLED',
            ],
            's3LogsArn' => '<string>',
            'streamName' => '<string>',
        ],
        'networkInterface' => [
            'networkInterfaceId' => '<string>',
            'subnetId' => '<string>',
        ],
        'phases' => [
            [
                'contexts' => [
                    [
                        'message' => '<string>',
                        'statusCode' => '<string>',
                    ],
                    // ...
                ],
                'durationInSeconds' => <integer>,
                'endTime' => <DateTime>,
                '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' => <DateTime>,
            ],
            // ...
        ],
        'projectName' => '<string>',
        'queuedTimeoutInMinutes' => <integer>,
        'reportArns' => ['<string>', ...],
        'resolvedSourceVersion' => '<string>',
        'secondaryArtifacts' => [
            [
                'artifactIdentifier' => '<string>',
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'md5sum' => '<string>',
                'overrideArtifactName' => true || false,
                'sha256sum' => '<string>',
            ],
            // ...
        ],
        'secondarySourceVersions' => [
            [
                'sourceIdentifier' => '<string>',
                'sourceVersion' => '<string>',
            ],
            // ...
        ],
        'secondarySources' => [
            [
                'auth' => [
                    'resource' => '<string>',
                    'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                ],
                'buildStatusConfig' => [
                    'context' => '<string>',
                    'targetUrl' => '<string>',
                ],
                'buildspec' => '<string>',
                'gitCloneDepth' => <integer>,
                'gitSubmodulesConfig' => [
                    'fetchSubmodules' => true || false,
                ],
                'insecureSsl' => true || false,
                'location' => '<string>',
                'reportBuildStatus' => true || false,
                'sourceIdentifier' => '<string>',
                'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
            ],
            // ...
        ],
        'serviceRole' => '<string>',
        'source' => [
            'auth' => [
                'resource' => '<string>',
                'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
            ],
            'buildStatusConfig' => [
                'context' => '<string>',
                'targetUrl' => '<string>',
            ],
            'buildspec' => '<string>',
            'gitCloneDepth' => <integer>,
            'gitSubmodulesConfig' => [
                'fetchSubmodules' => true || false,
            ],
            'insecureSsl' => true || false,
            'location' => '<string>',
            'reportBuildStatus' => true || false,
            'sourceIdentifier' => '<string>',
            'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
        ],
        'sourceVersion' => '<string>',
        'startTime' => <DateTime>,
        'timeoutInMinutes' => <integer>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnets' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

AccountLimitExceededException:

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

RetryBuildBatch

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

StartBuild

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

Parameter Details

Result Syntax

[
    'build' => [
        'arn' => '<string>',
        'artifacts' => [
            'artifactIdentifier' => '<string>',
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'md5sum' => '<string>',
            'overrideArtifactName' => true || false,
            'sha256sum' => '<string>',
        ],
        'autoRetryConfig' => [
            'autoRetryLimit' => <integer>,
            'autoRetryNumber' => <integer>,
            'nextAutoRetry' => '<string>',
            'previousAutoRetry' => '<string>',
        ],
        'buildBatchArn' => '<string>',
        'buildComplete' => true || false,
        'buildNumber' => <integer>,
        'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED',
        'cache' => [
            'location' => '<string>',
            'modes' => ['<string>', ...],
            'type' => 'NO_CACHE|S3|LOCAL',
        ],
        'currentPhase' => '<string>',
        'debugSession' => [
            'sessionEnabled' => true || false,
            'sessionTarget' => '<string>',
        ],
        'encryptionKey' => '<string>',
        'endTime' => <DateTime>,
        'environment' => [
            'certificate' => '<string>',
            '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',
            'environmentVariables' => [
                [
                    'name' => '<string>',
                    'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                    'value' => '<string>',
                ],
                // ...
            ],
            'fleet' => [
                'fleetArn' => '<string>',
            ],
            'image' => '<string>',
            'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
            'privilegedMode' => true || false,
            'registryCredential' => [
                'credential' => '<string>',
                'credentialProvider' => 'SECRETS_MANAGER',
            ],
            'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
        ],
        'exportedEnvironmentVariables' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'fileSystemLocations' => [
            [
                'identifier' => '<string>',
                'location' => '<string>',
                'mountOptions' => '<string>',
                'mountPoint' => '<string>',
                'type' => 'EFS',
            ],
            // ...
        ],
        'id' => '<string>',
        'initiator' => '<string>',
        'logs' => [
            'cloudWatchLogs' => [
                'groupName' => '<string>',
                'status' => 'ENABLED|DISABLED',
                'streamName' => '<string>',
            ],
            'cloudWatchLogsArn' => '<string>',
            'deepLink' => '<string>',
            'groupName' => '<string>',
            's3DeepLink' => '<string>',
            's3Logs' => [
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'status' => 'ENABLED|DISABLED',
            ],
            's3LogsArn' => '<string>',
            'streamName' => '<string>',
        ],
        'networkInterface' => [
            'networkInterfaceId' => '<string>',
            'subnetId' => '<string>',
        ],
        'phases' => [
            [
                'contexts' => [
                    [
                        'message' => '<string>',
                        'statusCode' => '<string>',
                    ],
                    // ...
                ],
                'durationInSeconds' => <integer>,
                'endTime' => <DateTime>,
                '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' => <DateTime>,
            ],
            // ...
        ],
        'projectName' => '<string>',
        'queuedTimeoutInMinutes' => <integer>,
        'reportArns' => ['<string>', ...],
        'resolvedSourceVersion' => '<string>',
        'secondaryArtifacts' => [
            [
                'artifactIdentifier' => '<string>',
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'md5sum' => '<string>',
                'overrideArtifactName' => true || false,
                'sha256sum' => '<string>',
            ],
            // ...
        ],
        'secondarySourceVersions' => [
            [
                'sourceIdentifier' => '<string>',
                'sourceVersion' => '<string>',
            ],
            // ...
        ],
        'secondarySources' => [
            [
                'auth' => [
                    'resource' => '<string>',
                    'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                ],
                'buildStatusConfig' => [
                    'context' => '<string>',
                    'targetUrl' => '<string>',
                ],
                'buildspec' => '<string>',
                'gitCloneDepth' => <integer>,
                'gitSubmodulesConfig' => [
                    'fetchSubmodules' => true || false,
                ],
                'insecureSsl' => true || false,
                'location' => '<string>',
                'reportBuildStatus' => true || false,
                'sourceIdentifier' => '<string>',
                'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
            ],
            // ...
        ],
        'serviceRole' => '<string>',
        'source' => [
            'auth' => [
                'resource' => '<string>',
                'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
            ],
            'buildStatusConfig' => [
                'context' => '<string>',
                'targetUrl' => '<string>',
            ],
            'buildspec' => '<string>',
            'gitCloneDepth' => <integer>,
            'gitSubmodulesConfig' => [
                'fetchSubmodules' => true || false,
            ],
            'insecureSsl' => true || false,
            'location' => '<string>',
            'reportBuildStatus' => true || false,
            'sourceIdentifier' => '<string>',
            'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
        ],
        'sourceVersion' => '<string>',
        'startTime' => <DateTime>,
        'timeoutInMinutes' => <integer>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnets' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

AccountLimitExceededException:

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

StartBuildBatch

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

Starts a batch build for a project.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

StopBuild

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

Attempts to stop running a build.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'build' => [
        'arn' => '<string>',
        'artifacts' => [
            'artifactIdentifier' => '<string>',
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'md5sum' => '<string>',
            'overrideArtifactName' => true || false,
            'sha256sum' => '<string>',
        ],
        'autoRetryConfig' => [
            'autoRetryLimit' => <integer>,
            'autoRetryNumber' => <integer>,
            'nextAutoRetry' => '<string>',
            'previousAutoRetry' => '<string>',
        ],
        'buildBatchArn' => '<string>',
        'buildComplete' => true || false,
        'buildNumber' => <integer>,
        'buildStatus' => 'SUCCEEDED|FAILED|FAULT|TIMED_OUT|IN_PROGRESS|STOPPED',
        'cache' => [
            'location' => '<string>',
            'modes' => ['<string>', ...],
            'type' => 'NO_CACHE|S3|LOCAL',
        ],
        'currentPhase' => '<string>',
        'debugSession' => [
            'sessionEnabled' => true || false,
            'sessionTarget' => '<string>',
        ],
        'encryptionKey' => '<string>',
        'endTime' => <DateTime>,
        'environment' => [
            'certificate' => '<string>',
            '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',
            'environmentVariables' => [
                [
                    'name' => '<string>',
                    'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                    'value' => '<string>',
                ],
                // ...
            ],
            'fleet' => [
                'fleetArn' => '<string>',
            ],
            'image' => '<string>',
            'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
            'privilegedMode' => true || false,
            'registryCredential' => [
                'credential' => '<string>',
                'credentialProvider' => 'SECRETS_MANAGER',
            ],
            'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
        ],
        'exportedEnvironmentVariables' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'fileSystemLocations' => [
            [
                'identifier' => '<string>',
                'location' => '<string>',
                'mountOptions' => '<string>',
                'mountPoint' => '<string>',
                'type' => 'EFS',
            ],
            // ...
        ],
        'id' => '<string>',
        'initiator' => '<string>',
        'logs' => [
            'cloudWatchLogs' => [
                'groupName' => '<string>',
                'status' => 'ENABLED|DISABLED',
                'streamName' => '<string>',
            ],
            'cloudWatchLogsArn' => '<string>',
            'deepLink' => '<string>',
            'groupName' => '<string>',
            's3DeepLink' => '<string>',
            's3Logs' => [
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'status' => 'ENABLED|DISABLED',
            ],
            's3LogsArn' => '<string>',
            'streamName' => '<string>',
        ],
        'networkInterface' => [
            'networkInterfaceId' => '<string>',
            'subnetId' => '<string>',
        ],
        'phases' => [
            [
                'contexts' => [
                    [
                        'message' => '<string>',
                        'statusCode' => '<string>',
                    ],
                    // ...
                ],
                'durationInSeconds' => <integer>,
                'endTime' => <DateTime>,
                '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' => <DateTime>,
            ],
            // ...
        ],
        'projectName' => '<string>',
        'queuedTimeoutInMinutes' => <integer>,
        'reportArns' => ['<string>', ...],
        'resolvedSourceVersion' => '<string>',
        'secondaryArtifacts' => [
            [
                'artifactIdentifier' => '<string>',
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'md5sum' => '<string>',
                'overrideArtifactName' => true || false,
                'sha256sum' => '<string>',
            ],
            // ...
        ],
        'secondarySourceVersions' => [
            [
                'sourceIdentifier' => '<string>',
                'sourceVersion' => '<string>',
            ],
            // ...
        ],
        'secondarySources' => [
            [
                'auth' => [
                    'resource' => '<string>',
                    'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                ],
                'buildStatusConfig' => [
                    'context' => '<string>',
                    'targetUrl' => '<string>',
                ],
                'buildspec' => '<string>',
                'gitCloneDepth' => <integer>,
                'gitSubmodulesConfig' => [
                    'fetchSubmodules' => true || false,
                ],
                'insecureSsl' => true || false,
                'location' => '<string>',
                'reportBuildStatus' => true || false,
                'sourceIdentifier' => '<string>',
                'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
            ],
            // ...
        ],
        'serviceRole' => '<string>',
        'source' => [
            'auth' => [
                'resource' => '<string>',
                'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
            ],
            'buildStatusConfig' => [
                'context' => '<string>',
                'targetUrl' => '<string>',
            ],
            'buildspec' => '<string>',
            'gitCloneDepth' => <integer>,
            'gitSubmodulesConfig' => [
                'fetchSubmodules' => true || false,
            ],
            'insecureSsl' => true || false,
            'location' => '<string>',
            'reportBuildStatus' => true || false,
            'sourceIdentifier' => '<string>',
            'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
        ],
        'sourceVersion' => '<string>',
        'startTime' => <DateTime>,
        'timeoutInMinutes' => <integer>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnets' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

StopBuildBatch

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

Stops a running batch build.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

UpdateFleet

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

Updates a compute fleet.

Parameter Syntax

$result = $client->updateFleet([
    'arn' => '<string>', // REQUIRED
    'baseCapacity' => <integer>,
    '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',
    'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
    'fleetServiceRole' => '<string>',
    'imageId' => '<string>',
    'overflowBehavior' => 'QUEUE|ON_DEMAND',
    'proxyConfiguration' => [
        'defaultBehavior' => 'ALLOW_ALL|DENY_ALL',
        'orderedProxyRules' => [
            [
                'effect' => 'ALLOW|DENY', // REQUIRED
                'entities' => ['<string>', ...], // REQUIRED
                'type' => 'DOMAIN|IP', // REQUIRED
            ],
            // ...
        ],
    ],
    'scalingConfiguration' => [
        'maxCapacity' => <integer>,
        'scalingType' => 'TARGET_TRACKING_SCALING',
        'targetTrackingScalingConfigs' => [
            [
                'metricType' => 'FLEET_UTILIZATION_RATE',
                'targetValue' => <float>,
            ],
            // ...
        ],
    ],
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...],
        'subnets' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'fleet' => [
        'arn' => '<string>',
        'baseCapacity' => <integer>,
        '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',
        'created' => <DateTime>,
        'environmentType' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
        'fleetServiceRole' => '<string>',
        'id' => '<string>',
        'imageId' => '<string>',
        'lastModified' => <DateTime>,
        'name' => '<string>',
        'overflowBehavior' => 'QUEUE|ON_DEMAND',
        'proxyConfiguration' => [
            'defaultBehavior' => 'ALLOW_ALL|DENY_ALL',
            'orderedProxyRules' => [
                [
                    'effect' => 'ALLOW|DENY',
                    'entities' => ['<string>', ...],
                    'type' => 'DOMAIN|IP',
                ],
                // ...
            ],
        ],
        'scalingConfiguration' => [
            'desiredCapacity' => <integer>,
            'maxCapacity' => <integer>,
            'scalingType' => 'TARGET_TRACKING_SCALING',
            'targetTrackingScalingConfigs' => [
                [
                    'metricType' => 'FLEET_UTILIZATION_RATE',
                    'targetValue' => <float>,
                ],
                // ...
            ],
        ],
        'status' => [
            'context' => 'CREATE_FAILED|UPDATE_FAILED|ACTION_REQUIRED|PENDING_DELETION|INSUFFICIENT_CAPACITY',
            'message' => '<string>',
            'statusCode' => 'CREATING|UPDATING|ROTATING|PENDING_DELETION|DELETING|CREATE_FAILED|UPDATE_ROLLBACK_FAILED|ACTIVE',
        ],
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnets' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

AccountLimitExceededException:

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

UpdateProject

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

Changes the settings of a build project.

Parameter Syntax

$result = $client->updateProject([
    'artifacts' => [
        'artifactIdentifier' => '<string>',
        'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
        'encryptionDisabled' => true || false,
        'location' => '<string>',
        'name' => '<string>',
        'namespaceType' => 'NONE|BUILD_ID',
        'overrideArtifactName' => true || false,
        'packaging' => 'NONE|ZIP',
        'path' => '<string>',
        'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED
    ],
    'autoRetryLimit' => <integer>,
    'badgeEnabled' => true || false,
    'buildBatchConfig' => [
        'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH',
        'combineArtifacts' => true || false,
        'restrictions' => [
            'computeTypesAllowed' => ['<string>', ...],
            'maximumBuildsAllowed' => <integer>,
        ],
        'serviceRole' => '<string>',
        'timeoutInMins' => <integer>,
    ],
    'cache' => [
        'location' => '<string>',
        'modes' => ['<string>', ...],
        'type' => 'NO_CACHE|S3|LOCAL', // REQUIRED
    ],
    'concurrentBuildLimit' => <integer>,
    'description' => '<string>',
    'encryptionKey' => '<string>',
    'environment' => [
        'certificate' => '<string>',
        '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', // REQUIRED
        'environmentVariables' => [
            [
                'name' => '<string>', // REQUIRED
                'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'fleet' => [
            'fleetArn' => '<string>',
        ],
        'image' => '<string>', // REQUIRED
        'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
        'privilegedMode' => true || false,
        'registryCredential' => [
            'credential' => '<string>', // REQUIRED
            'credentialProvider' => 'SECRETS_MANAGER', // REQUIRED
        ],
        'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM', // REQUIRED
    ],
    'fileSystemLocations' => [
        [
            'identifier' => '<string>',
            'location' => '<string>',
            'mountOptions' => '<string>',
            'mountPoint' => '<string>',
            'type' => 'EFS',
        ],
        // ...
    ],
    'logsConfig' => [
        'cloudWatchLogs' => [
            'groupName' => '<string>',
            'status' => 'ENABLED|DISABLED', // REQUIRED
            'streamName' => '<string>',
        ],
        's3Logs' => [
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'status' => 'ENABLED|DISABLED', // REQUIRED
        ],
    ],
    'name' => '<string>', // REQUIRED
    'queuedTimeoutInMinutes' => <integer>,
    'secondaryArtifacts' => [
        [
            'artifactIdentifier' => '<string>',
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'name' => '<string>',
            'namespaceType' => 'NONE|BUILD_ID',
            'overrideArtifactName' => true || false,
            'packaging' => 'NONE|ZIP',
            'path' => '<string>',
            'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS', // REQUIRED
        ],
        // ...
    ],
    'secondarySourceVersions' => [
        [
            'sourceIdentifier' => '<string>', // REQUIRED
            'sourceVersion' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'secondarySources' => [
        [
            'auth' => [
                'resource' => '<string>',
                'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED
            ],
            'buildStatusConfig' => [
                'context' => '<string>',
                'targetUrl' => '<string>',
            ],
            'buildspec' => '<string>',
            'gitCloneDepth' => <integer>,
            'gitSubmodulesConfig' => [
                'fetchSubmodules' => true || false, // REQUIRED
            ],
            'insecureSsl' => true || false,
            'location' => '<string>',
            'reportBuildStatus' => true || false,
            'sourceIdentifier' => '<string>',
            'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED
        ],
        // ...
    ],
    'serviceRole' => '<string>',
    'source' => [
        'auth' => [
            'resource' => '<string>',
            'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER', // REQUIRED
        ],
        'buildStatusConfig' => [
            'context' => '<string>',
            'targetUrl' => '<string>',
        ],
        'buildspec' => '<string>',
        'gitCloneDepth' => <integer>,
        'gitSubmodulesConfig' => [
            'fetchSubmodules' => true || false, // REQUIRED
        ],
        'insecureSsl' => true || false,
        'location' => '<string>',
        'reportBuildStatus' => true || false,
        'sourceIdentifier' => '<string>',
        'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE', // REQUIRED
    ],
    'sourceVersion' => '<string>',
    'tags' => [
        [
            'key' => '<string>',
            'value' => '<string>',
        ],
        // ...
    ],
    'timeoutInMinutes' => <integer>,
    'vpcConfig' => [
        'securityGroupIds' => ['<string>', ...],
        'subnets' => ['<string>', ...],
        'vpcId' => '<string>',
    ],
]);

Parameter Details

Result Syntax

[
    'project' => [
        'arn' => '<string>',
        'artifacts' => [
            'artifactIdentifier' => '<string>',
            'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
            'encryptionDisabled' => true || false,
            'location' => '<string>',
            'name' => '<string>',
            'namespaceType' => 'NONE|BUILD_ID',
            'overrideArtifactName' => true || false,
            'packaging' => 'NONE|ZIP',
            'path' => '<string>',
            'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS',
        ],
        'autoRetryLimit' => <integer>,
        'badge' => [
            'badgeEnabled' => true || false,
            'badgeRequestUrl' => '<string>',
        ],
        'buildBatchConfig' => [
            'batchReportMode' => 'REPORT_INDIVIDUAL_BUILDS|REPORT_AGGREGATED_BATCH',
            'combineArtifacts' => true || false,
            'restrictions' => [
                'computeTypesAllowed' => ['<string>', ...],
                'maximumBuildsAllowed' => <integer>,
            ],
            'serviceRole' => '<string>',
            'timeoutInMins' => <integer>,
        ],
        'cache' => [
            'location' => '<string>',
            'modes' => ['<string>', ...],
            'type' => 'NO_CACHE|S3|LOCAL',
        ],
        'concurrentBuildLimit' => <integer>,
        'created' => <DateTime>,
        'description' => '<string>',
        'encryptionKey' => '<string>',
        'environment' => [
            'certificate' => '<string>',
            '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',
            'environmentVariables' => [
                [
                    'name' => '<string>',
                    'type' => 'PLAINTEXT|PARAMETER_STORE|SECRETS_MANAGER',
                    'value' => '<string>',
                ],
                // ...
            ],
            'fleet' => [
                'fleetArn' => '<string>',
            ],
            'image' => '<string>',
            'imagePullCredentialsType' => 'CODEBUILD|SERVICE_ROLE',
            'privilegedMode' => true || false,
            'registryCredential' => [
                'credential' => '<string>',
                'credentialProvider' => 'SECRETS_MANAGER',
            ],
            'type' => 'WINDOWS_CONTAINER|LINUX_CONTAINER|LINUX_GPU_CONTAINER|ARM_CONTAINER|WINDOWS_SERVER_2019_CONTAINER|LINUX_LAMBDA_CONTAINER|ARM_LAMBDA_CONTAINER|MAC_ARM',
        ],
        'fileSystemLocations' => [
            [
                'identifier' => '<string>',
                'location' => '<string>',
                'mountOptions' => '<string>',
                'mountPoint' => '<string>',
                'type' => 'EFS',
            ],
            // ...
        ],
        'lastModified' => <DateTime>,
        'logsConfig' => [
            'cloudWatchLogs' => [
                'groupName' => '<string>',
                'status' => 'ENABLED|DISABLED',
                'streamName' => '<string>',
            ],
            's3Logs' => [
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'status' => 'ENABLED|DISABLED',
            ],
        ],
        'name' => '<string>',
        'projectVisibility' => 'PUBLIC_READ|PRIVATE',
        'publicProjectAlias' => '<string>',
        'queuedTimeoutInMinutes' => <integer>,
        'resourceAccessRole' => '<string>',
        'secondaryArtifacts' => [
            [
                'artifactIdentifier' => '<string>',
                'bucketOwnerAccess' => 'NONE|READ_ONLY|FULL',
                'encryptionDisabled' => true || false,
                'location' => '<string>',
                'name' => '<string>',
                'namespaceType' => 'NONE|BUILD_ID',
                'overrideArtifactName' => true || false,
                'packaging' => 'NONE|ZIP',
                'path' => '<string>',
                'type' => 'CODEPIPELINE|S3|NO_ARTIFACTS',
            ],
            // ...
        ],
        'secondarySourceVersions' => [
            [
                'sourceIdentifier' => '<string>',
                'sourceVersion' => '<string>',
            ],
            // ...
        ],
        'secondarySources' => [
            [
                'auth' => [
                    'resource' => '<string>',
                    'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
                ],
                'buildStatusConfig' => [
                    'context' => '<string>',
                    'targetUrl' => '<string>',
                ],
                'buildspec' => '<string>',
                'gitCloneDepth' => <integer>,
                'gitSubmodulesConfig' => [
                    'fetchSubmodules' => true || false,
                ],
                'insecureSsl' => true || false,
                'location' => '<string>',
                'reportBuildStatus' => true || false,
                'sourceIdentifier' => '<string>',
                'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
            ],
            // ...
        ],
        'serviceRole' => '<string>',
        'source' => [
            'auth' => [
                'resource' => '<string>',
                'type' => 'OAUTH|CODECONNECTIONS|SECRETS_MANAGER',
            ],
            'buildStatusConfig' => [
                'context' => '<string>',
                'targetUrl' => '<string>',
            ],
            'buildspec' => '<string>',
            'gitCloneDepth' => <integer>,
            'gitSubmodulesConfig' => [
                'fetchSubmodules' => true || false,
            ],
            'insecureSsl' => true || false,
            'location' => '<string>',
            'reportBuildStatus' => true || false,
            'sourceIdentifier' => '<string>',
            'type' => 'CODECOMMIT|CODEPIPELINE|GITHUB|GITLAB|GITLAB_SELF_MANAGED|S3|BITBUCKET|GITHUB_ENTERPRISE|NO_SOURCE',
        ],
        'sourceVersion' => '<string>',
        'tags' => [
            [
                'key' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'timeoutInMinutes' => <integer>,
        'vpcConfig' => [
            'securityGroupIds' => ['<string>', ...],
            'subnets' => ['<string>', ...],
            'vpcId' => '<string>',
        ],
        'webhook' => [
            'branchFilter' => '<string>',
            'buildType' => 'BUILD|BUILD_BATCH',
            'filterGroups' => [
                [
                    [
                        'excludeMatchedPattern' => true || false,
                        'pattern' => '<string>',
                        'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME',
                    ],
                    // ...
                ],
                // ...
            ],
            'lastModifiedSecret' => <DateTime>,
            'manualCreation' => true || false,
            'payloadUrl' => '<string>',
            'scopeConfiguration' => [
                'domain' => '<string>',
                'name' => '<string>',
                'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP',
            ],
            'secret' => '<string>',
            'url' => '<string>',
        ],
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

UpdateProjectVisibility

$result = $client->updateProjectVisibility([/* ... */]);
$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.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

UpdateReportGroup

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

Updates a report group.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

UpdateWebhook

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

Updates the webhook associated with an CodeBuild build project.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'webhook' => [
        'branchFilter' => '<string>',
        'buildType' => 'BUILD|BUILD_BATCH',
        'filterGroups' => [
            [
                [
                    'excludeMatchedPattern' => true || false,
                    'pattern' => '<string>',
                    'type' => 'EVENT|BASE_REF|HEAD_REF|ACTOR_ACCOUNT_ID|FILE_PATH|COMMIT_MESSAGE|WORKFLOW_NAME|TAG_NAME|RELEASE_NAME|REPOSITORY_NAME',
                ],
                // ...
            ],
            // ...
        ],
        'lastModifiedSecret' => <DateTime>,
        'manualCreation' => true || false,
        'payloadUrl' => '<string>',
        'scopeConfiguration' => [
            'domain' => '<string>',
            'name' => '<string>',
            'scope' => 'GITHUB_ORGANIZATION|GITHUB_GLOBAL|GITLAB_GROUP',
        ],
        'secret' => '<string>',
        'url' => '<string>',
    ],
]

Result Details

Errors

InvalidInputException:

The input value that was provided is not valid.

ResourceNotFoundException:

The specified Amazon Web Services resource cannot be found.

OAuthProviderException:

There was a problem with the underlying OAuth provider.