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 Jobs API

The Jobs API from Amazon IoT Device Defender — 6 operation(s) for jobs.

Amazon IoT Device Defender Jobs 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. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 9 operations across 6 paths, and defines 91 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.

9 operations 6 paths 91 schemas 1 DELETE4 GET1 PATCH1 POST2 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 Jobs 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 9

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

Jobs 9
POST
/jobs/{jobId}/targets
Amazon IoT Device Defender Associate Targets with Job
AssociateTargetsWithJob 9 params body → 200480481482483484
PUT
/jobs/{jobId}/cancel
Amazon IoT Device Defender Cancel Job
CancelJob 9 params body → 200480481482483484
PUT
/jobs/{jobId}
Amazon IoT Device Defender Create Job
CreateJob 8 params body → 200480481482483484485
DELETE
/jobs/{jobId}
Amazon IoT Device Defender Delete Job
DeleteJob 10 params → 200480481482483484485
GET
/jobs/{jobId}
Amazon IoT Device Defender Describe Job
DescribeJob 8 params → 200480481482483
PATCH
/jobs/{jobId}
Amazon IoT Device Defender Update Job
UpdateJob 9 params body → 200480481482483
GET
/jobs/{jobId}/job-document
Amazon IoT Device Defender Get Job Document
GetJobDocument 8 params → 200480481482483
GET
/jobs/{jobId}/things
Amazon IoT Device Defender List Job Executions for Job
ListJobExecutionsForJob 11 params → 200480481482483
GET
/jobs
Amazon IoT Device Defender List Jobs
ListJobs 14 params → 200480481482483

Schemas 91

The contract defines 91 schemas that model the data the API accepts and returns. The most detailed are Job (24 properties), JobProcessDetails (9 properties), JobSummary (9 properties), JobExecutionSummary (6 properties). Each schema is shown below with its type and property counts.

MinimumNumberOfExecutedThings
integer
JobTargets
array
DescribeJobResponse
object
2 properties
CanceledThings
integer
AssociateTargetsWithJobResponse
object
3 properties
InvalidStateTransitionException
InvalidRequestException
PresignedUrlConfig
object
Configuration for pre-signed S3 URLs.
2 properties
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
ServiceUnavailableException
ExpiresInSec
integer
IncrementFactor
number
JobStatus
string
JobExecutionSummaryForJobList
array
InProgressTimeoutInMinutes
integer
RetryableFailureType
string
ResourceAlreadyExistsException
ProcessingTargetName
string
ListJobsResponse
object
2 properties
JobProcessDetails
object
The job process details.
9 properties
RateIncreaseCriteria
object
Allows you to define a criteria to initiate the increase in rate of rollout for a job.
2 properties
JobTemplateArn
string
TimedOutThings
integer
StringDateTime
string
RetryCriteriaList
array
Forced
boolean
DateType
string
AbortCriteria
object
The criteria that determine when and how a job abort takes place.
4 properties 4 required
AbortThresholdPercentage
number
ParameterMap
object
TagValue
string
InProgressThings
integer
CancelJobResponse
object
3 properties
RolloutRatePerMinute
integer
RetryCriteria
object
The criteria that determines how many retries are allowed for each failure type for a job.
2 properties 2 required
Comment
string
AbortAction
string
LimitExceededException
ThrottlingException
FailedThings
integer
SucceededThings
integer
ParameterValue
string
ExponentialRolloutRate
object
Allows you to create an exponential rate of rollout for a job.
3 properties 3 required
ScheduledJobRollout
object
Displays the next seven maintenance window occurrences and their start times.
1 property
NamespaceId
string
TargetArn
string
JobExecutionFailureType
string
AbortCriteriaList
array
JobEndBehavior
string
JobDocumentSource
string
JobSummaryList
array
CronExpression
string
NumberOfThings
integer
RejectedThings
integer
SchedulingConfig
object
Specifies the date and time that a job will begin the rollout of the job document to all devices in the target group. Additionally, you can specify the end beh…
4 properties
JobSummary
object
The job summary.
9 properties
CreateJobResponse
object
3 properties
TargetSelection
string
ExecutionNumber
integer
AbortConfig
object
The criteria that determine when and how a job abort takes place.
1 property 1 required
NextToken
string
JobArn
string
ThingGroupId
string
JobDocument
string
ScheduledJobRolloutList
array
ReasonCode
string
ListJobExecutionsForJobResponse
object
2 properties
JobDescription
string
JobId
string
JobExecutionSummary
object
The job execution summary.
6 properties
RetryAttempt
integer
RemovedThings
integer
NumberOfRetries
integer
TagKey
string
JobExecutionStatus
string
ProcessingTargetNameList
array
DurationInMinutes
integer
MaxJobExecutionsPerMin
integer
JobExecutionsRolloutConfig
object
Allows you to create a staged rollout of a job.
2 properties
QueuedThings
integer
JobExecutionsRetryConfig
object
The configuration that determines how many retries are allowed for each failure type for a job.
1 property 1 required
BooleanWrapperObject
boolean
ThingArn
string
JobExecutionSummaryForJob
object
Contains a summary of information about job executions for a specific job.
2 properties
RoleArn
string
ResourceNotFoundException
GetJobDocumentResponse
object
1 property
Tag
object
A set of key/value pairs that are used to manage the resource.
2 properties 1 required
Job
object
The Job object contains details about a job.
24 properties
MaintenanceWindows
array
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-device-defender-jobs-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 Jobs 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.