Agent-ready OpenAPI document · curated by JenticIOTSensor Datahmac26 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Define and version AWS IoT Events inputs, detector models, and alarm models that turn IoT telemetry into stateful event-driven automation across equipment fleets.
Use for: I need to create a detector model that watches for high-temperature events, Define a new input schema for a temperature telemetry payload, List all detector models in the account, Update an alarm model with a new threshold
Not supported: Does not handle telemetry ingestion, action execution at runtime, or asset modelling - use for IoT Events detector model, alarm model, and input configuration only.
Jentic publishes the only available OpenAPI specification for AWS IoT Events, keeping it validated and agent-ready. AWS IoT Events monitors equipment and device fleets for failures or changes in operation by running detector models - state machines that react to incoming telemetry inputs. The control-plane API manages inputs, detector models, alarm models, model versions, and detector model analyses across 26 operations. It is the configuration surface for setting up event-driven automation on top of IoT telemetry.
Install Jentic One Beta
Connect the AWS IoT Events to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the AWS IoT Events, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-iotevents" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Famazonaws.com%2Faws-iotevents" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with AWS IoT Events API.
Create and version inputs that describe the schema of incoming telemetry messages
Create and version detector models - state machines that fire actions on transitions
Create and manage alarm models that watch numeric inputs against thresholds
Run analyses on detector models to surface logic errors before deployment
Tag detector models, alarm models, and inputs for ownership and cost allocation
Update routing options and IAM service roles used by IoT Events
List and describe model versions to support staged rollouts
Use Cases
Patterns agents use AWS IoT Events API for, with concrete tasks.
★ Predictive Maintenance State Machines
Model failure-warning logic for industrial equipment as a detector model - for example, a state machine that tracks temperature, vibration, and runtime hours, transitioning to a 'pre-failure' state when thresholds combine. Each transition can fire SNS, Lambda, or IoT Events Republish actions to alert maintenance crews. Detector model versions support staged rollouts.
Call CreateDetectorModel with detectorModelDefinition containing two states (Normal, Warning), a transition condition on $input.temperature.value > 80, and an SNS publish action on entry to Warning
Threshold Alarm Management
Use alarm models to watch a single numeric input against high and low thresholds without writing detector model logic. CreateAlarmModel and UpdateAlarmModel manage the watchers, and DescribeAlarm tracks current state including ACK and SNOOZE. Alarm models are simpler than detector models for one-metric guardrails.
Call CreateAlarmModel with alarmRule.simpleRule comparing inputProperty $input.tankSensor.level < 5.0 and severity 4
Pre-Deployment Logic Validation
Run StartDetectorModelAnalysis on a draft detector model to surface unreachable states, missing transitions, and unused inputs before publishing it to the fleet. GetDetectorModelAnalysisResults returns analysis findings keyed by detector model state. This shortens the iteration loop for engineers building complex state machines.
Call StartDetectorModelAnalysis with a detectorModelDefinition payload, then GetDetectorModelAnalysisResults using the returned analysisId
AI Agent IoT Operations
Through Jentic, an AI agent can operate IoT Events as a configuration surface - adding alarm models when an operator describes a new threshold, listing existing detector models, or rolling forward a new detector model version. Jentic exposes the 26 operations as discoverable tools.
Search Jentic for 'create aws iot events alarm model', load the CreateAlarmModel schema, and execute it with the alarmRule and roleArn
Key Endpoints
26 endpoints — jentic publishes the only available openapi specification for aws iot events, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
POST
/detector-models
CreateDetectorModel - create a new detector model
GET
/detector-models
ListDetectorModels - list detector models
GET
/detector-models/{detectorModelName}
DescribeDetectorModel - fetch a detector model definition
POST
/inputs
CreateInput - define a new input schema
GET
/inputs
ListInputs - list inputs in the account
POST
/alarm-models
CreateAlarmModel - create an alarm model
GET
/alarm-models
ListAlarmModels - list alarm models
GET
/alarm-models/{alarmModelName}
DescribeAlarmModel - fetch an alarm model
POST
/detector-models
CreateDetectorModel - create a new detector model
GET
/detector-models
ListDetectorModels - list detector models
GET
/detector-models/{detectorModelName}
DescribeDetectorModel - fetch a detector model definition
POST
/inputs
CreateInput - define a new input schema
GET
/inputs
ListInputs - list inputs in the account
POST
/alarm-models
CreateAlarmModel - create an alarm model
GET
/alarm-models
ListAlarmModels - list alarm models
GET
/alarm-models/{alarmModelName}
DescribeAlarmModel - fetch an alarm model
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
A
AWS IoT Events
- Foundational (C+)59/100
74
Foundational Compliance63
Developer Experience & Jentic Compatibility39
AI-Readiness & Agent Experience93
Agent Usability50
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
74
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: A-Signals: 4
95%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
100%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
39
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
54%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
100%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
93
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
93%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
50
Security
Trust, risk posture, and security compliance.
Grade: C-Signals: 1
50%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the IoT Events API by hand means building AWS Signature Version 4 signing, resolving the iotevents.amazonaws.com host, wiring an IAM service role for actions, and handling AWS throttling and retries yourself. Through Jentic you install once, import AWS IoT Events from the API Directory, store the AWS access key and secret once, and your agent calls it.
Permission scoping
IoT Events puts the model name in the URL path (/detector-models/{detectorModelName} and /alarm-models/{alarmModelName}), so a rule can pin your agent to one detector or alarm model: it can describe and version that model and nothing else. You choose the operations it may call, so destructive ones like DeleteDetectorModel or DeleteAlarmModel are not included unless you add them.
Credential isolation
Your AWS access key and secret for IoT Events are stored once, encrypted, by your own Jentic One instance and signed with SigV4 at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create an iot events detector model' or 'list alarm models', and Jentic returns the matching IoT Events operation with its input schema so the agent calls the right endpoint without reading the AWS reference.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using AWS IoT Events API through Jentic.
Why is there no official OpenAPI spec for AWS IoT Events?
AWS does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call AWS IoT Events via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the AWS IoT Events API use?
The API uses AWS Signature Version 4 (HMAC) request signing with an AWS access key ID and secret access key. Through Jentic, AWS credentials are stored encrypted in the vault and the agent calls signed operations without seeing the raw keys.
Can I create a detector model with the AWS IoT Events API?
Yes. Call POST /detector-models with a detectorModelName, a detectorModelDefinition containing states and transitions, and a roleArn that IoT Events uses to invoke actions. The model is versioned, and you can publish a new version with UpdateDetectorModel.
What are the rate limits for the AWS IoT Events API?
AWS applies per-account, per-region request quotas to IoT Events operations and these vary by call. Detector model creation has lower quotas than list and describe operations. Check AWS Service Quotas for current limits.
How do I run a detector model analysis through Jentic?
Search Jentic for 'analyze aws iot events detector model', load the StartDetectorModelAnalysis schema, and execute with the detectorModelDefinition payload. Then call GetDetectorModelAnalysisResults using the returned analysisId to read findings.
What is the difference between a detector model and an alarm model?
A detector model is a full state machine with multiple states, transitions, and actions. An alarm model is a simpler single-input threshold watcher with built-in ACK and SNOOZE behaviour. Use alarm models for straightforward threshold alerts and detector models for multi-step logic.
Can I limit what my agent is allowed to do with the AWS IoT Events API?
Yes. Jentic One is self-hosted, so your own rules decide which IoT Events operations and AWS credentials the agent may use. Because IoT Events puts the model name in the URL path, such as /detector-models/{detectorModelName} and /alarm-models/{alarmModelName}, you can pin the agent to a single detector or alarm model and let it describe and version only that one. You choose the operations it may call, so destructive ones like DeleteDetectorModel and DeleteAlarmModel stay out unless you add them.
GET STARTED