StopBuildBatch - AWS CodeBuild

StopBuildBatch

Stops a running batch build.

Request Syntax

{ "id": "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

The identifier of the batch build to stop.

Type: String

Length Constraints: Minimum length of 1.

Required: Yes

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" ], "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": { "location": "string", "modes": [ "string" ], "type": "string" }, "complete": boolean, "currentPhase": "string", "debugSessionEnabled": boolean, "encryptionKey": "string", "endTime": number, "environment": { "certificate": "string", "computeType": "string", "environmentVariables": [ { "name": "string", "type": "string", "value": "string" } ], "fleet": { "fleetArn": "string" }, "image": "string", "imagePullCredentialsType": "string", "privilegedMode": boolean, "registryCredential": { "credential": "string", "credentialProvider": "string" }, "type": "string" }, "fileSystemLocations": [ { "identifier": "string", "location": "string", "mountOptions": "string", "mountPoint": "string", "type": "string" } ], "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, "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": { "auth": { "resource": "string", "type": "string" }, "buildspec": "string", "buildStatusConfig": { "context": "string", "targetUrl": "string" }, "gitCloneDepth": number, "gitSubmodulesConfig": { "fetchSubmodules": boolean }, "insecureSsl": boolean, "location": "string", "reportBuildStatus": boolean, "sourceIdentifier": "string", "type": "string" }, "sourceVersion": "string", "startTime": number, "vpcConfig": { "securityGroupIds": [ "string" ], "subnets": [ "string" ], "vpcId": "string" } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

buildBatch

Contains information about a batch build.

Type: BuildBatch object

Errors

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

InvalidInputException

The input value that was provided is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified AWS resource cannot be found.

HTTP Status Code: 400

See Also

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