[ 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.

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>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <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.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

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.