AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::IoT::Types::JobExecution

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

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

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#approximate_seconds_before_timed_outInteger

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.

Returns:

  • (Integer)

    The estimated number of seconds that remain before the job execution status will be changed to TIMED_OUT.

#execution_numberInteger

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.

Returns:

  • (Integer)

    A string (consisting of the digits \"0\" through \"9\") which identifies this particular job execution on this particular device.

#force_canceledBoolean

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

Returns:

  • (Boolean)

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

#job_idString

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

Returns:

  • (String)

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

#last_updated_atTime

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

Returns:

  • (Time)

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

#queued_atTime

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

Returns:

  • (Time)

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

#started_atTime

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

Returns:

  • (Time)

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

#statusString

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

Possible values:

  • QUEUED
  • IN_PROGRESS
  • SUCCEEDED
  • FAILED
  • TIMED_OUT
  • REJECTED
  • REMOVED
  • CANCELED

Returns:

  • (String)

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

#status_detailsTypes::JobExecutionStatusDetails

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

Returns:

#thing_arnString

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

Returns:

  • (String)

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

#version_numberInteger

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

Returns:

  • (Integer)

    The version of the job execution.