GetPendingJobExecutions - AWS IoT

GetPendingJobExecutions

Gets the list of all jobs for a thing that are not in a terminal status.

Request Syntax

GET /things/thingName/jobs?namespaceId=namespaceId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

namespaceId

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, AWS IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/

Note

The namespaceId feature is in public preview.

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

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

thingName

The name of the thing that is executing the job.

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

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

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "inProgressJobs": [ { "executionNumber": number, "jobId": "string", "lastUpdatedAt": number, "queuedAt": number, "startedAt": number, "versionNumber": number } ], "queuedJobs": [ { "executionNumber": number, "jobId": "string", "lastUpdatedAt": number, "queuedAt": number, "startedAt": number, "versionNumber": 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.

inProgressJobs

A list of JobExecutionSummary objects with status IN_PROGRESS.

Type: Array of JobExecutionSummary objects

queuedJobs

A list of JobExecutionSummary objects with status QUEUED.

Type: Array of JobExecutionSummary objects

Errors

CertificateValidationException

The certificate is invalid.

HTTP Status Code: 400

InvalidRequestException

The contents of the request were invalid.

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: 400

See Also

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