Struct aws_sdk_iot::model::Job
source · [−]#[non_exhaustive]pub struct Job {Show 21 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<DateTime>,
pub last_updated_at: Option<DateTime>,
pub completed_at: Option<DateTime>,
pub job_process_details: Option<JobProcessDetails>,
pub timeout_config: Option<TimeoutConfig>,
pub namespace_id: Option<String>,
pub job_template_arn: Option<String>,
pub job_executions_retry_config: Option<JobExecutionsRetryConfig>,
pub document_parameters: Option<HashMap<String, 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<DateTime>
The time, in seconds since the epoch, when the job was created.
last_updated_at: Option<DateTime>
The time, in seconds since the epoch, when the job was last updated.
completed_at: Option<DateTime>
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.
job_executions_retry_config: Option<JobExecutionsRetryConfig>
The configuration for the criteria to retry the job.
document_parameters: Option<HashMap<String, String>>
A key-value map that pairs the patterns that need to be replaced in a managed template job document schema. You can use the description of each key as a guidance to specify the inputs during runtime when creating a job.
Implementations
sourceimpl Job
impl Job
sourcepub fn job_arn(&self) -> Option<&str>
pub fn job_arn(&self) -> Option<&str>
An ARN identifying the job with format "arn:aws:iot:region:account:job/jobId".
sourcepub fn job_id(&self) -> Option<&str>
pub fn job_id(&self) -> Option<&str>
The unique identifier you assigned to this job when it was created.
sourcepub fn target_selection(&self) -> Option<&TargetSelection>
pub fn target_selection(&self) -> 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.
sourcepub fn status(&self) -> Option<&JobStatus>
pub fn status(&self) -> Option<&JobStatus>
The status of the job, one of IN_PROGRESS
, CANCELED
, DELETION_IN_PROGRESS
or COMPLETED
.
sourcepub fn force_canceled(&self) -> Option<bool>
pub fn force_canceled(&self) -> Option<bool>
Will be true
if the job was canceled with the optional force
parameter set to true
.
sourcepub fn reason_code(&self) -> Option<&str>
pub fn reason_code(&self) -> Option<&str>
If the job was updated, provides the reason code for the update.
sourcepub fn comment(&self) -> Option<&str>
pub fn comment(&self) -> Option<&str>
If the job was updated, describes the reason for the update.
sourcepub fn targets(&self) -> Option<&[String]>
pub fn targets(&self) -> Option<&[String]>
A list of IoT things and thing groups to which the job should be sent.
sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A short text description of the job.
sourcepub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>
pub fn presigned_url_config(&self) -> Option<&PresignedUrlConfig>
Configuration for pre-signed S3 URLs.
sourcepub fn job_executions_rollout_config(
&self
) -> Option<&JobExecutionsRolloutConfig>
pub fn job_executions_rollout_config(
&self
) -> Option<&JobExecutionsRolloutConfig>
Allows you to create a staged rollout of a job.
sourcepub fn abort_config(&self) -> Option<&AbortConfig>
pub fn abort_config(&self) -> Option<&AbortConfig>
Configuration for criteria to abort the job.
sourcepub fn created_at(&self) -> Option<&DateTime>
pub fn created_at(&self) -> Option<&DateTime>
The time, in seconds since the epoch, when the job was created.
sourcepub fn last_updated_at(&self) -> Option<&DateTime>
pub fn last_updated_at(&self) -> Option<&DateTime>
The time, in seconds since the epoch, when the job was last updated.
sourcepub fn completed_at(&self) -> Option<&DateTime>
pub fn completed_at(&self) -> Option<&DateTime>
The time, in seconds since the epoch, when the job was completed.
sourcepub fn job_process_details(&self) -> Option<&JobProcessDetails>
pub fn job_process_details(&self) -> Option<&JobProcessDetails>
Details about the job process.
sourcepub fn timeout_config(&self) -> Option<&TimeoutConfig>
pub fn timeout_config(&self) -> 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
.
sourcepub fn namespace_id(&self) -> Option<&str>
pub fn namespace_id(&self) -> Option<&str>
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.
sourcepub fn job_template_arn(&self) -> Option<&str>
pub fn job_template_arn(&self) -> Option<&str>
The ARN of the job template used to create the job.
sourcepub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>
pub fn job_executions_retry_config(&self) -> Option<&JobExecutionsRetryConfig>
The configuration for the criteria to retry the job.
Trait Implementations
impl StructuralPartialEq for Job
Auto Trait Implementations
impl RefUnwindSafe for Job
impl Send for Job
impl Sync for Job
impl Unpin for Job
impl UnwindSafe for Job
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more