How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon IoT Device Defender Job Templates API

The Job Templates API from Amazon IoT Device Defender — 2 operation(s) for job templates.

Amazon IoT Device Defender Job Templates API is one of 69 APIs that Amazon IoT Device Defender publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Job Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 4 operations across 2 paths, and defines 49 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://iot.{region}.amazonaws.com, https://iot.{region}.amazonaws.com, http://iot.{region}.amazonaws.com.cn, https://iot.{region}.amazonaws.com.cn.

4 operations 2 paths 49 schemas 1 DELETE2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://iot.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IoT Device Defender Job Templates API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Job Templates 4
PUT
/job-templates/{jobTemplateId}
Amazon IoT Device Defender Create Job Template
CreateJobTemplate 8 params body → 200480481482483484485
DELETE
/job-templates/{jobTemplateId}
Amazon IoT Device Defender Delete Job Template
DeleteJobTemplate 8 params → 200480481482483
GET
/job-templates/{jobTemplateId}
Amazon IoT Device Defender Describe Job Template
DescribeJobTemplate 8 params → 200480481482483
GET
/job-templates
Amazon IoT Device Defender List Job Templates
ListJobTemplates 9 params → 200480481482

Schemas 49

The contract defines 49 schemas that model the data the API accepts and returns. The most detailed are DescribeJobTemplateResponse (12 properties), JobTemplateSummary (4 properties), AbortCriteria (4 properties), ExponentialRolloutRate (3 properties). Each schema is shown below with its type and property counts.

NumberOfThings
integer
MinimumNumberOfExecutedThings
integer
CreateJobTemplateResponse
object
2 properties
JobTemplateSummary
object
An object that contains information about the job template.
4 properties
DurationInMinutes
integer
MaxJobExecutionsPerMin
integer
RetryCriteriaList
array
JobTemplateSummaryList
array
AbortCriteria
object
The criteria that determine when and how a job abort takes place.
4 properties 4 required
DateType
string
ListJobTemplatesResponse
object
2 properties
AbortThresholdPercentage
number
AbortConfig
object
The criteria that determine when and how a job abort takes place.
1 property 1 required
JobDocument
string
NextToken
string
JobExecutionsRolloutConfig
object
Allows you to create a staged rollout of a job.
2 properties
TagValue
string
PresignedUrlConfig
object
Configuration for pre-signed S3 URLs.
2 properties
InvalidRequestException
JobExecutionsRetryConfig
object
The configuration that determines how many retries are allowed for each failure type for a job.
1 property 1 required
DescribeJobTemplateResponse
object
12 properties
ConflictException
JobDescription
string
RolloutRatePerMinute
integer
MaintenanceWindow
object
An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a…
2 properties 2 required
RetryCriteria
object
The criteria that determines how many retries are allowed for each failure type for a job.
2 properties 2 required
InternalFailureException
AbortAction
string
LimitExceededException
ThrottlingException
ExpiresInSec
integer
JobDocumentSource
string
RoleArn
string
IncrementFactor
number
ExponentialRolloutRate
object
Allows you to create an exponential rate of rollout for a job.
3 properties 3 required
ResourceNotFoundException
JobTemplateId
string
NumberOfRetries
integer
TimeoutConfig
object
Specifies the amount of time each device has to finish its execution of the job. A timer is started when the job execution status is set to INPROGRESS . If the…
1 property
Tag
object
A set of key/value pairs that are used to manage the resource.
2 properties 1 required
JobExecutionFailureType
string
InProgressTimeoutInMinutes
integer
AbortCriteriaList
array
RetryableFailureType
string
MaintenanceWindows
array
TagKey
string
RateIncreaseCriteria
object
Allows you to define a criteria to initiate the increase in rate of rollout for a job.
2 properties
JobTemplateArn
string
CronExpression
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-device-defender-job-templates-api-openapi.yml Raw ↑

Other APIs Amazon IoT Device Defender publishes across the network.

Amazon IoT Device Defender Accept Certificate Transfer API
Amazon IoT Device Defender Active Violations API
Amazon IoT Device Defender Attached Policies API
Amazon IoT Device Defender Audit API
Amazon IoT Device Defender Authorizer API
Amazon IoT Device Defender Authorizers API
Amazon IoT Device Defender Behavior Model Training API
Amazon IoT Device Defender Billing Groups API
Amazon IoT Device Defender Cacertificate API
Amazon IoT Device Defender Cacertificates API
Amazon IoT Device Defender Cancel Certificate Transfer API
Amazon IoT Device Defender Certificate API
Where this information came from

This is an independent, third-party profile of Amazon IoT Device Defender Job Templates API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.