Struct aws_sdk_iot::model::Job [−][src]
#[non_exhaustive]pub struct Job {Show 19 fields
pub job_arn: Option<String>,
pub job_id: Option<String>,
pub target_selection: Option<TargetSelection>,
pub status: Option<JobStatus>,
pub force_canceled: Option<bool>,
pub reason_code: Option<String>,
pub comment: Option<String>,
pub targets: Option<Vec<String>>,
pub description: Option<String>,
pub presigned_url_config: Option<PresignedUrlConfig>,
pub job_executions_rollout_config: Option<JobExecutionsRolloutConfig>,
pub abort_config: Option<AbortConfig>,
pub created_at: Option<Instant>,
pub last_updated_at: Option<Instant>,
pub completed_at: Option<Instant>,
pub job_process_details: Option<JobProcessDetails>,
pub timeout_config: Option<TimeoutConfig>,
pub namespace_id: Option<String>,
pub job_template_arn: Option<String>,
}
Expand description
The Job
object contains details about a job.
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.job_arn: Option<String>
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
job_id: Option<String>
The unique identifier you assigned to this job when it was created.
target_selection: Option<TargetSelection>
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
status: Option<JobStatus>
The status of the job, one of IN_PROGRESS
, CANCELED
,
DELETION_IN_PROGRESS
or COMPLETED
.
force_canceled: Option<bool>
Will be true
if the job was canceled with the optional force
parameter set to
true
.
reason_code: Option<String>
If the job was updated, provides the reason code for the update.
comment: Option<String>
If the job was updated, describes the reason for the update.
targets: Option<Vec<String>>
A list of IoT things and thing groups to which the job should be sent.
description: Option<String>
A short text description of the job.
presigned_url_config: Option<PresignedUrlConfig>
Configuration for pre-signed S3 URLs.
job_executions_rollout_config: Option<JobExecutionsRolloutConfig>
Allows you to create a staged rollout of a job.
abort_config: Option<AbortConfig>
Configuration for criteria to abort the job.
created_at: Option<Instant>
The time, in seconds since the epoch, when the job was created.
last_updated_at: Option<Instant>
The time, in seconds since the epoch, when the job was last updated.
completed_at: Option<Instant>
The time, in seconds since the epoch, when the job was completed.
job_process_details: Option<JobProcessDetails>
Details about the job process.
timeout_config: Option<TimeoutConfig>
Specifies the amount of time each device has to finish its execution of the job. A timer
is started when the job execution status is set to IN_PROGRESS
. If the job
execution status is not set to another terminal state before the timer expires, it will
be automatically set to TIMED_OUT
.
namespace_id: Option<String>
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.
job_template_arn: Option<String>
The ARN of the job template used to create the job.
Implementations
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
The unique identifier you assigned to this job when it was created.
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a device when the thing representing the device is added to a target group, even after the job was completed by all things originally in the group.
The status of the job, one of IN_PROGRESS
, CANCELED
,
DELETION_IN_PROGRESS
or COMPLETED
.
Will be true
if the job was canceled with the optional force
parameter set to
true
.
If the job was updated, provides the reason code for the update.
If the job was updated, describes the reason for the update.
A list of IoT things and thing groups to which the job should be sent.
A short text description of the job.
Configuration for pre-signed S3 URLs.
Allows you to create a staged rollout of a job.
Configuration for criteria to abort the job.
The time, in seconds since the epoch, when the job was created.
The time, in seconds since the epoch, when the job was last updated.
The time, in seconds since the epoch, when the job was completed.
Details about the job process.
Specifies the amount of time each device has to finish its execution of the job. A timer
is started when the job execution status is set to IN_PROGRESS
. If the job
execution status is not set to another terminal state before the timer expires, it will
be automatically set to TIMED_OUT
.
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.
The ARN of the job template used to create the job.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Job
impl UnwindSafe for Job
Blanket Implementations
Mutably borrows from an owned value. Read more
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more