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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb

Overview

The Job object contains details about a job.

Instance Attribute Summary collapse

Instance Attribute Details

#commentString

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

Returns:

  • (String)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#completed_atTime

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

Returns:

  • (Time)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#created_atTime

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

Returns:

  • (Time)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#descriptionString

A short text description of the job.

Returns:

  • (String)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#document_parametersHash<String,String>

The parameters specified for the job document.

Returns:

  • (Hash<String,String>)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#job_arnString

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

Returns:

  • (String)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#job_executions_rollout_configTypes::JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.



3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#job_idString

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

Returns:

  • (String)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#job_process_detailsTypes::JobProcessDetails

Details about the job process.



3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#last_updated_atTime

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

Returns:

  • (Time)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#presigned_url_configTypes::PresignedUrlConfig

Configuration for pre-signed S3 URLs.



3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#statusString

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

Returns:

  • (String)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

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

Returns:

  • (String)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end

#targetsArray<String>

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

Returns:

  • (Array<String>)


3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 3612

class Job < Struct.new(
  :job_arn,
  :job_id,
  :target_selection,
  :status,
  :comment,
  :targets,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :created_at,
  :last_updated_at,
  :completed_at,
  :job_process_details,
  :document_parameters)
  include Aws::Structure
end