Menu
AWS IoT
Developer Guide

GetJobDocument

Gets a job document.

Request syntax:

GET /jobs/jobId/job-document

URI Request Parameters:

Name

Type

Req?

Description

jobId

JobId

yes

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

Response syntax:

Content-type: application/json { "document": "string" }

Response Body Parameters:

Name

Type

Req?

Description

document

JobDocument

no

The job document content.

Errors:

InvalidRequestException

The contents of the request were invalid. For example, this code is returned when an UpdateJobExecution request contains invalid status details. The message contains details about the error.

HTTP response code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP response code: 404

ThrottlingException

The rate exceeds the limit.

HTTP response code: 429

ServiceUnavailableException

The service is temporarily unavailable.

HTTP response code: 503

CLI

Synopsis:

aws iot get-job-document \ --job-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "jobId": "string" }

cli-input-json fields:

Name

Type

Description

jobId

string

length max:64 min:1

pattern: [a-zA-Z0-9_-]+

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

Output:

{ "document": "string" }

cli output fields:

Name

Type

Description

document

string

length max:32768

The job document content.

On this page: