Cancel Job

locationservice_cancel_job

R Documentation

CancelJob cancels a job that is currently running or pending¶

Description¶

cancel_job 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.

Usage¶

locationservice_cancel_job(JobId)

Arguments¶

JobId

[required] The unique identifier of the job to cancel.

Value¶

A list with the following syntax:

list(
  JobArn = "string",
  JobId = "string",
  Status = "Pending"|"Running"|"Completed"|"Failed"|"Cancelling"|"Cancelled"
)

Request syntax¶

svc$cancel_job(
  JobId = "string"
)