View Source AWS.IoTEvents (aws-elixir v1.0.0)

You can use the alarm to get notified when the value is outside a specified range. For more information, see Create an alarm model in the AWS IoT Events Developer Guide.

create_detector_model(client, input, options \\ [])

Creates a detector model.

create_input(client, input, options \\ [])

Creates an input.

delete_alarm_model(client, alarm_model_name, input, options \\ [])

Deletes an alarm model.

Any alarm instances that were created based on this alarm model are also deleted. This action can't be undone.

delete_detector_model(client, detector_model_name, input, options \\ [])

Deletes a detector model.

Any active instances of the detector model are also deleted.

delete_input(client, input_name, input, options \\ [])

Deletes an input.

describe_alarm_model(client, alarm_model_name, alarm_model_version \\ nil, options \\ [])

Retrieves information about an alarm model.

If you don't specify a value for the alarmModelVersion parameter, the latest version is returned.

describe_detector_model(client, detector_model_name, detector_model_version \\ nil, options \\ [])

Describes a detector model.

If the version parameter is not specified, information about the latest version is returned.

describe_detector_model_analysis(client, analysis_id, options \\ [])

Retrieves 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_input(client, input_name, options \\ [])

Describes an input.

describe_logging_options(client, options \\ [])

Retrieves the current settings of the AWS IoT Events logging options.

get_detector_model_analysis_results(client, analysis_id, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves 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.

list_alarm_model_versions(client, alarm_model_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the versions of an alarm model.

The operation returns only the metadata associated with each alarm model version.

list_alarm_models(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the alarm models that you created.

The operation returns only the metadata associated with each alarm model.

list_detector_model_versions(client, detector_model_name, max_results \\ nil, next_token \\ nil, options \\ [])

Lists all the versions of a detector model.

Only the metadata associated with each detector model version is returned.

list_detector_models(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the detector models you have created.

Only the metadata associated with each detector model is returned.

list_input_routings(client, input, options \\ [])

Lists one or more input routings.

list_inputs(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the inputs you have created.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags (metadata) you have assigned to the resource.

metadata()

put_logging_options(client, input, options \\ [])

Sets or updates the AWS IoT Events logging options.

If you update the value of any loggingOptions 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.

start_detector_model_analysis(client, input, options \\ [])

Performs an analysis of your detector model.

For more information, see Troubleshooting a detector model in the AWS IoT Events Developer Guide.

tag_resource(client, input, options \\ [])

Adds to or modifies the tags of the given resource.

Tags are metadata that can be used to manage a resource.

untag_resource(client, input, options \\ [])

Removes the given tags (metadata) from the resource.

update_alarm_model(client, alarm_model_name, input, options \\ [])

Updates an alarm model.

Any alarms that were created based on the previous version are deleted and then created again as new data arrives.

update_detector_model(client, detector_model_name, input, options \\ [])

Updates a detector model.

Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.

update_input(client, input_name, input, options \\ [])

Updates an input.