Skip to content

AssociateTargetsWithJobRequest

Source code in docs_src/capo_iot/types/associate_targets_with_job_request.py
class AssociateTargetsWithJobRequest(TypedDict, closed=True):
    targets: "capo_iot.types.job_targets.JobTargets"
    """<p>A list of thing group ARNs that define the targets of the job.</p>"""
    job_id: "capo_iot.types.job_id.JobId"
    """<p>The unique identifier you assigned to this job when it was created.</p>"""
    comment: NotRequired["capo_iot.types.comment.Comment"]
    """<p>An optional comment string describing why the job was associated with the targets.</p>"""
    namespace_id: NotRequired["capo_iot.types.namespace_id.NamespaceId"]
    """<p>The namespace used to indicate that a job is a customer-managed job.</p> <p>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.</p> <p> <code>$aws/things/<i>THING_NAME</i>/jobs/<i>JOB_ID</i>/notify-namespace-<i>NAMESPACE_ID</i>/</code> </p> <note> <p>The <code>namespaceId</code> feature is only supported by IoT Greengrass at this time. For more information, see <a href="https://docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html">Setting up IoT Greengrass core devices.</a> </p> </note>"""

comment instance-attribute

comment: NotRequired[Comment]

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

job_id instance-attribute

job_id: JobId

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

namespace_id instance-attribute

namespace_id: NotRequired[NamespaceId]

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/

The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.

targets instance-attribute

targets: JobTargets

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