Class: Aws::IoT::Types::DescribeJobTemplateResponse
- Inherits:
-
Struct
- Object
- Struct
- Aws::IoT::Types::DescribeJobTemplateResponse
- Defined in:
- gems/aws-sdk-iot/lib/aws-sdk-iot/types.rb
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#abort_config ⇒ Types::AbortConfig
The criteria that determine when and how a job abort takes place.
-
#created_at ⇒ Time
The time, in seconds since the epoch, when the job template was created.
-
#description ⇒ String
A description of the job template.
-
#document ⇒ String
The job document.
-
#document_source ⇒ String
An S3 link to the job document.
-
#job_executions_retry_config ⇒ Types::JobExecutionsRetryConfig
The configuration that determines how many retries are allowed for each failure type for a job.
-
#job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig
Allows you to create a staged rollout of a job.
-
#job_template_arn ⇒ String
The ARN of the job template.
-
#job_template_id ⇒ String
The unique identifier of the job template.
-
#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.
-
#presigned_url_config ⇒ Types::PresignedUrlConfig
Configuration for pre-signed S3 URLs.
-
#timeout_config ⇒ Types::TimeoutConfig
Specifies the amount of time each device has to finish its execution of the job.
Instance Attribute Details
#abort_config ⇒ Types::AbortConfig
The criteria that determine when and how a job abort takes place.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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
.
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 |