AWS IoT Events Data
IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use IoT Events…
Data & analytics#openapi#cloud
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use IoT Events Data API commands to send inputs to detectors, list detectors, and view or update a detector's status. For more information, see What is IoT Events? in the IoT Events Developer Guide .
Endpoints 12
- POSTBatchAcknowledgeAlarm
/alarms/acknowledgeAcknowledges one or more alarms. The alarms change to the <code>ACKNOWLEDGED</code> state after you acknowledge them. - POSTBatchDeleteDetector
/detectors/deleteDeletes one or more detectors that were created. When a detector is deleted, its state will be cleared and the detector will be removed from the list of… - POSTBatchDisableAlarm
/alarms/disableDisables one or more alarms. The alarms change to the <code>DISABLED</code> state after you disable them. - POSTBatchEnableAlarm
/alarms/enableEnables one or more alarms. The alarms change to the <code>NORMAL</code> state after you enable them. - POSTBatchPutMessage
/inputs/messagesSends a set of messages to the IoT Events system. Each message payload is transformed into the input you specify (<code>"inputName"</code>) and ingested into… - POSTBatchResetAlarm
/alarms/resetResets one or more alarms. The alarms return to the <code>NORMAL</code> state after you reset them. - POSTBatchSnoozeAlarm
/alarms/snoozeChanges one or more alarms to the snooze mode. The alarms change to the <code>SNOOZE_DISABLED</code> state after you set them to the snooze mode. - POSTBatchUpdateDetector
/detectorsUpdates the state, variable values, and timer settings of one or more detectors (instances) of a specified detector model. - GETDescribeAlarm
/alarms/:alarmModelName/keyValues/?keyValue=stringRetrieves information about an alarm. - GETDescribeDetector
/detectors/:detectorModelName/keyValues/?keyValue=stringReturns information about the specified detector (instance). - GETListAlarms
/alarms/:alarmModelName?nextToken=string&maxResults=1Lists one or more alarms. The operation returns only the metadata associated with each alarm. - GETListDetectors
/detectors/:detectorModelName?stateName=string&nextToken=string&maxResults=1Lists detectors (the instances of a detector model).
API details
- Base URL
http://data.iotevents.{region}.amazonaws.comhttps://data.iotevents.{region}.amazonaws.comhttp://data.iotevents.{region}.amazonaws.com.cnhttps://data.iotevents.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 12 operations on 12 pathsPOST 8GET 4
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2018-10-23 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the AWS IoT Events Data in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT Events Data collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “BatchAcknowledgeAlarm” (POST /alarms/acknowledge), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS IoT Events Data?
IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use IoT Events… It is listed under Data & analytics and has 12 endpoints.
Who publishes the AWS IoT Events Data?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS IoT Events Data?
Its description lists 4 base URLs: http://data.iotevents.{region}.amazonaws.com, https://data.iotevents.{region}.amazonaws.com, http://data.iotevents.{region}.amazonaws.com.cn, https://data.iotevents.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the AWS IoT Events Data?
With an API key in the Authorization header.
How many endpoints does the AWS IoT Events Data have?
12 operations on 12 paths (8 POST, 4 GET).
Is forking the AWS IoT Events Data free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.