class Aws::IoT::Types::CreateJobRequest

@return [Hash<String,String>]
job document.
Parameters of a managed template that you can specify to create the
@!attribute [rw] document_parameters
@return [String]
The ARN of the job template used to create the job.
@!attribute [rw] job_template_arn
@return [String]
</note>
<note markdown=“1”> The ‘namespaceId` feature is in public preview.
`$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`
in the following format.
Core sends jobs notifications to MQTT topics that contain the value
When you specify a value for this parameter, Amazon Web Services IoT
The namespace used to indicate that a job is a customer-managed job.
@!attribute [rw] namespace_id
@return [Array<Types::Tag>]
Metadata which can be used to manage the job.
@!attribute [rw] tags
@return [Types::TimeoutConfig]
automatically set to `TIMED_OUT`.
another terminal state before the time expires, it will be
set to `IN_PROGRESS`. If the job execution status is not set to
of the job. The timer is started when the job execution status is
Specifies the amount of time each device has to finish its execution
@!attribute [rw] timeout_config
@return [Types::AbortConfig]
Allows you to create criteria to abort a job.
@!attribute [rw] abort_config
@return [Types::JobExecutionsRolloutConfig]
Allows you to create a staged rollout of the job.
@!attribute [rw] job_executions_rollout_config
@return [String]
after the job was completed by all things originally in the group.
will run on a thing when the thing is added to a target group, even
on a thing when a change is detected in a target. For example, a job
completed the job (SNAPSHOT). If continuous, the job may also be run
be complete after all those things specified as targets have
Specifies whether the job will continue to run (CONTINUOUS), or will
@!attribute [rw] target_selection
@return [Types::PresignedUrlConfig]
Configuration information for pre-signed S3 URLs.
@!attribute [rw] presigned_url_config
@return [String]
A short text description of the job.
@!attribute [rw] description
@return [String]
`documentSource`.
The job document. Required if you don’t specify a value for
@!attribute [rw] document
@return [String]
</note>
bucket to which you are linking.
where bucket is your bucket name and key is the object in the
`${aws:iot:s3-presigned-url:s3.amazonaws.com/bucket/key}‘
The placeholder link is of the following form:
placeholder link when specifying the document.
<note markdown=“1”> If the job document resides in an S3 bucket, you must use a
value for `document`.
An S3 link to the job document. Required if you don’t specify a
@!attribute [rw] document_source
@return [Array<String>]
A list of things and thing groups to which the job should be sent.
@!attribute [rw] targets
@return [String]
and “_” are valid for use here.
account. We recommend using a UUID. Alpha-numeric characters, “-”
A job identifier which must be unique for your Amazon Web Services
@!attribute [rw] job_id
}
},
“ParameterKey” => “ParameterValue”,
document_parameters: {
job_template_arn: “JobTemplateArn”,
namespace_id: “NamespaceId”,
],
},
value: “TagValue”,
key: “TagKey”, # required
{
tags: [
},
in_progress_timeout_in_minutes: 1,
timeout_config: {
},
],
},
min_number_of_executed_things: 1, # required
threshold_percentage: 1.0, # required
action: “CANCEL”, # required, accepts CANCEL
failure_type: “FAILED”, # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
{
criteria_list: [ # required
abort_config: {
},
},
},
number_of_succeeded_things: 1,
number_of_notified_things: 1,
rate_increase_criteria: { # required
increment_factor: 1.0, # required
base_rate_per_minute: 1, # required
exponential_rate: {
maximum_per_minute: 1,
job_executions_rollout_config: {
target_selection: “CONTINUOUS”, # accepts CONTINUOUS, SNAPSHOT
},
expires_in_sec: 1,
role_arn: “RoleArn”,
presigned_url_config: {
description: “JobDescription”,
document: “JobDocument”,
document_source: “JobDocumentSource”,
targets: [“TargetArn”], # required
job_id: “JobId”, # required
{
data as a hash:
@note When making an API call, you may pass CreateJobRequest