Class: Aws::IoT::Types::UpdateJobRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoT::Types::UpdateJobRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iot/types.rb

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #abort_config ⇒ Types::AbortConfig

  Allows you to create criteria to abort a job.

• #description ⇒ String

  A short text description of the job.

• #job_executions_retry_config ⇒ Types::JobExecutionsRetryConfig

  Allows you to create the criteria to retry a job.

• #job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig

  Allows you to create a staged rollout of the job.

• #job_id ⇒ String

  The ID of the job to be updated.

• #namespace_id ⇒ String

  The namespace used to indicate that a job is a customer-managed job.

• #presigned_url_config ⇒ Types::PresignedUrlConfig

  Configuration information 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

Allows you to create criteria to abort a job.

Returns:

• (Types::AbortConfig)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

A short text description of the job.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_executions_retry_config ⇒ Types::JobExecutionsRetryConfig

Allows you to create the criteria to retry a job.

Returns:

• (Types::JobExecutionsRetryConfig)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_executions_rollout_config ⇒ Types::JobExecutionsRolloutConfig

Allows you to create a staged rollout of the job.

Returns:

• (Types::JobExecutionsRolloutConfig)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_id ⇒ String

The ID of the job to be updated.

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end

#namespace_id ⇒ String

The namespace used to indicate that a job is a customer-managed job.

When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.

‘$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/`

<note markdown=“1”> The ‘namespaceId` feature is only supported by IoT Greengrass at this time. For more information, see [Setting up IoT Greengrass core devices.]

</note>

[1]: docs.aws.amazon.com/greengrass/v2/developerguide/setting-up.html

Returns:

• (String)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end

#presigned_url_config ⇒ Types::PresignedUrlConfig

Configuration information for pre-signed S3 URLs.

Returns:

• (Types::PresignedUrlConfig)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_config ⇒ Types::TimeoutConfig

Specifies the amount of time each device has to finish its execution of the job. The 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 time expires, it will be automatically set to `TIMED_OUT`.

Returns:

• (Types::TimeoutConfig)

# File 'lib/aws-sdk-iot/types.rb', line 17014

class UpdateJobRequest < Struct.new(
  :job_id,
  :description,
  :presigned_url_config,
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config,
  :namespace_id,
  :job_executions_retry_config)
  SENSITIVE = []
  include Aws::Structure
end