Contains criteria that define when and how to cancel a job.
The deployment stops if the following conditions are true:
The number of things that receive the deployment exceeds the minNumberOfExecutedThings.
The percentage of failures with type failureType exceeds the thresholdPercentage.
Type: objectProperties: 4Required: 4
Amazon Web ServicesEdge ComputingIoTLambdaMachine LearningReal-Time Processing
IoTJobAbortCriteria is a JSON Structure definition published by Amazon IoT Greengrass, describing 4 properties, of which 4 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.
{
"$schema": "https://json-structure.org/meta/core/v0/#",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-iot-greengrass/refs/heads/main/json-structure/iot-greengrass-io-t-job-abort-criteria-structure.json",
"name": "IoTJobAbortCriteria",
"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>",
"type": "object",
"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."
}
]
}
},
"required": [
"failureType",
"action",
"thresholdPercentage",
"minNumberOfExecutedThings"
]
}
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.