cancel_job¶

LocationService.Client.cancel_job(**kwargs)¶

CancelJob cancels a job that is currently running or pending. If the job is already in a terminal state ( Completed, Failed, or Cancelled), the operation returns successfully with the current status.

For more information, see Job concepts in the Amazon Location Service Developer Guide.

Request Syntax

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

Parameters:

JobId (string) –

[REQUIRED]

The unique identifier of the job to cancel.

Return type:

dict

Returns:

Response Syntax

{
    'JobArn': 'string',
    'JobId': 'string',
    'Status': 'Pending'|'Running'|'Completed'|'Failed'|'Cancelling'|'Cancelled'
}

Response Structure

(dict) –
- JobArn (string) –
  
  Amazon Resource Name (ARN) of the cancelled job.
- JobId (string) –
  
  Unique job identifier.
- Status (string) –
  
  Job status after cancellation request.

Exceptions

LocationService.Client.exceptions.InternalServerException
LocationService.Client.exceptions.AccessDeniedException
LocationService.Client.exceptions.ValidationException
LocationService.Client.exceptions.ThrottlingException