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 Events API operations to create, read, update, and delete inputs and detector models, and to list their versions.Summary
Functions
-
create_detector_model(Client, Input)
Creates a detector model.
- create_detector_model(Client, Input0, Options0)
-
create_input(Client, Input)
Creates an input.
- create_input(Client, Input0, Options0)
-
delete_detector_model(Client, DetectorModelName, Input)
Deletes a detector model.
- delete_detector_model(Client, DetectorModelName, Input0, Options0)
-
delete_input(Client, InputName, Input)
Deletes an input.
- delete_input(Client, InputName, Input0, Options0)
-
describe_detector_model(Client, DetectorModelName)
Describes a detector model.
- describe_detector_model(Client, DetectorModelName, QueryMap, HeadersMap)
- describe_detector_model(Client, DetectorModelName, QueryMap, HeadersMap, Options0)
-
describe_detector_model_analysis(Client, AnalysisId)
Retrieves execution information about a detector model analysis.
- describe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap)
- describe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap, Options0)
-
describe_input(Client, InputName)
Describes an input.
- describe_input(Client, InputName, QueryMap, HeadersMap)
- describe_input(Client, InputName, QueryMap, HeadersMap, Options0)
-
describe_logging_options(Client)
Retrieves the current settings of the AWS IoT Events logging options.
- describe_logging_options(Client, QueryMap, HeadersMap)
- describe_logging_options(Client, QueryMap, HeadersMap, Options0)
-
get_detector_model_analysis_results(Client, AnalysisId)
Retrieves one or more analysis results of the detector model.
- get_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap)
- get_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap, Options0)
-
list_detector_model_versions(Client, DetectorModelName)
Lists all the versions of a detector model.
- list_detector_model_versions(Client, DetectorModelName, QueryMap, HeadersMap)
- list_detector_model_versions(Client, DetectorModelName, QueryMap, HeadersMap, Options0)
-
list_detector_models(Client)
Lists the detector models you have created.
- list_detector_models(Client, QueryMap, HeadersMap)
- list_detector_models(Client, QueryMap, HeadersMap, Options0)
-
list_inputs(Client)
Lists the inputs you have created.
- list_inputs(Client, QueryMap, HeadersMap)
- list_inputs(Client, QueryMap, HeadersMap, Options0)
-
list_tags_for_resource(Client, ResourceArn)
Lists the tags (metadata) you have assigned to the resource.
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
- list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
-
put_logging_options(Client, Input)
Sets or updates the AWS IoT Events logging options.
- put_logging_options(Client, Input0, Options0)
-
start_detector_model_analysis(Client, Input)
Performs an analysis of your detector model.
- start_detector_model_analysis(Client, Input0, Options0)
-
tag_resource(Client, Input)
Adds to or modifies the tags of the given resource.
- tag_resource(Client, Input0, Options0)
-
untag_resource(Client, Input)
Removes the given tags (metadata) from the resource.
- untag_resource(Client, Input0, Options0)
-
update_detector_model(Client, DetectorModelName, Input)
Updates a detector model.
- update_detector_model(Client, DetectorModelName, Input0, Options0)
-
update_input(Client, InputName, Input)
Updates an input.
- update_input(Client, InputName, Input0, Options0)
Functions
create_detector_model(Client, Input)
Creates a detector model.
create_detector_model(Client, Input0, Options0)
create_input(Client, Input)
Creates an input.
create_input(Client, Input0, Options0)
delete_detector_model(Client, DetectorModelName, Input)
Deletes a detector model.
Any active instances of the detector model are also deleted.delete_detector_model(Client, DetectorModelName, Input0, Options0)
delete_input(Client, InputName, Input)
Deletes an input.
delete_input(Client, InputName, Input0, Options0)
describe_detector_model(Client, DetectorModelName)
Describes a detector model.
If theversion
parameter is not specified, information about the latest
version is returned.
describe_detector_model(Client, DetectorModelName, QueryMap, HeadersMap)
describe_detector_model(Client, DetectorModelName, QueryMap, HeadersMap, Options0)
describe_detector_model_analysis(Client, AnalysisId)
Retrieves execution information about a detector model analysis
describe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap)
describe_detector_model_analysis(Client, AnalysisId, QueryMap, HeadersMap, Options0)
describe_input(Client, InputName)
Describes an input.
describe_input(Client, InputName, QueryMap, HeadersMap)
describe_input(Client, InputName, QueryMap, HeadersMap, Options0)
describe_logging_options(Client)
Retrieves the current settings of the AWS IoT Events logging options.
describe_logging_options(Client, QueryMap, HeadersMap)
describe_logging_options(Client, QueryMap, HeadersMap, Options0)
get_detector_model_analysis_results(Client, AnalysisId)
Retrieves one or more analysis results of the detector model.
get_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap)
get_detector_model_analysis_results(Client, AnalysisId, QueryMap, HeadersMap, Options0)
list_detector_model_versions(Client, DetectorModelName)
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)
list_detector_model_versions(Client, DetectorModelName, QueryMap, HeadersMap, Options0)
list_detector_models(Client)
Lists the detector models you have created.
Only the metadata associated with each detector model is returned.list_detector_models(Client, QueryMap, HeadersMap)
list_detector_models(Client, QueryMap, HeadersMap, Options0)
list_inputs(Client)
Lists the inputs you have created.
list_inputs(Client, QueryMap, HeadersMap)
list_inputs(Client, QueryMap, HeadersMap, Options0)
list_tags_for_resource(Client, ResourceArn)
Lists the tags (metadata) you have assigned to the resource.
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap)
list_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
put_logging_options(Client, Input)
Sets 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.
put_logging_options(Client, Input0, Options0)
start_detector_model_analysis(Client, Input)
Performs an analysis of your detector model.
For more information, see Running detector model analyses in the AWS IoT Events Developer Guide.start_detector_model_analysis(Client, Input0, Options0)
tag_resource(Client, Input)
Adds to or modifies the tags of the given resource.
Tags are metadata that can be used to manage a resource.tag_resource(Client, Input0, Options0)
untag_resource(Client, Input)
Removes the given tags (metadata) from the resource.
untag_resource(Client, Input0, Options0)
update_detector_model(Client, DetectorModelName, Input)
Updates a detector model.
Detectors (instances) spawned by the previous version are deleted and then re-created as new inputs arrive.update_detector_model(Client, DetectorModelName, Input0, Options0)
update_input(Client, InputName, Input)
Updates an input.