AWS IoT
API Reference

DescribeJob

Describes a job.

Request Syntax

GET /jobs/jobId HTTP/1.1

URI Request Parameters

The request requires the following URI parameters.

jobId

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

Length Constraints: Minimum length of 1. Maximum length of 64.

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

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "documentSource": "string", "job": { "comment": "string", "completedAt": number, "createdAt": number, "description": "string", "forceCanceled": boolean, "jobArn": "string", "jobExecutionsRolloutConfig": { "maximumPerMinute": number }, "jobId": "string", "jobProcessDetails": { "numberOfCanceledThings": number, "numberOfFailedThings": number, "numberOfInProgressThings": number, "numberOfQueuedThings": number, "numberOfRejectedThings": number, "numberOfRemovedThings": number, "numberOfSucceededThings": number, "numberOfTimedOutThings": number, "processingTargets": [ "string" ] }, "lastUpdatedAt": number, "presignedUrlConfig": { "expiresInSec": number, "roleArn": "string" }, "status": "string", "targets": [ "string" ], "targetSelection": "string", "timeoutConfig": { "inProgressTimeoutInMinutes": number } } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

documentSource

An S3 link to the job document.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1350.

job

Information about the job.

Type: Job object

Errors

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ServiceUnavailableException

The service is temporarily unavailable.

HTTP Status Code: 503

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: