View Source aws_lookoutmetrics (aws v1.0.4)

This is the Amazon Lookout for Metrics API Reference.

For an introduction to the service with tutorials for getting started, visit Amazon Lookout for Metrics Developer Guide: https://docs.aws.amazon.com/lookoutmetrics/latest/dev.

Summary

Functions

Activates an anomaly detector.
Runs a backtest for anomaly detection for the specified resource.
Creates an alert for an anomaly detector.
Creates an anomaly detector.
Deactivates an anomaly detector.
Deletes an alert.

Describes an alert.

Returns information about the status of the specified anomaly detection jobs.

Describes a dataset.

Detects an Amazon S3 dataset's file format, interval, and offset.
Returns details about a group of anomalous metrics.
Returns details about the requested data quality metrics.
Get feedback for an anomaly group.
Returns a selection of sample records from an Amazon S3 datasource.

Lists the alerts attached to a detector.

Lists the detectors in the current AWS Region.

Returns a list of measures that are potential causes or effects of an anomaly group.
Returns a list of anomaly groups.
Gets a list of anomalous metrics for a measure in an anomaly group.

Lists the datasets in the current AWS Region.

Gets a list of tags: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html for a detector, dataset, or alert.
Add feedback for an anomalous metric.
Adds tags: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html to a detector, dataset, or alert.
Removes tags: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html from a detector, dataset, or alert.
Make changes to an existing alert.

Functions

Link to this function

activate_anomaly_detector(Client, Input)

View Source
Activates an anomaly detector.
Link to this function

activate_anomaly_detector(Client, Input0, Options0)

View Source
Link to this function

back_test_anomaly_detector(Client, Input)

View Source
Runs a backtest for anomaly detection for the specified resource.
Link to this function

back_test_anomaly_detector(Client, Input0, Options0)

View Source
Link to this function

create_alert(Client, Input)

View Source
Creates an alert for an anomaly detector.
Link to this function

create_alert(Client, Input0, Options0)

View Source
Link to this function

create_anomaly_detector(Client, Input)

View Source
Creates an anomaly detector.
Link to this function

create_anomaly_detector(Client, Input0, Options0)

View Source
Link to this function

create_metric_set(Client, Input)

View Source
Creates a dataset.
Link to this function

create_metric_set(Client, Input0, Options0)

View Source
Link to this function

deactivate_anomaly_detector(Client, Input)

View Source
Deactivates an anomaly detector.
Link to this function

deactivate_anomaly_detector(Client, Input0, Options0)

View Source
Link to this function

delete_alert(Client, Input)

View Source
Deletes an alert.
Link to this function

delete_alert(Client, Input0, Options0)

View Source
Link to this function

delete_anomaly_detector(Client, Input)

View Source

Deletes a detector.

Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.
Link to this function

delete_anomaly_detector(Client, Input0, Options0)

View Source
Link to this function

describe_alert(Client, Input)

View Source

Describes an alert.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Link to this function

describe_alert(Client, Input0, Options0)

View Source
Link to this function

describe_anomaly_detection_executions(Client, Input)

View Source
Returns information about the status of the specified anomaly detection jobs.
Link to this function

describe_anomaly_detection_executions(Client, Input0, Options0)

View Source
Link to this function

describe_anomaly_detector(Client, Input)

View Source

Describes a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Link to this function

describe_anomaly_detector(Client, Input0, Options0)

View Source
Link to this function

describe_metric_set(Client, Input)

View Source

Describes a dataset.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Link to this function

describe_metric_set(Client, Input0, Options0)

View Source
Link to this function

detect_metric_set_config(Client, Input)

View Source
Detects an Amazon S3 dataset's file format, interval, and offset.
Link to this function

detect_metric_set_config(Client, Input0, Options0)

View Source
Link to this function

get_anomaly_group(Client, Input)

View Source
Returns details about a group of anomalous metrics.
Link to this function

get_anomaly_group(Client, Input0, Options0)

View Source
Link to this function

get_data_quality_metrics(Client, Input)

View Source
Returns details about the requested data quality metrics.
Link to this function

get_data_quality_metrics(Client, Input0, Options0)

View Source
Link to this function

get_feedback(Client, Input)

View Source
Get feedback for an anomaly group.
Link to this function

get_feedback(Client, Input0, Options0)

View Source
Link to this function

get_sample_data(Client, Input)

View Source
Returns a selection of sample records from an Amazon S3 datasource.
Link to this function

get_sample_data(Client, Input0, Options0)

View Source
Link to this function

list_alerts(Client, Input)

View Source

Lists the alerts attached to a detector.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Link to this function

list_alerts(Client, Input0, Options0)

View Source
Link to this function

list_anomaly_detectors(Client, Input)

View Source

Lists the detectors in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Link to this function

list_anomaly_detectors(Client, Input0, Options0)

View Source
Link to this function

list_anomaly_group_summaries(Client, Input)

View Source
Returns a list of anomaly groups.
Link to this function

list_anomaly_group_summaries(Client, Input0, Options0)

View Source
Link to this function

list_anomaly_group_time_series(Client, Input)

View Source
Gets a list of anomalous metrics for a measure in an anomaly group.
Link to this function

list_anomaly_group_time_series(Client, Input0, Options0)

View Source
Link to this function

list_metric_sets(Client, Input)

View Source

Lists the datasets in the current AWS Region.

Amazon Lookout for Metrics API actions are eventually consistent. If you do a read operation on a resource immediately after creating or modifying it, use retries to allow time for the write operation to complete.
Link to this function

list_metric_sets(Client, Input0, Options0)

View Source
Link to this function

list_tags_for_resource(Client, ResourceArn)

View Source
Gets a list of tags: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html for a detector, dataset, or alert.
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_feedback(Client, Input)

View Source
Add feedback for an anomalous metric.
Link to this function

put_feedback(Client, Input0, Options0)

View Source
Link to this function

tag_resource(Client, ResourceArn, Input)

View Source
Adds tags: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html to a detector, dataset, or alert.
Link to this function

tag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

untag_resource(Client, ResourceArn, Input)

View Source
Removes tags: https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html from a detector, dataset, or alert.
Link to this function

untag_resource(Client, ResourceArn, Input0, Options0)

View Source
Link to this function

update_alert(Client, Input)

View Source
Make changes to an existing alert.
Link to this function

update_alert(Client, Input0, Options0)

View Source
Link to this function

update_anomaly_detector(Client, Input)

View Source

Updates a detector.

After activation, you can only change a detector's ingestion delay and description.
Link to this function

update_anomaly_detector(Client, Input0, Options0)

View Source
Link to this function

update_metric_set(Client, Input)

View Source
Updates a dataset.
Link to this function

update_metric_set(Client, Input0, Options0)

View Source