AWS.LookoutMetrics (aws-elixir v0.8.0) View Source

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.

Link to this section Summary

Functions

Runs a backtest for anomaly detection for the specified resource.

Creates an alert for an anomaly detector.

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

Returns details about a group of anomalous 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.

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 for a detector, dataset, or alert.

Add feedback for an anomalous metric.

Adds tags to a detector, dataset, or alert.

Removes tags from a detector, dataset, or alert.

Link to this section Functions

Link to this function

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

View Source

Activates an anomaly detector.

Link to this function

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

View Source

Runs a backtest for anomaly detection for the specified resource.

Link to this function

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

View Source

Creates an alert for an anomaly detector.

Link to this function

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

View Source

Creates an anomaly detector.

Link to this function

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

View Source

Creates a dataset.

Link to this function

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

View Source

Deletes an alert.

Link to this function

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

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

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

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_anomaly_detection_executions(client, input, options \\ [])

View Source

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

Link to this function

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

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_metric_set(client, input, options \\ [])

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

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

View Source

Returns details about a group of anomalous metrics.

Link to this function

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

View Source

Get feedback for an anomaly group.

Link to this function

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

View Source

Returns a selection of sample records from an Amazon S3 datasource.

Link to this function

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

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_anomaly_detectors(client, input, options \\ [])

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_group_summaries(client, input, options \\ [])

View Source

Returns a list of anomaly groups.

Link to this function

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

View Source

Gets a list of anomalous metrics for a measure in an anomaly group.

Link to this function

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

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_tags_for_resource(client, resource_arn, options \\ [])

View Source

Gets a list of tags for a detector, dataset, or alert.

Link to this function

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

View Source

Add feedback for an anomalous metric.

Link to this function

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

View Source

Adds tags to a detector, dataset, or alert.

Link to this function

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

View Source

Removes tags from a detector, dataset, or alert.

Link to this function

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

View Source

Updates a detector.

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

Link to this function

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

View Source

Updates a dataset.