View Source aws_iot_events (aws v0.3.1)

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

Creates a detector model.
Creates an input.
Retrieves execution information about a detector model analysis
Describes an input.
Retrieves the current settings of the AWS IoT Events logging options.
Retrieves one or more analysis results of the detector model.

Lists all the versions of a detector model.

Lists the detector models you have created.

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

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.

Removes the given tags (metadata) from the resource.

Link to this section Functions

Link to this function

create_detector_model(Client, Input)

View Source
Creates a detector model.
Link to this function

create_detector_model(Client, Input0, Options0)

View Source
Link to this function

create_input(Client, Input)

View Source
Creates an input.
Link to this function

create_input(Client, Input0, Options0)

View Source
Link to this function

delete_detector_model(Client, DetectorModelName, Input)

View Source

Deletes a detector model.

Any active instances of the detector model are also deleted.
Link to this function

delete_detector_model(Client, DetectorModelName, Input0, Options0)

View Source
Link to this function

delete_input(Client, InputName, Input)

View Source
Deletes an input.
Link to this function

delete_input(Client, InputName, Input0, Options0)

View Source
Link to this function

describe_detector_model(Client, DetectorModelName)

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(Client, DetectorModelName, QueryMap, HeadersMap)

View Source
Link to this function

describe_detector_model(Client, DetectorModelName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_detector_model_analysis(Client, AnalysisId)

View Source
Retrieves execution information about a detector model analysis
Link to this function

describe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap)

View Source
Link to this function

describe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_input(Client, InputName)

View Source
Describes an input.
Link to this function

describe_input(Client, InputName, QueryMap, HeadersMap)

View Source
Link to this function

describe_input(Client, InputName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

describe_logging_options(Client)

View Source
Retrieves the current settings of the AWS IoT Events logging options.
Link to this function

describe_logging_options(Client, QueryMap, HeadersMap)

View Source
Link to this function

describe_logging_options(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

get_detector_model_analysis_results(Client, AnalysisId)

View Source
Retrieves one or more analysis results of the detector model.
Link to this function

get_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap)

View Source
Link to this function

get_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_detector_model_versions(Client, DetectorModelName)

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_model_versions(Client, DetectorModelName, QueryMap, HeadersMap)

View Source
Link to this function

list_detector_model_versions(Client, DetectorModelName, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_detector_models(Client)

View Source

Lists the detector models you have created.

Only the metadata associated with each detector model is returned.
Link to this function

list_detector_models(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_detector_models(Client, QueryMap, HeadersMap, Options0)

View Source
Lists the inputs you have created.
Link to this function

list_inputs(Client, QueryMap, HeadersMap)

View Source
Link to this function

list_inputs(Client, QueryMap, HeadersMap, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Lists the tags (metadata) you have assigned to the resource.
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)

View Source
Link to this function

put_logging_options(Client, Input)

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

put_logging_options(Client, Input0, Options0)

View Source
Link to this function

start_detector_model_analysis(Client, Input)

View Source

Performs an analysis of your detector model.

For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.
Link to this function

start_detector_model_analysis(Client, Input0, Options0)

View Source
Link to this function

tag_resource(Client, Input)

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

tag_resource(Client, Input0, Options0)

View Source
Link to this function

untag_resource(Client, Input)

View Source
Removes the given tags (metadata) from the resource.
Link to this function

untag_resource(Client, Input0, Options0)

View Source
Link to this function

update_detector_model(Client, DetectorModelName, Input)

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_detector_model(Client, DetectorModelName, Input0, Options0)

View Source
Link to this function

update_input(Client, InputName, Input)

View Source
Updates an input.
Link to this function

update_input(Client, InputName, Input0, Options0)

View Source