AWS IoT Events
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT…
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
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.
Endpoints 26
- GETListAlarmModels
/alarm-models?nextToken=string&maxResults=1Lists the alarm models that you created. The operation returns only the metadata associated with each alarm model. - POSTCreateAlarmModel
/alarm-modelsCreates an alarm model to monitor an AWS IoT Events input attribute. You can use the alarm to get notified when the value is outside a specified range. For… - GETListDetectorModels
/detector-models?nextToken=string&maxResults=1Lists the detector models you have created. Only the metadata associated with each detector model is returned. - POSTCreateDetectorModel
/detector-modelsCreates a detector model. - GETListInputs
/inputs?nextToken=string&maxResults=1Lists the inputs you have created. - POSTCreateInput
/inputsCreates an input. - GETDescribeAlarmModel
/alarm-models/:alarmModelName?version=stringRetrieves information about an alarm model. If you don't specify a value for the <code>alarmModelVersion</code> parameter, the latest version is returned. - POSTUpdateAlarmModel
/alarm-models/:alarmModelNameUpdates an alarm model. Any alarms that were created based on the previous version are deleted and then created again as new data arrives. - DELETEDeleteAlarmModel
/alarm-models/:alarmModelNameDeletes an alarm model. Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone. - GETDescribeDetectorModel
/detector-models/:detectorModelName?version=stringDescribes a detector model. If the <code>version</code> parameter is not specified, information about the latest version is returned. - POSTUpdateDetectorModel
/detector-models/:detectorModelNameUpdates a detector model. Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive. - DELETEDeleteDetectorModel
/detector-models/:detectorModelNameDeletes a detector model. Any active instances of the detector model are also deleted. - GETDescribeInput
/inputs/:inputNameDescribes an input. - PUTUpdateInput
/inputs/:inputNameUpdates an input. - DELETEDeleteInput
/inputs/:inputNameDeletes an input. - GETDescribeDetectorModelAnalysis
/analysis/detector-models/:analysisId<p>Retrieves runtime information about a detector model analysis.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24… - GETDescribeLoggingOptions
/loggingRetrieves the current settings of the AWS IoT Events logging options. - PUTPutLoggingOptions
/logging<p>Sets or updates the AWS IoT Events logging options.</p> <p>If you update the value of any <code>loggingOptions</code> field, it takes up to one minute for… - GETGetDetectorModelAnalysisResults
/analysis/detector-models/:analysisId/results?nextToken=string&maxResults=0<p>Retrieves one or more analysis results of the detector model.</p> <note> <p>After AWS IoT Events starts analyzing your detector model, you have up to 24… - GETListAlarmModelVersions
/alarm-models/:alarmModelName/versions?nextToken=string&maxResults=1Lists all the versions of an alarm model. The operation returns only the metadata associated with each alarm model version. - GETListDetectorModelVersions
/detector-models/:detectorModelName/versions?nextToken=string&maxResults=1Lists all the versions of a detector model. Only the metadata associated with each detector model version is returned. - POSTListInputRoutings
/input-routingsLists one or more input routings. - GETListTagsForResource
/tags#resourceArn?resourceArn=stringLists the tags (metadata) you have assigned to the resource. - POSTTagResource
/tags#resourceArn?resourceArn=stringAdds to or modifies the tags of the given resource. Tags are metadata that can be used to manage a resource. - POSTStartDetectorModelAnalysis
/analysis/detector-models/Performs an analysis of your detector model. For more information, see <a… - DELETEUntagResource
/tags#resourceArn&tagKeys?resourceArn=string&tagKeys=stringRemoves the given tags (metadata) from the resource.
API details
- Base URL
http://iotevents.{region}.amazonaws.comhttps://iotevents.{region}.amazonaws.comhttp://iotevents.{region}.amazonaws.com.cnhttps://iotevents.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 26 operations on 15 pathsGET 12POST 8DELETE 4PUT 2
- Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2018-07-27 - 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 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 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 “ListAlarmModels” (GET /alarm-models?nextToken=string&maxResults=1), 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?
AWS IoT Events monitors your equipment or device fleets for failures or changes in operation, and triggers actions when such events occur. You can use AWS IoT… It is listed under IoT & devices and has 26 endpoints.
Who publishes the AWS IoT Events?
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?
Its description lists 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. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the AWS IoT Events?
With an API key in the Authorization header.
How many endpoints does the AWS IoT Events have?
26 operations on 15 paths (12 GET, 8 POST, 4 DELETE, 2 PUT).
Is forking the AWS IoT Events free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.