CodeBuild / Client / delete_build_batch

delete_build_batch#

CodeBuild.Client.delete_build_batch(**kwargs)#

Deletes a batch build.

Request Syntax

response = client.delete_build_batch(
    id='string'
)

Parameters:

id (string) –

[REQUIRED]

The identifier of the batch build to delete.

Return type:

dict

Returns:

Response Syntax

{
    'statusCode': 'string',
    'buildsDeleted': [
        'string',
    ],
    'buildsNotDeleted': [
        {
            'id': 'string',
            'statusCode': 'string'
        },
    ]
}

Response Structure

(dict) –
- 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.
  - (dict) –
    
    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.

Exceptions

CodeBuild.Client.exceptions.InvalidInputException