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

The Detect API from Amazon IoT Device Defender — 4 operation(s) for detect.

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

This API exposes 5 operations across 4 paths, and defines 52 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.

5 operations 4 paths 52 schemas 3 GET2 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 Detect 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 5

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

Detect 5
PUT
/detect/mitigationactions/tasks/{taskId}/cancel
Amazon IoT Device Defender Cancel Detect Mitigation Actions Task
CancelDetectMitigationActionsTask 8 params → 200480481482483
GET
/detect/mitigationactions/tasks/{taskId}
Amazon IoT Device Defender Describe Detect Mitigation Actions Task
DescribeDetectMitigationActionsTask 8 params → 200480481482483
PUT
/detect/mitigationactions/tasks/{taskId}
Amazon IoT Device Defender Start Detect Mitigation Actions Task
StartDetectMitigationActionsTask 8 params body → 200480481482483484
GET
/detect/mitigationactions/executions
Amazon IoT Device Defender List Detect Mitigation Actions Executions
ListDetectMitigationActionsExecutions 14 params → 200480481482
GET
/detect/mitigationactions/tasks#startTime&endTime
Amazon IoT Device Defender List Detect Mitigation Actions Tasks
ListDetectMitigationActionsTasks 11 params → 200480481482

Schemas 52

The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are DetectMitigationActionsTaskSummary (10 properties), DetectMitigationActionExecution (9 properties), MitigationActionParams (6 properties), MitigationAction (4 properties). Each schema is shown below with its type and property counts.

BehaviorName
string
MitigationAction
object
Describes which changes should be applied as part of a mitigation action.
4 properties
DetectMitigationActionsTaskSummary
object
The summary of the mitigation action tasks.
10 properties
AddThingsToThingGroupParams
object
Parameters used when defining a mitigation action that move a set of things to a thing group.
2 properties 1 required
ListDetectMitigationActionsTasksResponse
object
2 properties
StartDetectMitigationActionsTaskResponse
object
1 property
PrimitiveBoolean
boolean
ListDetectMitigationActionsExecutionsResponse
object
2 properties
DescribeDetectMitigationActionsTaskResponse
object
1 property
GenericLongValue
integer
ThingGroupName
string
ReplaceDefaultPolicyVersionParams
object
Parameters to define a mitigation action that adds a blank policy to restrict permissions.
1 property 1 required
TaskAlreadyExistsException
DetectMitigationActionExecution
object
Describes which mitigation actions should be executed.
9 properties
MitigationActionName
string
MitigationActionId
string
Timestamp
string
DetectMitigationActionsTaskTarget
object
The target of a mitigation action task.
3 properties
CACertificateUpdateAction
string
DetectMitigationActionExecutionList
array
PublishFindingToSnsParams
object
Parameters to define a mitigation action that publishes findings to Amazon SNS. You can implement your own custom actions in response to the Amazon SNS message…
1 property 1 required
NextToken
string
ErrorMessage
string
InvalidRequestException
ViolationEventOccurrenceRange
object
Specifies the time period of which violation events occurred between.
2 properties 2 required
ViolationId
string
UpdateDeviceCertificateParams
object
Parameters to define a mitigation action that changes the state of the device certificate to inactive.
1 property 1 required
SnsTopicArn
string
EnableIoTLoggingParams
object
Parameters used when defining a mitigation action that enable Amazon Web Services IoT Core logging.
2 properties 2 required
LogLevel
string
InternalFailureException
DetectMitigationActionExecutionErrorCode
string
DetectMitigationActionExecutionStatus
string
NullableBoolean
boolean
DeviceDefenderThingName
string
LimitExceededException
ThrottlingException
ThingGroupNames
array
UpdateCACertificateParams
object
Parameters to define a mitigation action that changes the state of the CA certificate to inactive.
1 property 1 required
CancelDetectMitigationActionsTaskResponse
object
RoleArn
string
MitigationActionParams
object
The set of parameters for this mitigation action. You can specify only one type of parameter (in other words, you can apply only one action for each defined mi…
6 properties
ResourceNotFoundException
MitigationActionList
array
DetectMitigationActionsTaskStatistics
object
The statistics of a mitigation action task.
3 properties
DetectMitigationActionsTaskSummaryList
array
PolicyTemplateName
string
MitigationActionsTaskId
string
DeviceCertificateUpdateAction
string
DetectMitigationActionsTaskStatus
string
TargetViolationIdsForDetectMitigationActions
array
SecurityProfileName
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-device-defender-detect-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 Detect 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.