ListJobExecutionsForThing
Lists the job executions for the specified thing.
Requires permission to access the ListJobExecutionsForThing action.
Request Syntax
GET /things/thingName/jobs?jobId=jobId&maxResults=maxResults&namespaceId=namespaceId&nextToken=nextToken&status=status HTTP/1.1
URI Request Parameters
The request uses 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_-]+ - maxResults
-
The maximum number of results to be returned per request.
Valid Range: Minimum value of 1. Maximum value of 250.
- 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
namespaceIdfeature is only supported by AWS IoT Greengrass at this time. For more information, see Setting up AWS IoT Greengrass core devices.Pattern:
[a-zA-Z0-9_-]+ - nextToken
-
The token to retrieve the next set of results.
- status
-
An optional filter that lets you search for jobs that have the specified status.
Valid Values:
QUEUED | IN_PROGRESS | SUCCEEDED | FAILED | TIMED_OUT | REJECTED | REMOVED | CANCELED - thingName
-
The thing name.
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
{
"executionSummaries": [
{
"jobExecutionSummary": {
"executionNumber": number,
"lastUpdatedAt": number,
"queuedAt": number,
"retryAttempt": number,
"startedAt": number,
"status": "string"
},
"jobId": "string"
}
],
"nextToken": "string"
}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.
- executionSummaries
-
A list of job execution summaries.
Type: Array of JobExecutionSummaryForThing objects
- nextToken
-
The token for the next set of results, or null if there are no additional results.
Type: String
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: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
