Amazon IoT Core · Schema

AwsJobAbortCriteriaList

AwsJobAbortCriteriaList schema

Device ManagementIoTMQTTMessage Routing
View JSON Schema on GitHub

JSON Schema

iot-core-aws-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-core/refs/heads/main/json-schema/iot-core-aws-job-abort-criteria-list-schema.json",
  "title": "AwsJobAbortCriteriaList",
  "description": "AwsJobAbortCriteriaList schema",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "failureType",
      "action",
      "thresholdPercentage",
      "minNumberOfExecutedThings"
    ],
    "properties": {
      "failureType": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AwsJobAbortCriteriaFailureType"
          },
          {
            "description": "The type of job execution failures that can initiate a job abort."
          }
        ]
      },
      "action": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AwsJobAbortCriteriaAbortAction"
          },
          {
            "description": "The type of job action to take to initiate the job abort."
          }
        ]
      },
      "thresholdPercentage": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AwsJobAbortCriteriaAbortThresholdPercentage"
          },
          {
            "description": "<p>The minimum percentage of job execution failures that must occur to initiate the job abort.</p> <p>Amazon Web Services IoT Core supports up to two digits after the decimal (for example, 10.9 and 10.99, but not 10.999).</p>"
          }
        ]
      },
      "minNumberOfExecutedThings": {
        "allOf": [
          {
            "$ref": "#/components/schemas/AwsJobAbortCriteriaMinimumNumberOfExecutedThings"
          },
          {
            "description": "The minimum number of things which must receive job execution notifications before the job can be aborted."
          }
        ]
      }
    },
    "description": "The criteria that determine when and how a job abort takes place."
  }
}