Amazonka.IoT.AssociateTargetsWithJob

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.

Creating a Request

data AssociateTargetsWithJob

See: newAssociateTargetsWithJob smart constructor.

Constructors

AssociateTargetsWithJob'

Fields

• comment :: Maybe Text

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

• namespaceId :: Maybe Text

  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 in public preview.

• targets :: NonEmpty Text

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

• jobId :: Text

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

Instances

ToJSON AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

toJSON :: AssociateTargetsWithJob -> Value

toEncoding :: AssociateTargetsWithJob -> Encoding

toJSONList :: [AssociateTargetsWithJob] -> Value

toEncodingList :: [AssociateTargetsWithJob] -> Encoding

ToHeaders AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

toHeaders :: AssociateTargetsWithJob -> [Header]

ToPath AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

toPath :: AssociateTargetsWithJob -> ByteString

ToQuery AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

toQuery :: AssociateTargetsWithJob -> QueryString

AWSRequest AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Associated Types

type AWSResponse AssociateTargetsWithJob

Methods

request :: (Service -> Service) -> AssociateTargetsWithJob -> Request AssociateTargetsWithJob

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy AssociateTargetsWithJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse AssociateTargetsWithJob)))

Generic AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Associated Types

type Rep AssociateTargetsWithJob :: Type -> Type

Methods

from :: AssociateTargetsWithJob -> Rep AssociateTargetsWithJob x

to :: Rep AssociateTargetsWithJob x -> AssociateTargetsWithJob

Read AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

readsPrec :: Int -> ReadS AssociateTargetsWithJob

readList :: ReadS [AssociateTargetsWithJob]

readPrec :: ReadPrec AssociateTargetsWithJob

readListPrec :: ReadPrec [AssociateTargetsWithJob]

Show AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

showsPrec :: Int -> AssociateTargetsWithJob -> ShowS

show :: AssociateTargetsWithJob -> String

showList :: [AssociateTargetsWithJob] -> ShowS

NFData AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

rnf :: AssociateTargetsWithJob -> ()

Eq AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

(==) :: AssociateTargetsWithJob -> AssociateTargetsWithJob -> Bool

(/=) :: AssociateTargetsWithJob -> AssociateTargetsWithJob -> Bool

Hashable AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

hashWithSalt :: Int -> AssociateTargetsWithJob -> Int

hash :: AssociateTargetsWithJob -> Int

type AWSResponse AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

type AWSResponse AssociateTargetsWithJob = AssociateTargetsWithJobResponse

type Rep AssociateTargetsWithJob

Defined in Amazonka.IoT.AssociateTargetsWithJob

type Rep AssociateTargetsWithJob = D1 ('MetaData "AssociateTargetsWithJob" "Amazonka.IoT.AssociateTargetsWithJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "AssociateTargetsWithJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "comment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "namespaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "targets") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :*: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newAssociateTargetsWithJob

Arguments

:: NonEmpty Text

AssociateTargetsWithJob

-> Text

AssociateTargetsWithJob

-> AssociateTargetsWithJob

Create a value of AssociateTargetsWithJob with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateTargetsWithJob, associateTargetsWithJob_comment - An optional comment string describing why the job was associated with the targets.

AssociateTargetsWithJob, associateTargetsWithJob_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 in public preview.

AssociateTargetsWithJob, associateTargetsWithJob_targets - A list of thing group ARNs that define the targets of the job.

AssociateTargetsWithJob, associateTargetsWithJob_jobId - The unique identifier you assigned to this job when it was created.

Request Lenses

associateTargetsWithJob_comment :: Lens' AssociateTargetsWithJob (Maybe Text)

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

associateTargetsWithJob_namespaceId :: Lens' AssociateTargetsWithJob (Maybe Text)

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 in public preview.

associateTargetsWithJob_targets :: Lens' AssociateTargetsWithJob (NonEmpty Text)

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

associateTargetsWithJob_jobId :: Lens' AssociateTargetsWithJob Text

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

Destructuring the Response

data AssociateTargetsWithJobResponse

See: newAssociateTargetsWithJobResponse smart constructor.

Constructors

AssociateTargetsWithJobResponse'

Fields

• description :: Maybe Text

  A short text description of the job.

• jobArn :: Maybe Text

  An ARN identifying the job.

• jobId :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic AssociateTargetsWithJobResponse

Defined in Amazonka.IoT.AssociateTargetsWithJob

Associated Types

type Rep AssociateTargetsWithJobResponse :: Type -> Type

Methods

from :: AssociateTargetsWithJobResponse -> Rep AssociateTargetsWithJobResponse x

to :: Rep AssociateTargetsWithJobResponse x -> AssociateTargetsWithJobResponse

Read AssociateTargetsWithJobResponse

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

readsPrec :: Int -> ReadS AssociateTargetsWithJobResponse

readList :: ReadS [AssociateTargetsWithJobResponse]

readPrec :: ReadPrec AssociateTargetsWithJobResponse

readListPrec :: ReadPrec [AssociateTargetsWithJobResponse]

Show AssociateTargetsWithJobResponse

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

showsPrec :: Int -> AssociateTargetsWithJobResponse -> ShowS

show :: AssociateTargetsWithJobResponse -> String

showList :: [AssociateTargetsWithJobResponse] -> ShowS

NFData AssociateTargetsWithJobResponse

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

rnf :: AssociateTargetsWithJobResponse -> ()

Eq AssociateTargetsWithJobResponse

Defined in Amazonka.IoT.AssociateTargetsWithJob

Methods

(==) :: AssociateTargetsWithJobResponse -> AssociateTargetsWithJobResponse -> Bool

(/=) :: AssociateTargetsWithJobResponse -> AssociateTargetsWithJobResponse -> Bool

type Rep AssociateTargetsWithJobResponse

Defined in Amazonka.IoT.AssociateTargetsWithJob

type Rep AssociateTargetsWithJobResponse = D1 ('MetaData "AssociateTargetsWithJobResponse" "Amazonka.IoT.AssociateTargetsWithJob" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "AssociateTargetsWithJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "jobArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newAssociateTargetsWithJobResponse

Arguments

:: Int

$sel:httpStatus:AssociateTargetsWithJobResponse'

-> AssociateTargetsWithJobResponse

Create a value of AssociateTargetsWithJobResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

AssociateTargetsWithJobResponse, associateTargetsWithJobResponse_description - A short text description of the job.

AssociateTargetsWithJobResponse, associateTargetsWithJobResponse_jobArn - An ARN identifying the job.

AssociateTargetsWithJob, associateTargetsWithJobResponse_jobId - The unique identifier you assigned to this job when it was created.

$sel:httpStatus:AssociateTargetsWithJobResponse', associateTargetsWithJobResponse_httpStatus - The response's http status code.

Response Lenses

associateTargetsWithJobResponse_description :: Lens' AssociateTargetsWithJobResponse (Maybe Text)

A short text description of the job.

associateTargetsWithJobResponse_jobArn :: Lens' AssociateTargetsWithJobResponse (Maybe Text)

An ARN identifying the job.

associateTargetsWithJobResponse_jobId :: Lens' AssociateTargetsWithJobResponse (Maybe Text)

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

associateTargetsWithJobResponse_httpStatus :: Lens' AssociateTargetsWithJobResponse Int

The response's http status code.