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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

Note:

When making an API call, you may pass AssociateTargetsWithJobRequest data as a hash:

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

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

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

Returns:

  • (String)


807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 807

class AssociateTargetsWithJobRequest < Struct.new(
  :targets,
  :job_id,
  :comment,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 807

class AssociateTargetsWithJobRequest < Struct.new(
  :targets,
  :job_id,
  :comment,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_idString

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.

Returns:

  • (String)


807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 807

class AssociateTargetsWithJobRequest < Struct.new(
  :targets,
  :job_id,
  :comment,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end

#targetsArray<String>

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

Returns:

  • (Array<String>)


807
808
809
810
811
812
813
814
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 807

class AssociateTargetsWithJobRequest < Struct.new(
  :targets,
  :job_id,
  :comment,
  :namespace_id)
  SENSITIVE = []
  include Aws::Structure
end