View a markdown version of this page

RetryBuildBatch - AWS CodeBuild

RetryBuildBatch

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

Request Syntax

{ "id": "string", "idempotencyToken": "string", "retryType": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Note

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

id

Specifies the identifier of the batch build to restart.

Type: String

Length Constraints: Minimum length of 1.

Required: No

idempotencyToken

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

Type: String

Required: No

retryType

Specifies the type of retry to perform.

Type: String

Valid Values: RETRY_ALL_BUILDS | RETRY_FAILED_BUILDS

Required: No

Response Syntax

{ "buildBatch": { "arn": "string", "artifacts": { "artifactIdentifier": "string", "bucketOwnerAccess": "string", "encryptionDisabled": boolean, "location": "string", "md5sum": "string", "overrideArtifactName": boolean, "sha256sum": "string" }, "buildBatchConfig": { "batchReportMode": "string", "combineArtifacts": boolean, "restrictions": { "computeTypesAllowed": [ "string" ], "fleetsAllowed": [ "string" ], "maximumBuildsAllowed": number }, "serviceRole": "string", "timeoutInMins": number }, "buildBatchNumber": number, "buildBatchStatus": "string", "buildGroups": [ { "currentBuildSummary": { "arn": "string", "buildStatus": "string", "primaryArtifact": { "identifier": "string", "location": "string", "type": "string" }, "requestedOn": number, "secondaryArtifacts": [ { "identifier": "string", "location": "string", "type": "string" } ] }, "dependsOn": [ "string" ], "identifier": "string", "ignoreFailure": boolean, "priorBuildSummaryList": [ { "arn": "string", "buildStatus": "string", "primaryArtifact": { "identifier": "string", "location": "string", "type": "string" }, "requestedOn": number, "secondaryArtifacts": [ { "identifier": "string", "location": "string", "type": "string" } ] } ] } ], "buildTimeoutInMinutes": number, "cache": { "cacheNamespace": "string", "location": "string", "modes": [ "string" ], "type": "string" }, "complete": boolean, "currentPhase": "string", "debugSessionEnabled": boolean, "encryptionKey": "string", "endTime": number, "environment": { "certificate": "string", "computeConfiguration": { "disk": number, "instanceType": "string", "machineType": "string", "memory": number, "vCpu": number }, "computeType": "string", "dockerServer": { "computeType": "string", "securityGroupIds": [ "string" ], "status": { "message": "string", "status": "string" } }, "environmentVariables": [ { "name": "string", "type": "string", "value": "string" } ], "fleet": { "fleetArn": "string" }, "hostKernel": "string", "image": "string", "imagePullCredentialsType": "string", "privilegedMode": boolean, "registryCredential": { "credential": "string", "credentialProvider": "string" }, "type": "string" }, "fileSystemLocations": [ { "identifier": "string", "location": "string", "mountOptions": "string", "mountPoint": "string", "type": "string" } ], "id": "string", "initiator": "string", "logConfig": { "cloudWatchLogs": { "groupName": "string", "status": "string", "streamName": "string" }, "s3Logs": { "bucketOwnerAccess": "string", "encryptionDisabled": boolean, "location": "string", "status": "string" } }, "phases": [ { "contexts": [ { "message": "string", "statusCode": "string" } ], "durationInSeconds": number, "endTime": number, "phaseStatus": "string", "phaseType": "string", "startTime": number } ], "projectName": "string", "queuedTimeoutInMinutes": number, "reportArns": [ "string" ], "resolvedSourceVersion": "string", "secondaryArtifacts": [ { "artifactIdentifier": "string", "bucketOwnerAccess": "string", "encryptionDisabled": boolean, "location": "string", "md5sum": "string", "overrideArtifactName": boolean, "sha256sum": "string" } ], "secondarySources": [ { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "buildStatusConfig": { "context": "string", "targetUrl": "string" }, "gitCloneDepth": number, "gitSubmodulesConfig": { "fetchSubmodules": boolean }, "insecureSsl": boolean, "location": "string", "reportBuildStatus": boolean, "sourceIdentifier": "string", "type": "string" } ], "secondarySourceVersions": [ { "sourceIdentifier": "string", "sourceVersion": "string" } ], "serviceRole": "string", "source": { "