CancelJobRequest

import type { CancelJobRequest } from "https://aws-api.deno.dev/v0.3/services/iot.ts?docs=full";

interface CancelJobRequest {

comment?: string | null;

force?: boolean | null;

jobId: string;

reasonCode?: string | null;

}

§Properties

comment?: string | null

[src]

An optional comment string describing why the job was canceled.

force?: boolean | null

[src]

(Optional) If true job executions with status "IN_PROGRESS" and "QUEUED" are canceled, otherwise only job executions with status "QUEUED" are canceled. The default is false.

Canceling a job which is "IN_PROGRESS", will cause a device which is executing the job to be unable to update the job execution status. Use caution and ensure that each device executing a job which is canceled is able to recover to a valid state.

jobId: string

[src]

The unique identifier you assigned to this job when it was created.

reasonCode?: string | null

[src]

(Optional)A reason code string that explains why the job was canceled.