AssociateTargetsWithJob
Associates a group with a continuous job. The following criteria must be met:
-
The job must have been created with the
targetSelectionfield set to "CONTINUOUS". -
The job status must currently be "IN_PROGRESS".
-
The total number of targets associated with a job must not exceed 100.
Requires permission to access the AssociateTargetsWithJob action.
Request Syntax
POST /jobs/jobId/targets?namespaceId=namespaceId HTTP/1.1
Content-type: application/json
{
"comment": "string",
"targets": [ "string" ]
}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_-]+Required: Yes
- 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_-]+
Request Body
The request accepts the following data in JSON format.
- comment
-
An optional comment string describing why the job was associated with the targets.
Type: String
Length Constraints: Maximum length of 2028.
Pattern:
[^\p{C}]+Required: No
- targets
-
A list of thing group ARNs that define the targets of the job.
Type: Array of strings
Array Members: Minimum number of 1 item.
Length Constraints: Maximum length of 2048.
Required: Yes
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"description": "string",
"jobArn": "string",
"jobId": "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.
- description
-
A short text description of the job.
Type: String
Length Constraints: Maximum length of 2028.
Pattern:
[^\p{C}]+ - jobArn
-
An ARN identifying the job.
Type: String
- jobId
-
The unique identifier you assigned to this job when it was created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[a-zA-Z0-9_-]+
Errors
- InvalidRequestException
-
The request is not valid.
HTTP Status Code: 400
- LimitExceededException
-
A limit has been exceeded.
HTTP Status Code: 410
- 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:
