[ aws . iot ]

associate-targets-with-job

Description

Associates a group with a continuous job. The following criteria must be met:

• The job must have been created with the targetSelection field 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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  associate-targets-with-job
--targets <value>
--job-id <value>
[--comment <value>]
[--namespace-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--targets (list)

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

(string)

Syntax:

"string" "string" ...

--job-id (string)

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

--comment (string)

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

--namespace-id (string)

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* /

Note

The namespaceId feature is in public preview.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To associate a thing group with a continuous job

The following associate-targets-with-job example associates the specified thing group with the specified continuous job.

aws iot associate-targets-with-job \
    --targets "arn:aws:iot:us-west-2:123456789012:thinggroup/LightBulbs" \
    --job-id "example-job-04"

Output:

{
    "jobArn": "arn:aws:iot:us-west-2:123456789012:job/example-job-04",
    "jobId": "example-job-04",
    "description": "example continuous job"
}

For more information, see Creating and Managing Jobs (CLI) in the AWS IoT Developer Guide.

Output

jobArn -> (string)

An ARN identifying the job.

jobId -> (string)

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

description -> (string)

A short text description of the job.