[ aws . codebuild ]

delete-build-batch

Description

Deletes a batch build.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  delete-build-batch
--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--id (string)

The identifier of the batch build to delete.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Examples

To delete a batch build in AWS CodeBuild.

The following delete-build-batch example deletes the specified batch build.

aws codebuild delete-build-batch \
    --id <project-name>:<batch-ID>

Output:

{
    "statusCode": "BATCH_DELETED",
    "buildsDeleted": [
        "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
        "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
        "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>",
        "arn:aws:codebuild:<region-ID>:<account-ID>:build/<project-name>:<build-ID>"
    ],
    "buildsNotDeleted": []
}

For more information, see Batch builds in AWS CodeBuild in the AWS CodeBuild User Guide.

Output

statusCode -> (string)

The status code.

buildsDeleted -> (list)

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

(string)

buildsNotDeleted -> (list)

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

(structure)

Information about a build that could not be successfully deleted.

id -> (string)

The ID of the build that could not be successfully deleted.

statusCode -> (string)

Additional information about the build that could not be successfully deleted.