Lookoutmetrics

activate_anomaly_detector(anomaly_detector_arn)
activate_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})

Activates an anomaly detector.

Arguments

• anomaly_detector_arn: The ARN of the anomaly detector.

back_test_anomaly_detector(anomaly_detector_arn)
back_test_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})

Runs a backtest for anomaly detection for the specified resource.

Arguments

• anomaly_detector_arn: The Amazon Resource Name (ARN) of the anomaly detector.

create_alert(action, alert_name, alert_sensitivity_threshold, anomaly_detector_arn)
create_alert(action, alert_name, alert_sensitivity_threshold, anomaly_detector_arn, params::Dict{String,<:Any})

Creates an alert for an anomaly detector.

Arguments

• action: Action that will be triggered when there is an alert.
• alert_name: The name of the alert.
• alert_sensitivity_threshold: An integer from 0 to 100 specifying the alert sensitivity threshold.
• anomaly_detector_arn: The ARN of the detector to which the alert is attached.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AlertDescription": A description of the alert.
• "Tags": A list of tags to apply to the alert.

create_anomaly_detector(anomaly_detector_config, anomaly_detector_name)
create_anomaly_detector(anomaly_detector_config, anomaly_detector_name, params::Dict{String,<:Any})

Creates an anomaly detector.

Arguments

• anomaly_detector_config: Contains information about the configuration of the anomaly detector.
• anomaly_detector_name: The name of the detector.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AnomalyDetectorDescription": A description of the detector.
• "KmsKeyArn": The ARN of the KMS key to use to encrypt your data.
• "Tags": A list of tags to apply to the anomaly detector.

create_metric_set(anomaly_detector_arn, metric_list, metric_set_name, metric_source)
create_metric_set(anomaly_detector_arn, metric_list, metric_set_name, metric_source, params::Dict{String,<:Any})

Creates a dataset.

Arguments

• anomaly_detector_arn: The ARN of the anomaly detector that will use the dataset.
• metric_list: A list of metrics that the dataset will contain.
• metric_set_name: The name of the dataset.
• metric_source: Contains information about how the source data should be interpreted.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DimensionList": A list of the fields you want to treat as dimensions.
• "MetricSetDescription": A description of the dataset you are creating.
• "MetricSetFrequency": The frequency with which the source data will be analyzed for anomalies.
• "Offset": After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
• "Tags": A list of tags to apply to the dataset.
• "TimestampColumn": Contains information about the column used for tracking time in your source data.
• "Timezone": The time zone in which your source data was recorded.

delete_alert(alert_arn)
delete_alert(alert_arn, params::Dict{String,<:Any})

Deletes an alert.

Arguments

• alert_arn: The ARN of the alert to delete.

delete_anomaly_detector(anomaly_detector_arn)
delete_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})

Deletes a detector. Deleting an anomaly detector will delete all of its corresponding resources including any configured datasets and alerts.

Arguments

• anomaly_detector_arn: The ARN of the detector to delete.

describe_alert(alert_arn)
describe_alert(alert_arn, params::Dict{String,<:Any})

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.

Arguments

• alert_arn: The ARN of the alert to describe.

describe_anomaly_detection_executions(anomaly_detector_arn)
describe_anomaly_detection_executions(anomaly_detector_arn, params::Dict{String,<:Any})

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

Arguments

• anomaly_detector_arn: The Amazon Resource Name (ARN) of the anomaly detector.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The number of items to return in the response.
• "NextToken": Specify the pagination token that's returned by a previous request to retrieve the next page of results.
• "Timestamp": The timestamp of the anomaly detection job.

describe_anomaly_detector(anomaly_detector_arn)
describe_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})

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.

Arguments

• anomaly_detector_arn: The ARN of the detector to describe.

describe_metric_set(metric_set_arn)
describe_metric_set(metric_set_arn, params::Dict{String,<:Any})

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.

Arguments

• metric_set_arn: The ARN of the dataset.

get_anomaly_group(anomaly_detector_arn, anomaly_group_id)
get_anomaly_group(anomaly_detector_arn, anomaly_group_id, params::Dict{String,<:Any})

Returns details about a group of anomalous metrics.

Arguments

• anomaly_detector_arn: The Amazon Resource Name (ARN) of the anomaly detector.
• anomaly_group_id: The ID of the anomaly group.

get_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback)
get_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback, params::Dict{String,<:Any})

Get feedback for an anomaly group.

Arguments

• anomaly_detector_arn: The Amazon Resource Name (ARN) of the anomaly detector.
• anomaly_group_time_series_feedback: The anomalous metric and group ID.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return.
• "NextToken": Specify the pagination token that's returned by a previous request to retrieve the next page of results.

get_sample_data()
get_sample_data(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "S3SourceConfig": A datasource bucket in Amazon S3.

list_alerts()
list_alerts(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AnomalyDetectorArn": The ARN of the alert's detector.
• "MaxResults": The maximum number of results that will be displayed by the request.
• "NextToken": If the result of the previous request is truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

list_anomaly_detectors()
list_anomaly_detectors(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return.
• "NextToken": If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

list_anomaly_group_summaries(anomaly_detector_arn, sensitivity_threshold)
list_anomaly_group_summaries(anomaly_detector_arn, sensitivity_threshold, params::Dict{String,<:Any})

Returns a list of anomaly groups.

Arguments

• anomaly_detector_arn: The Amazon Resource Name (ARN) of the anomaly detector.
• sensitivity_threshold: The minimum severity score for inclusion in the output.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return.
• "NextToken": Specify the pagination token that's returned by a previous request to retrieve the next page of results.

list_anomaly_group_time_series(anomaly_detector_arn, anomaly_group_id, metric_name)
list_anomaly_group_time_series(anomaly_detector_arn, anomaly_group_id, metric_name, params::Dict{String,<:Any})

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

Arguments

• anomaly_detector_arn: The Amazon Resource Name (ARN) of the anomaly detector.
• anomaly_group_id: The ID of the anomaly group.
• metric_name: The name of the measure field.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "MaxResults": The maximum number of results to return.
• "NextToken": Specify the pagination token that's returned by a previous request to retrieve the next page of results.

list_metric_sets()
list_metric_sets(params::Dict{String,<:Any})

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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AnomalyDetectorArn": The ARN of the anomaly detector containing the metrics sets to list.
• "MaxResults": The maximum number of results to return.
• "NextToken": If the result of the previous request was truncated, the response includes a NextToken. To retrieve the next set of results, use the token in the next request. Tokens expire after 24 hours.

list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

• resource_arn: The resource's Amazon Resource Name (ARN).

put_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback)
put_feedback(anomaly_detector_arn, anomaly_group_time_series_feedback, params::Dict{String,<:Any})

Add feedback for an anomalous metric.

Arguments

• anomaly_detector_arn: The Amazon Resource Name (ARN) of the anomaly detector.
• anomaly_group_time_series_feedback: Feedback for an anomalous metric.

tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Adds tags to a detector, dataset, or alert.

Arguments

• resource_arn: The resource's Amazon Resource Name (ARN).
• tags: Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-

untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from a detector, dataset, or alert.

Arguments

• resource_arn: The resource's Amazon Resource Name (ARN).
• tag_keys: Keys to remove from the resource's tags.

update_anomaly_detector(anomaly_detector_arn)
update_anomaly_detector(anomaly_detector_arn, params::Dict{String,<:Any})

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

Arguments

• anomaly_detector_arn: The ARN of the detector to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "AnomalyDetectorConfig": Contains information about the configuration to which the detector will be updated.
• "AnomalyDetectorDescription": The updated detector description.
• "KmsKeyArn": The Amazon Resource Name (ARN) of an AWS KMS encryption key.

update_metric_set(metric_set_arn)
update_metric_set(metric_set_arn, params::Dict{String,<:Any})

Updates a dataset.

Arguments

• metric_set_arn: The ARN of the dataset to update.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

• "DimensionList": The dimension list.
• "MetricList": The metric list.
• "MetricSetDescription": The dataset's description.
• "MetricSetFrequency": The dataset's interval.
• "MetricSource":
• "Offset": After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3 and Redshift datasources.
• "TimestampColumn": The timestamp column.