Struct JobExecution

#[non_exhaustive]
pub struct JobExecution {
    pub job_id: Option<String>,
    pub status: Option<JobExecutionStatus>,
    pub force_canceled: Option<bool>,
    pub status_details: Option<JobExecutionStatusDetails>,
    pub thing_arn: Option<String>,
    pub queued_at: Option<DateTime>,
    pub started_at: Option<DateTime>,
    pub last_updated_at: Option<DateTime>,
    pub execution_number: Option<i64>,
    pub version_number: i64,
    pub approximate_seconds_before_timed_out: Option<i64>,
}

The job execution object represents the execution of a job on a particular device.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

job_id: Option<String>

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

status: Option<JobExecutionStatus>

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

force_canceled: Option<bool>

Will be true if the job execution was canceled with the optional force parameter set to true.

status_details: Option<JobExecutionStatusDetails>

A collection of name/value pairs that describe the status of the job execution.

thing_arn: Option<String>

The ARN of the thing on which the job execution is running.

queued_at: Option<DateTime>

The time, in seconds since the epoch, when the job execution was queued.

started_at: Option<DateTime>

The time, in seconds since the epoch, when the job execution started.

last_updated_at: Option<DateTime>

The time, in seconds since the epoch, when the job execution was last updated.

execution_number: Option<i64>

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

version_number: i64

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

approximate_seconds_before_timed_out: Option<i64>

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

Implementations

impl JobExecution

pub fn job_id(&self) -> Option<&str>

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

pub fn status(&self) -> Option<&JobExecutionStatus>

The status of the job execution (IN_PROGRESS, QUEUED, FAILED, SUCCEEDED, TIMED_OUT, CANCELED, or REJECTED).

pub fn force_canceled(&self) -> Option<bool>

Will be true if the job execution was canceled with the optional force parameter set to true.

pub fn status_details(&self) -> Option<&JobExecutionStatusDetails>

A collection of name/value pairs that describe the status of the job execution.

pub fn thing_arn(&self) -> Option<&str>

The ARN of the thing on which the job execution is running.

pub fn queued_at(&self) -> Option<&DateTime>

The time, in seconds since the epoch, when the job execution was queued.

pub fn started_at(&self) -> Option<&DateTime>

The time, in seconds since the epoch, when the job execution started.

pub fn last_updated_at(&self) -> Option<&DateTime>

The time, in seconds since the epoch, when the job execution was last updated.

pub fn execution_number(&self) -> Option<i64>

A string (consisting of the digits "0" through "9") which identifies this particular job execution on this particular device. It can be used in commands which return or update job execution information.

pub fn version_number(&self) -> i64

The version of the job execution. Job execution versions are incremented each time they are updated by a device.

pub fn approximate_seconds_before_timed_out(&self) -> Option<i64>

The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The actual job execution timeout can occur up to 60 seconds later than the estimated duration. This value will not be included if the job execution has reached a terminal status.

impl JobExecution

pub fn builder() -> JobExecutionBuilder

Creates a new builder-style object to manufacture JobExecution.

Trait Implementations

impl Clone for JobExecution

fn clone(&self) -> JobExecution

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for JobExecution

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for JobExecution

fn eq(&self, other: &JobExecution) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for JobExecution