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 Core OtaUpdates API

The OtaUpdates API from Amazon IoT Core — 2 operation(s) for otaupdates.

Amazon IoT Core OtaUpdates API is one of 70 APIs that Amazon IoT Core publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include OTA Updates. 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 86 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 86 schemas 1 DELETE2 GET1 POST

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 Core OtaUpdates 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 POST. Each is listed below with its method, path, parameters, and response codes.

OtaUpdates 4
POST
/otaUpdates/{otaUpdateId}
Amazon IoT Core Create O T a Update
CreateOTAUpdate 8 params body → 200480481482483484485486
DELETE
/otaUpdates/{otaUpdateId}
Amazon IoT Core Delete O T a Update
DeleteOTAUpdate 10 params → 200480481482483484485486
GET
/otaUpdates/{otaUpdateId}
Amazon IoT Core Get O T a Update
GetOTAUpdate 8 params → 200480481482483484485
GET
/otaUpdates
Amazon IoT Core List O T a Updates
ListOTAUpdates 10 params → 200480481482483484

Schemas 86

The contract defines 86 schemas that model the data the API accepts and returns. The most detailed are OTAUpdateInfo (16 properties), OTAUpdateFile (6 properties), CreateOTAUpdateResponse (5 properties), AwsJobAbortCriteria (4 properties). Each schema is shown below with its type and property counts.

AwsJobAbortCriteriaFailureType
string
AwsJobRateIncreaseCriteria
object
The criteria to initiate the increase in rate of rollout for a job.
2 properties
ResourceNotFoundException
UnauthorizedException
Value
string
VersionConflictException
CodeSigning
object
Describes the method to use when code signing a file.
3 properties
S3Key
string
CodeSigningSignature
object
Describes the signature for a file.
1 property
AwsJobExponentialRolloutRate
object
The rate of increase for a job rollout. This parameter allows you to define an exponential rate increase for a job rollout.
3 properties 3 required
AwsIotJobId
string
Destination
object
Describes the location of the updated firmware.
1 property
OTAUpdateInfo
object
Information about an OTA update.
16 properties
TargetSelection
string
AwsJobExecutionsRolloutConfig
object
Configuration for the rollout of OTA updates.
2 properties
CertificateArn
string
InternalFailureException
HashAlgorithm
string
CodeSigningCertificateChain
object
Describes the certificate chain being used when code signing a file.
2 properties
TagValue
string
LimitExceededException
AwsJobAbortCriteriaList
array
OTAUpdateArn
string
Targets
array
TagKey
string
ExpiresInSeconds
integer
Stream
object
Describes a group of files that can be streamed.
2 properties
OTAUpdateDescription
string
InvalidRequestException
ListOTAUpdatesResponse
object
2 properties
CustomCodeSigning
object
Describes a custom method used to code sign a file.
4 properties
FileType
integer
Protocols
array
S3Bucket
string
AwsJobRateIncreaseCriteriaNumberOfThings
integer
Protocol
string
Platform
string
AwsIotJobArn
string
S3Version
string
ResourceAlreadyExistsException
AwsJobAbortCriteria
object
The criteria that determine when and how a job abort takes place.
4 properties 4 required
SigningJobId
string
DeleteOTAUpdateResponse
object
SignatureAlgorithm
string
StartSigningJobParameter
object
Information required to start a signing job.
3 properties
S3Destination
object
Describes the location of updated firmware in S3.
2 properties
SigningProfileName
string
S3Location
object
The S3 location.
3 properties
DateType
string
Code
string
Tag
object
A set of key/value pairs that are used to manage the resource.
2 properties 1 required
CertificatePathOnDevice
string
OTAUpdateErrorMessage
string
AwsJobPresignedUrlConfig
object
Configuration information for pre-signed URLs. Valid when protocols contains HTTP.
1 property
NextToken
string
OTAUpdateId
string
GetOTAUpdateResponse
object
1 property
AwsJobAbortCriteriaAbortAction
string
ErrorInfo
object
Error information.
2 properties
OTAUpdateFile
object
Describes a file to be associated with an OTA update.
6 properties
StreamId
string
FileName
string
OTAUpdateStatus
string
Signature
string
InlineDocument
string
AwsJobTimeoutInProgressTimeoutInMinutes
integer
Target
string
AttributesMap
object
ThrottlingException
AwsJobRolloutRatePerMinute
integer
Prefix
string
AwsJobRolloutIncrementFactor
number
FileId
integer
OTAUpdatesSummary
array
CertificateName
string
AdditionalParameterMap
object
OTAUpdateFileVersion
string
OTAUpdateFiles
array
FileLocation
object
The location of the OTA update.
2 properties
ServiceUnavailableException
AwsJobAbortCriteriaMinimumNumberOfExecutedThings
integer
CreateOTAUpdateResponse
object
5 properties
OTAUpdateSummary
object
An OTA update summary.
3 properties
MaximumPerMinute
integer
SigningProfileParameter
object
Describes the code-signing profile.
3 properties
AwsJobAbortCriteriaAbortThresholdPercentage
number

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-core-otaupdates-api-openapi.yml Raw ↑

Other APIs Amazon IoT Core publishes across the network.

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

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