AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::AssociateTargetsWithJobRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing AssociateTargetsWithJobRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  targets: ["TargetArn"], # required
  job_id: "JobId", # required
  comment: "Comment",
  namespace_id: "NamespaceId",
}

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

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

Returns:

  • (String)

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

#job_idString

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

Returns:

  • (String)

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

#namespace_idString

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/

The namespaceId feature is in public preview.

Returns:

  • (String)

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

#targetsArray<String>

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

Returns:

  • (Array<String>)

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