Class: Aws::IoT::Types::DescribeJobTemplateResponse

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

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#abort_config ⇒ Types::AbortConfig

The criteria that determine when and how a job abort takes place.

Returns:



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ Time

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

Returns:

  • (Time) 


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A description of the job template.

Returns:

  • (String) 


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#document ⇒ String

The job document.

Returns:

  • (String) 


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#document_source ⇒ String

An S3 link to the job document.

Returns:

  • (String) 


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#job_executions_retry_config ⇒ Types::JobExecutionsRetryConfig

The configuration that determines how many retries are allowed for each failure type for a job.

Returns:



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig

Allows you to create a staged rollout of a job.

Returns:



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#job_template_arn ⇒ String

The ARN of the job template.

Returns:

  • (String) 


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#job_template_id ⇒ String

The unique identifier of the job template.

Returns:

  • (String) 


5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#maintenance_windows ⇒ Array<Types::MaintenanceWindow>

Allows you to configure an optional maintenance window for the rollout of a job document to all devices in the target group for a job.

Returns:



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#presigned_url_config ⇒ Types::PresignedUrlConfig

Configuration for pre-signed S3 URLs.

Returns:



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_config ⇒ Types::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:



5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
 
# File 'gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb', line 5378

class DescribeJobTemplateResponse < Struct.new(
  :job_template_arn,
  :job_template_id,
  :description,
  :document_source,
  :document,
  :created_at,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :job_executions_retry_config,
  :maintenance_windows)
  SENSITIVE = []
  include Aws::Structure
end