aws-elixir

View Source AWS.IoTEvents (aws-elixir 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.

Link to this section Summary

Functions

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

Creates an alarm model to monitor an AWS IoT Events input attribute.

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.

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

Deletes a detector model.

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.

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

Describes a detector model.

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

Retrieves runtime information about a detector model analysis.

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.

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

Lists all the versions of an alarm model.

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

Lists the alarm models that you created.

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

Lists all the versions of a detector model.

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

Lists the detector models you have created.

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.

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

Performs an analysis of your detector model.

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

Adds to or modifies the tags of the given 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.

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

Updates a detector model.

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

Updates an input.

Link to this section Functions

Link to this function

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

View Source

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 in the AWS IoT Events Developer Guide.

Link to this function

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

View Source

Creates a detector model.

Link to this function

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

View Source

Creates an input.

Link to this function

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

View Source

Deletes an alarm model.

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

Link to this function

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

View Source

Deletes a detector model.

Any active instances of the detector model are also deleted.

Link to this function

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

View Source

Deletes an input.

Link to this function

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

View Source

Retrieves information about an alarm model.

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

Link to this function

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

View Source

Describes a detector model.

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

Link to this function

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

View Source

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.

Link to this function

describe_input(client, input_name, options \\ [])

View Source

Describes an input.

Link to this function

describe_logging_options(client, options \\ [])

View Source

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

Link to this function

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

View Source

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.

Link to this function

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

View Source

Lists all the versions of an alarm model.

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

Link to this function

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

View Source

Lists the alarm models that you created.

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

Link to this function

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

View Source

Lists all the versions of a detector model.

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

Link to this function

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

View Source

Lists the detector models you have created.

Only the metadata associated with each detector model is returned.

Link to this function

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

View Source

Lists one or more input routings.

Link to this function

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

View Source

Lists the inputs you have created.

Link to this function

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

View Source

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

Link to this function

metadata()

View Source
Link to this function

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

View Source

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.

Link to this function

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

View Source

Performs an analysis of your detector model.

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

Link to this function

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

View Source

Adds to or modifies the tags of the given resource.

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

Link to this function

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

View Source

Removes the given tags (metadata) from the resource.

Link to this function

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

View Source

Updates an alarm model.

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

Link to this function

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

View Source

Updates a detector model.

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

Link to this function

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

View Source

Updates an input.