GET

/things/{thingName}/jobs/{jobId}

http://iot.{region}.amazonaws.com/things/{thingName}/jobs/{jobId}

<p>Describes a job execution.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeJobExecution</a> action.</p>

Access Token Required: API Key

Path Parameters

jobIdstringrequired

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

thingNamestringrequired

The name of the thing on which the job execution is running.

Query Params

executionNumberinteger

A string (consisting of the digits "0" through "9" which is used to specify a particular job execution on a particular device.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request GET \
2     --url 'http://iot.{region}.amazonaws.com/things/{thingName}/jobs/{jobId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}