POST

/jobs/{jobId}/targets

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

Associates a group with a continuous job. The following criteria must be met: <ul> <li> The job must have been created with the <code>targetSelection</code> field set to "CONTINUOUS". </li> <li> The job status must currently be "IN_PROGRESS". </li> <li> The total number of targets associated with a job must not exceed 100. </li> </ul> Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">AssociateTargetsWithJob</a> action.

Access Token Required: API Key

Path Parameters

jobIdstringrequired

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

Query Params

namespaceIdstring

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. <code>$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/</code> <note> The <code>namespaceId</code> feature is in public preview. </note>

Body Params

commentstring

An optional comment string describing why the job was associated with the targets.

targetsarrayrequired

A list of thing group ARNs that define the targets of the job.

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 POST \
2     --url 'http://iot.{region}.amazonaws.com/jobs/{jobId}/targets' \
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}