IoTJobAbortCriteriaList

IoTJobAbortCriteriaList schema

Edge ComputingIoTLambdaMachine LearningReal-Time Processing
View JSON Schema on GitHub

JSON Schema

iot-greengrass-io-t-job-abort-criteria-list-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-greengrass/refs/heads/main/json-schema/iot-greengrass-io-t-job-abort-criteria-list-schema.json",
  "title": "IoTJobAbortCriteriaList",
  "description": "IoTJobAbortCriteriaList schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "failureType",
      "action",
      "thresholdPercentage",
      "minNumberOfExecutedThings"
    ],
    "properties": {
      "failureType": {
        "allOf": [
          {
            "$ref": "#/components/schemas/IoTJobExecutionFailureType"
          },
          {
            "description": "The type of job deployment failure that can cancel a job."
          }
        ]
      },
      "action": {
        "allOf": [
          {
            "$ref": "#/components/schemas/IoTJobAbortAction"
          },
          {
            "description": "The action to perform when the criteria are met."
          }
        ]
      },
      "thresholdPercentage": {
        "allOf": [
          {
            "$ref": "#/components/schemas/IoTJobAbortThresholdPercentage"
          },
          {
            "description": "<p>The minimum percentage of <code>failureType</code> failures that occur before the job can cancel.</p> <p>This parameter supports up to two digits after the decimal (for example, you can specify <code>10.9</code> or <code>10.99</code>, but not <code>10.999</code>).</p>"
          }
        ]
      },
      "minNumberOfExecutedThings": {
        "allOf": [
          {
            "$ref": "#/components/schemas/IoTJobMinimumNumberOfExecutedThings"
          },
          {
            "description": "The minimum number of things that receive the configuration before the job can cancel."
          }
        ]
      }
    },
    "description": "<p>Contains criteria that define when and how to cancel a job.</p> <p>The deployment stops if the following conditions are true:</p> <ol> <li> <p>The number of things that receive the deployment exceeds the <code>minNumberOfExecutedThings</code>.</p> </li> <li> <p>The percentage of failures with type <code>failureType</code> exceeds the <code>thresholdPercentage</code>.</p> </li> </ol>"
  }
}