View Source aws_iot_events (aws v1.0.4)
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.Summary
Functions
Creates an alarm model to monitor an AWS IoT Events input attribute.
Deletes an alarm model.
Deletes a detector model.
Retrieves information about an alarm model.
Describes a detector model.
Retrieves runtime information about a detector model analysis.
Retrieves one or more analysis results of the detector model.
Lists all the versions of an alarm model.
Lists the alarm models that you created.
Lists all the versions of a detector model.
Lists the detector models you have created.
Sets or updates the AWS IoT Events logging options.
Performs an analysis of your detector model.
Adds to or modifies the tags of the given resource.
Updates an alarm model.
Updates a detector model.
Functions
Creates 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 more information, see Create an alarm model: https://docs.aws.amazon.com/iotevents/latest/developerguide/create-alarms.html in the AWS IoT Events Developer Guide.Deletes an alarm model.
Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.Deletes a detector model.
Any active instances of the detector model are also deleted.delete_detector_model(Client, DetectorModelName, Input0, Options0)
View SourceRetrieves information about an alarm model.
If you don't specify a value for thealarmModelVersion parameter, the latest version is returned.
describe_alarm_model(Client, AlarmModelName, QueryMap, HeadersMap)
View Sourcedescribe_alarm_model(Client, AlarmModelName, QueryMap, HeadersMap, Options0)
View SourceDescribes a detector model.
If theversion parameter is not specified, information about the latest version is returned.
describe_detector_model(Client, DetectorModelName, QueryMap, HeadersMap)
View Sourcedescribe_detector_model(Client, DetectorModelName, QueryMap, HeadersMap, Options0)
View SourceRetrieves runtime information about a detector model analysis.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.describe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap)
View Sourcedescribe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap, Options0)
View SourceRetrieves one or more analysis results of the detector model.
After AWS IoT Events starts analyzing your detector model, you have up to 24 hours to retrieve the analysis results.get_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap)
View Sourceget_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap, Options0)
View SourceLists all the versions of an alarm model.
The operation returns only the metadata associated with each alarm model version.list_alarm_model_versions(Client, AlarmModelName, QueryMap, HeadersMap)
View Sourcelist_alarm_model_versions(Client, AlarmModelName, QueryMap, HeadersMap, Options0)
View SourceLists the alarm models that you created.
The operation returns only the metadata associated with each alarm model.Lists all the versions of a detector model.
Only the metadata associated with each detector model version is returned.list_detector_model_versions(Client, DetectorModelName, QueryMap, HeadersMap)
View Sourcelist_detector_model_versions(Client, DetectorModelName, QueryMap, HeadersMap, Options0)
View SourceLists the detector models you have created.
Only the metadata associated with each detector model is returned.list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View SourceSets or updates the AWS IoT Events logging options.
If you update the value of anyloggingOptions field, it takes up to one minute for the change to take effect. If you change the policy attached to the role you specified in the roleArn field (for example, to correct an invalid policy), it takes up to five minutes for that change to take effect.
Performs an analysis of your detector model.
For more information, see Troubleshooting a detector model: https://docs.aws.amazon.com/iotevents/latest/developerguide/iotevents-analyze-api.html in the AWS IoT Events Developer Guide.Adds to or modifies the tags of the given resource.
Tags are metadata that can be used to manage a resource.Updates an alarm model.
Any alarms that were created based on the previous version are deleted and then created again as new data arrives.Updates a detector model.
Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.