cancel_job

ImportExport.Client.cancel_job(**kwargs)

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

See also: AWS API Documentation

Request Syntax

response = client.cancel_job(
    JobId='string',
    APIVersion='string'
)

Parameters

• JobId (string) -- [REQUIRED] A unique identifier which refers to a particular job.
• APIVersion (string) -- Specifies the version of the client tool.

Return type

dict

Returns

Response Syntax

{
    'Success': True|False
}

Response Structure

• (dict) -- Output structure for the CancelJob operation.
  • Success (boolean) -- Specifies whether (true) or not (false) AWS Import/Export updated your job.

Exceptions

• ImportExport.Client.exceptions.InvalidJobIdException
• ImportExport.Client.exceptions.ExpiredJobIdException
• ImportExport.Client.exceptions.CanceledJobIdException
• ImportExport.Client.exceptions.UnableToCancelJobIdException
• ImportExport.Client.exceptions.InvalidAccessKeyIdException
• ImportExport.Client.exceptions.InvalidVersionException