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 Events Detector Models API

The Detector Models API from Amazon IoT Events — 3 operation(s) for detector models.

Amazon IoT Events Detector Models API is one of 8 APIs that Amazon IoT Events publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Detector Models. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.

This API exposes 6 operations across 3 paths, and defines 93 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://iotevents.{region}.amazonaws.com, https://iotevents.{region}.amazonaws.com, http://iotevents.{region}.amazonaws.com.cn, https://iotevents.{region}.amazonaws.com.cn.

6 operations 3 paths 93 schemas 1 DELETE3 GET2 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://iotevents.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon IoT Events Detector Models 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 6

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

Detector Models 6
POST
/detector-models
Amazon IoT Events Create Detector Model
CreateDetectorModel 7 params body → 200480481482483484485486
GET
/detector-models
Amazon IoT Events List Detector Models
ListDetectorModels 9 params → 200480481482483
DELETE
/detector-models/{detectorModelName}
Amazon IoT Events Delete Detector Model
DeleteDetectorModel 8 params → 204480481482483484485
GET
/detector-models/{detectorModelName}
Amazon IoT Events Describe Detector Model
DescribeDetectorModel 9 params → 200480481482483484
POST
/detector-models/{detectorModelName}
Amazon IoT Events Update Detector Model
UpdateDetectorModel 8 params body → 200480481482483484485
GET
/detector-models/{detectorModelName}/versions
Amazon IoT Events List Detector Model Versions
ListDetectorModelVersions 10 params → 200480481482483484

Schemas 93

The contract defines 93 schemas that model the data the API accepts and returns. The most detailed are Action (13 properties), DynamoDBAction (10 properties), DetectorModelConfiguration (10 properties), DetectorModelVersionSummary (8 properties). Each schema is shown below with its type and property counts.

VariableValue
string
AssetPropertyQuality
string
DynamoKeyField
string
IotEventsAction
object
Sends an AWS IoT Events input, passing in information about the detector model instance and the event that triggered the action.
2 properties 1 required
Event
object
Specifies the actions to be performed when the condition evaluates to TRUE.
3 properties 1 required
SNSTopicPublishAction
object
Information required to publish the Amazon SNS message.
2 properties 1 required
AssetPropertyEntryId
string
ContentExpression
string
UseBase64
boolean
OnInputLifecycle
object
Specifies the actions performed when the condition evaluates to TRUE.
2 properties
InternalFailureException
DetectorModel
object
Information about the detector model.
2 properties
VariableName
string
AssetPropertyBooleanValue
string
AssetPropertyId
string
ResourceNotFoundException
DetectorModelArn
string
FirehoseAction
object
Sends information about the detector model instance and the event that triggered the action to an Amazon Kinesis Data Firehose delivery stream.
3 properties 1 required
ThrottlingException
DynamoDBv2Action
object
Defines an action to write to the Amazon DynamoDB table that you created. The default action payload contains all the information about the detector model inst…
2 properties 1 required
Events
array
IotSiteWiseAction
object
Sends information about the detector model instance and the event that triggered the action to a specified asset property in AWS IoT SiteWise. You must use exp…
5 properties
AssetPropertyTimeInSeconds
string
QueueUrl
string
ResourceAlreadyExistsException
Payload
object
Information needed to configure the payload. By default, AWS IoT Events generates a standard payload in JSON for any action. This action payload contains all a…
2 properties 2 required
DynamoOperation
string
TransitionEvent
object
Specifies the actions performed and the next state entered when a condition evaluates to TRUE.
4 properties 3 required
DeliveryStreamName
string
StateName
string
AssetPropertyVariant
object
A structure that contains an asset property value. For more information, see Variant in the AWS IoT SiteWise API Reference . You must use expressions for all p…
4 properties
Action
object
An action to be performed when the condition is TRUE.
13 properties
AssetPropertyValue
object
A structure that contains value information. For more information, see AssetPropertyValue in the AWS IoT SiteWise API Reference . You must use expressions for…
3 properties
Timestamp
string
DetectorModelDefinition
object
Information that defines how a detector operates.
2 properties 2 required
Seconds
integer
DescribeDetectorModelResponse
object
1 property
Tag
object
Metadata that can be used to manage the resource.
2 properties 2 required
AssetPropertyAlias
string
ResetTimerAction
object
Information required to reset the timer. The timer is reset to the previously evaluated result of the duration. The duration expression isn't reevaluated when…
1 property 1 required
SetTimerAction
object
Information needed to set the timer.
3 properties 1 required
DetectorModelSummary
object
Information about the detector model.
3 properties
OnExitLifecycle
object
When exiting this state, perform these actions if the specified condition is TRUE .
1 property
SqsAction
object
Sends information about the detector model instance and the event that triggered the action to an Amazon SQS queue.
3 properties 1 required
DetectorModelName
string
InvalidRequestException
ResourceInUseException
LambdaAction
object
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
2 properties 1 required
TagValue
string
DeleteDetectorModelResponse
object
DetectorModelVersion
string
ListDetectorModelsResponse
object
2 properties
SetVariableAction
object
Information about the variable and its new value.
2 properties 2 required
LimitExceededException
State
object
Information that defines a state of a detector.
4 properties 1 required
UpdateDetectorModelResponse
object
1 property
PayloadType
string
NextToken
string
EventName
string
InputName
string
MQTTTopic
string
IotTopicPublishAction
object
Information required to publish the MQTT message through the AWS IoT message broker.
2 properties 1 required
FirehoseSeparator
string
AttributeJsonPath
string
DetectorModelVersionSummary
object
Information about the detector model version.
8 properties
DynamoTableName
string
AssetPropertyTimestamp
object
A structure that contains timestamp information. For more information, see TimeInNanos in the AWS IoT SiteWise API Reference . You must use expressions for all…
2 properties 1 required
AssetId
string
AssetPropertyDoubleValue
string
Actions
array
AmazonResourceName
string
DetectorModelConfiguration
object
Information about how the detector model is configured.
10 properties
ServiceUnavailableException
AssetPropertyIntegerValue
string
AssetPropertyOffsetInNanos
string
ListDetectorModelVersionsResponse
object
2 properties
DynamoDBAction
object
Defines an action to write to the Amazon DynamoDB table that you created. The standard action payload contains all the information about the detector model ins…
10 properties 3 required
CreateDetectorModelResponse
object
1 property
DetectorModelVersionStatus
string
States
array
TimerName
string
DynamoKeyType
string
AssetPropertyStringValue
string
Condition
string
EvaluationMethod
string
TagKey
string
DetectorModelDescription
string
ClearTimerAction
object
Information needed to clear the timer.
1 property 1 required
DetectorModelSummaries
array
OnEnterLifecycle
object
When entering this state, perform these actions if the condition is TRUE.
1 property
DetectorModelVersionSummaries
array
DynamoKeyValue
string
TransitionEvents
array

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-iot-events-detector-models-api-openapi.yml Raw ↑

Other APIs Amazon IoT Events publishes across the network.

Amazon IoT Events Alarm Models API
Amazon IoT Events Analysis API
Amazon IoT Events Input Routings API
Amazon IoT Events Inputs API
Amazon IoT Events Logging API
Amazon IoT Events Tags#resourceArn API
Amazon IoT Events Tags#resourceArn&tagKeys API
Where this information came from

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