Amazon IoT Events Analysis 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 Analysis. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and pricing.
This API exposes
3 operations
across 3 paths,
and defines 80 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.
3 operations3 paths80 schemas2 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Amazon IoT Events Analysis 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 3
Across 3 paths, the API surfaces 3 operations — 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Analysis 3
GET
/analysis/detector-models/{analysisId}
Amazon IoT Events Describe Detector Model Analysis
The contract defines 80 schemas that model the data the API accepts and returns. The most detailed are Action (13 properties), DynamoDBAction (10 properties), IotSiteWiseAction (5 properties), AssetPropertyVariant (4 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 properties1 required
Event
object
Specifies the actions to be performed when the condition evaluates to TRUE.
3 properties1 required
SNSTopicPublishAction
object
Information required to publish the Amazon SNS message.
2 properties1 required
AssetPropertyEntryId
string
ContentExpression
string
UseBase64
boolean
OnInputLifecycle
object
Specifies the actions performed when the condition evaluates to TRUE.
2 properties
InternalFailureException
VariableName
string
AssetPropertyBooleanValue
string
AssetPropertyId
string
ResourceNotFoundException
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 properties1 required
ThrottlingException
GetDetectorModelAnalysisResultsResponse
object
2 properties
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 properties1 required
AnalysisResults
array
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
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 properties2 required
DynamoOperation
string
TransitionEvent
object
Specifies the actions performed and the next state entered when a condition evaluates to TRUE.
4 properties3 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
AnalysisResultLocations
array
StartDetectorModelAnalysisResponse
object
1 property
Seconds
integer
AssetPropertyAlias
string
AnalysisType
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 property1 required
SetTimerAction
object
Information needed to set the timer.
3 properties1 required
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 properties1 required
InvalidRequestException
LambdaAction
object
Calls a Lambda function, passing in information about the detector model instance and the event that triggered the action.
2 properties1 required
SetVariableAction
object
Information about the variable and its new value.
2 properties2 required
State
object
Information that defines a state of a detector.
4 properties1 required
LimitExceededException
PayloadType
string
EventName
string
NextToken
string
InputName
string
MQTTTopic
string
AnalysisResultLevel
string
IotTopicPublishAction
object
Information required to publish the MQTT message through the AWS IoT message broker.
2 properties1 required
FirehoseSeparator
string
DynamoTableName
string
AnalysisResult
object
Contains the result of the analysis.
4 properties
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 properties1 required
AssetId
string
AnalysisResultLocation
object
Contains information that you can use to locate the field in your detector model that the analysis result references.
1 property
AssetPropertyDoubleValue
string
DescribeDetectorModelAnalysisResponse
object
1 property
AnalysisStatus
string
Actions
array
AmazonResourceName
string
ServiceUnavailableException
AssetPropertyIntegerValue
string
AssetPropertyOffsetInNanos
string
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 properties3 required
States
array
TimerName
string
DynamoKeyType
string
AssetPropertyStringValue
string
Condition
string
ClearTimerAction
object
Information needed to clear the timer.
1 property1 required
OnEnterLifecycle
object
When entering this state, perform these actions if the condition is TRUE.
1 property
AnalysisId
string
AnalysisMessage
string
DynamoKeyValue
string
AnalysisResultLocationPath
string
TransitionEvents
array
Specification
The full machine-readable OpenAPI contract behind this narrative.
Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.
Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.
MCP tools for apis
4 tools reach this content
search_api_evangelistSearch every content type across the network at once.
find_relatedThe shared-tag relevance graph — what else covers this.
get_tagEverything one tag labels, across all content types.
guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
A second provider on the same verified email joins the account you already have.
Your account
ⓘWhere this information came from
This is an independent, third-party profile of Amazon IoT Events Analysis 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.
