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

The Things API from Amazon IoT Device Defender — 9 operation(s) for things.

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

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

14 operations 9 paths 61 schemas 3 DELETE6 GET1 PATCH2 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 Things 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 14

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

Things 14
PUT
/things/{thingName}/principals#x-amzn-principal
Amazon IoT Device Defender Attach Thing Principal
AttachThingPrincipal 9 params → 200480481482483484485
DELETE
/things/{thingName}/principals#x-amzn-principal
Amazon IoT Device Defender Detach Thing Principal
DetachThingPrincipal 9 params → 200480481482483484485
PUT
/things/{thingName}/jobs/{jobId}/cancel
Amazon IoT Device Defender Cancel Job Execution
CancelJobExecution 10 params body → 200480481482483484485
POST
/things/{thingName}
Amazon IoT Device Defender Create Thing
CreateThing 8 params body → 200480481482483484485486
DELETE
/things/{thingName}
Amazon IoT Device Defender Delete Thing
DeleteThing 9 params → 200480481482483484485486
GET
/things/{thingName}
Amazon IoT Device Defender Describe Thing
DescribeThing 8 params → 200480481482483484485
PATCH
/things/{thingName}
Amazon IoT Device Defender Update Thing
UpdateThing 8 params body → 200480481482483484485486
DELETE
/things/{thingName}/jobs/{jobId}/executionNumber/{executionNumber}
Amazon IoT Device Defender Delete Job Execution
DeleteJobExecution 12 params → 200480481482483484
GET
/things/{thingName}/jobs/{jobId}
Amazon IoT Device Defender Describe Job Execution
DescribeJobExecution 10 params → 200480481482483
GET
/things/{thingName}/jobs
Amazon IoT Device Defender List Job Executions for Thing
ListJobExecutionsForThing 13 params → 200480481482483
GET
/things/{thingName}/thing-groups
Amazon IoT Device Defender List Thing Groups for Thing
ListThingGroupsForThing 10 params → 200480481482483
GET
/things/{thingName}/principals
Amazon IoT Device Defender List Thing Principals
ListThingPrincipals 10 params → 200480481482483484485
GET
/things
Amazon IoT Device Defender List Things
ListThings 13 params → 200480481482483484
POST
/things
Amazon IoT Device Defender Register Thing
RegisterThing 7 params body → 200480481482483484485486

Schemas 61

The contract defines 61 schemas that model the data the API accepts and returns. The most detailed are JobExecution (11 properties), DescribeThingResponse (8 properties), JobExecutionSummary (6 properties), ThingAttribute (5 properties). Each schema is shown below with its type and property counts.

RegisterThingResponse
object
2 properties
UnauthorizedException
ThingGroupArn
string
JobExecutionStatus
string
ListThingPrincipalsResponse
object
The output from the ListThingPrincipals operation.
2 properties
JobExecution
object
The job execution object represents the execution of a job on a particular device.
11 properties
DescribeThingResponse
object
The output from the DescribeThing operation.
8 properties
DetachThingPrincipalResponse
object
The output from the DetachThingPrincipal operation.
Principals
array
Version
integer
ThingGroupName
string
Value
string
UpdateThingResponse
object
The output from the UpdateThing operation.
PrincipalArn
string
ListJobExecutionsForThingResponse
object
2 properties
Flag
boolean
ThingGroupNameAndArnList
array
CertificatePem
string
The PEM of a certificate.
ResourceArn
string
Forced
boolean
JobExecutionSummaryForThingList
array
ThingTypeName
string
ResourceArns
object
InvalidStateTransitionException
DateType
string
ResourceRegistrationFailureException
Attributes
object
AttributeValue
string
ThingName
string
GroupNameAndArn
object
The name and ARN of a group.
2 properties
ThingId
string
ExecutionNumber
integer
NextToken
string
InvalidRequestException
ClientId
string
VersionNumber
integer
ApproximateSecondsBeforeTimedOut
integer
ThingAttributeList
array
JobExecutionSummaryForThing
object
The job execution summary for a thing.
2 properties
DescribeJobExecutionResponse
object
1 property
CreateThingResponse
object
The output of the CreateThing operation.
3 properties
InternalFailureException
JobExecutionStatusDetails
object
Details of the job execution status.
1 property
ServiceUnavailableException
ThingArn
string
ThrottlingException
JobId
string
JobExecutionSummary
object
The job execution summary.
6 properties
AttachThingPrincipalResponse
object
The output from the AttachThingPrincipal operation.
DetailsMap
object
ResourceNotFoundException
DeleteThingResponse
object
The output of the DeleteThing operation.
RetryAttempt
integer
BillingGroupName
string
VersionConflictException
ThingAttribute
object
The properties of the thing, including thing name, thing type name, and a list of thing attributes.
5 properties
ConflictingResourceUpdateException
ListThingGroupsForThingResponse
object
2 properties
ResourceAlreadyExistsException
DetailsValue
string
ListThingsResponse
object
The output from the ListThings operation.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-device-defender-things-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 Things 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.