Snowball / Client / cancel_cluster

cancel_cluster#

Snowball.Client.cancel_cluster(**kwargs)#

Cancels a cluster job. You can only cancel a cluster job while it’s in the AwaitingQuorum status. You’ll have at least an hour after creating a cluster job to cancel it.

Request Syntax

response = client.cancel_cluster(
    ClusterId='string'
)

Parameters:

ClusterId (string) –

[REQUIRED]

The 39-character ID for the cluster that you want to cancel, for example CID123e4567-e89b-12d3-a456-426655440000.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Exceptions

Snowball.Client.exceptions.KMSRequestFailedException
Snowball.Client.exceptions.InvalidJobStateException
Snowball.Client.exceptions.InvalidResourceException

Examples

This operation cancels a cluster job. You can only cancel a cluster job while it’s in the AwaitingQuorum status.

response = client.cancel_cluster(
    ClusterId='CID123e4567-e89b-12d3-a456-426655440000',
)

print(response)

Expected Output:

{
    'ResponseMetadata': {
        '...': '...',
    },
}