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

Class: Aws::IoT::Types::Job

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

Overview

The Job object contains details about a job.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#abort_configTypes::AbortConfig

Configuration for criteria to abort the job.

Returns:

#commentString

If the job was updated, describes the reason for the update.

Returns:

  • (String)

    If the job was updated, describes the reason for the update.

#completed_atTime

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

Returns:

  • (Time)

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

#created_atTime

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

Returns:

  • (Time)

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

#descriptionString

A short text description of the job.

Returns:

  • (String)

    A short text description of the job.

#force_canceledBoolean

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

Returns:

  • (Boolean)

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

#job_arnString

An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".

Returns:

  • (String)

    An ARN identifying the job with format \"arn:aws:iot:region:account:job/jobId\".

#job_executions_rollout_configTypes::JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

Returns:

#job_idString

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

Returns:

  • (String)

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

#job_process_detailsTypes::JobProcessDetails

Details about the job process.

Returns:

#last_updated_atTime

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

Returns:

  • (Time)

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

#presigned_url_configTypes::PresignedUrlConfig

Configuration for pre-signed S3 URLs.

Returns:

#reason_codeString

If the job was updated, provides the reason code for the update.

Returns:

  • (String)

    If the job was updated, provides the reason code for the update.

#statusString

The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

Possible values:

  • IN_PROGRESS
  • CANCELED
  • COMPLETED
  • DELETION_IN_PROGRESS

Returns:

  • (String)

    The status of the job, one of IN_PROGRESS, CANCELED, DELETION_IN_PROGRESS or COMPLETED.

#target_selectionString

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.

Possible values:

  • CONTINUOUS
  • SNAPSHOT

Returns:

  • (String)

    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).

#targetsArray<String>

A list of IoT things and thing groups to which the job should be sent.

Returns:

  • (Array<String>)

    A list of IoT things and thing groups to which the job should be sent.

#timeout_configTypes::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.

Returns:

  • (Types::TimeoutConfig)

    Specifies the amount of time each device has to finish its execution of the job.