Class: Aws::GreengrassV2::Types::DeploymentIoTJobConfiguration

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

Overview

Note:

When making an API call, you may pass DeploymentIoTJobConfiguration data as a hash:

{
  job_executions_rollout_config: {
    exponential_rate: {
      base_rate_per_minute: 1, # required
      increment_factor: 1.0, # required
      rate_increase_criteria: { # required
        number_of_notified_things: 1,
        number_of_succeeded_things: 1,
      },
    },
    maximum_per_minute: 1,
  },
  abort_config: {
    criteria_list: [ # required
      {
        failure_type: "FAILED", # required, accepts FAILED, REJECTED, TIMED_OUT, ALL
        action: "CANCEL", # required, accepts CANCEL
        threshold_percentage: 1.0, # required
        min_number_of_executed_things: 1, # required
      },
    ],
  },
  timeout_config: {
    in_progress_timeout_in_minutes: 1,
  },
}

Contains information about an AWS IoT job configuration.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#abort_configTypes::IoTJobAbortConfig

The stop configuration for the job. This configuration defines when and how to stop a job rollout.



1218
1219
1220
1221
1222
1223
1224
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1218

class DeploymentIoTJobConfiguration < Struct.new(
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config)
  SENSITIVE = []
  include Aws::Structure
end

#job_executions_rollout_configTypes::IoTJobExecutionsRolloutConfig

The rollout configuration for the job. This configuration defines the rate at which the job rolls out to the fleet of target devices.



1218
1219
1220
1221
1222
1223
1224
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1218

class DeploymentIoTJobConfiguration < Struct.new(
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_configTypes::IoTJobTimeoutConfig

The timeout configuration for the job. This configuration defines the amount of time each device has to complete the job.



1218
1219
1220
1221
1222
1223
1224
# File 'gems/aws-sdk-greengrassv2/lib/aws-sdk-greengrassv2/types.rb', line 1218

class DeploymentIoTJobConfiguration < Struct.new(
  :job_executions_rollout_config,
  :abort_config,
  :timeout_config)
  SENSITIVE = []
  include Aws::Structure
end