Amazon IoT Device Management · JSON Structure

Iot Device Management Aws Job Exponential Rollout Rate Structure

The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.

Type: object Properties: 3 Required: 3
Device ManagementFleet ManagementIoTOTA Updates

AwsJobExponentialRolloutRate is a JSON Structure definition published by Amazon IoT Device Management, describing 3 properties, of which 3 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

baseRatePerMinute incrementFactor rateIncreaseCriteria

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-device-management/refs/heads/main/json-structure/iot-device-management-aws-job-exponential-rollout-rate-structure.json",
  "name": "AwsJobExponentialRolloutRate",
  "description": "The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.",
  "type": "object",
  "properties": {
    "baseRatePerMinute": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AwsJobRolloutRatePerMinute"
        },
        {
          "description": "The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout."
        }
      ]
    },
    "incrementFactor": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AwsJobRolloutIncrementFactor"
        },
        {
          "description": "The rate of increase for a job rollout. The number of things notified is multiplied by this factor."
        }
      ]
    },
    "rateIncreaseCriteria": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AwsJobRateIncreaseCriteria"
        },
        {
          "description": "<p>The criteria to initiate the increase in rate of rollout for a job.</p> <p>Amazon Web Services IoT Core supports up to one digit after the decimal (for example, 1.5, but not 1.55).</p>"
        }
      ]
    }
  },
  "required": [
    "baseRatePerMinute",
    "incrementFactor",
    "rateIncreaseCriteria"
  ]
}