/jobs

The AWS IoT Wireless multi-region endpoint

https://api.iotwireless.{region}.amazonaws.com

GET

/jobs

Lists jobs.

Requires permission to access the ListJobs action.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request GET 'https://api.iotwireless.{region}.amazonaws.com/jobs'

Response Example

200 - Example 1

{
    "jobs": [],
    "nextToken": "string"
}

Request

Query Params

status

string

optional

An optional filter that lets you search for jobs that have the specified status.

targetSelection

string

optional

Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.

maxResults

integer

optional

The maximum number of results to return per request.

nextToken

string

optional

The token to retrieve the next set of results.

thingGroupName

string

optional

A filter that limits the returned jobs to those for the specified group.

thingGroupId

string

optional

A filter that limits the returned jobs to those for the specified group.

namespaceId

string

optional

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

When you specify a value for this parameter, Amazon Web Services 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/

Responses

🟢200Success

application/json

Body

jobs

array[object (JobSummary) {8}]

optional

A list of jobs.

jobArn

string

optional

The job ARN.

jobId

string

optional

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

>= 1 characters<= 64 characters

Match pattern:

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

thingGroupId

string

optional

The ID of the thing group.

>= 1 characters<= 128 characters

Match pattern:

[a-zA-Z0-9\-]+

targetSelection

enum<string>

optional

Allowed values:

CONTINUOUSSNAPSHOT

status

enum<string>

optional

The job summary status.

Allowed values:

IN_PROGRESSCANCELEDCOMPLETEDDELETION_IN_PROGRESS

createdAt

string <date-time>

optional

The time, in seconds since the epoch, when the job was created.

lastUpdatedAt

string <date-time>

optional

The time, in seconds since the epoch, when the job was last updated.

completedAt

string <date-time>

optional

The time, in seconds since the epoch, when the job completed.

nextToken

string

optional

The token for the next set of results, or null if there are no additional results.

<= 4096 characters

🟠480InvalidRequestException

🟠481ResourceNotFoundException

🟠482ThrottlingException

🟠483ServiceUnavailableException

Modified at 2022-09-10 23:12:18

/job-templates

/mitigationactions/actions