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

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

Amazon IoT Device Management Jobs API is one of 69 APIs that Amazon IoT Device Management 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 Management 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 Management Associate Targets with Job
AssociateTargetsWithJob 9 params body → 200480481482483484
PUT
/jobs/{jobId}/cancel
Amazon IoT Device Management Cancel Job
CancelJob 9 params body → 200480481482483484
PUT
/jobs/{jobId}
Amazon IoT Device Management Create Job
CreateJob 8 params body → 200480481482483484485
DELETE
/jobs/{jobId}
Amazon IoT Device Management Delete Job
DeleteJob 10 params → 200480481482483484485
GET
/jobs/{jobId}
Amazon IoT Device Management Describe Job
DescribeJob 8 params → 200480481482483
PATCH
/jobs/{jobId}
Amazon IoT Device Management Update Job
UpdateJob 9 params body → 200480481482483
GET
/jobs/{jobId}/job-document
Amazon IoT Device Management Get Job Document
GetJobDocument 8 params → 200480481482483
GET
/jobs/{jobId}/things
Amazon IoT Device Management List Job Executions for Job
ListJobExecutionsForJob 11 params → 200480481482483
GET
/jobs
Amazon IoT Device Management 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), JobSummary (9 properties), JobProcessDetails (9 properties), JobExecutionSummary (6 properties). Each schema is shown below with its type and property counts.

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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-device-management-jobs-api-openapi.yml Raw ↑

Other APIs Amazon IoT Device Management publishes across the network.

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

This is an independent, third-party profile of Amazon IoT Device Management 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.