NAME

Paws::LookoutMetrics - Perl Interface to AWS Amazon Lookout for Metrics

SYNOPSIS

  use Paws;

  my $obj = Paws->service('LookoutMetrics');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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).

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/lookoutmetrics-2017-07-25

METHODS

ActivateAnomalyDetector

AnomalyDetectorArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::ActivateAnomalyDetector

Returns: a Paws::LookoutMetrics::ActivateAnomalyDetectorResponse instance

Activates an anomaly detector.

BackTestAnomalyDetector

AnomalyDetectorArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::BackTestAnomalyDetector

Returns: a Paws::LookoutMetrics::BackTestAnomalyDetectorResponse instance

Runs a backtest for anomaly detection for the specified resource.

CreateAlert

Action => Paws::LookoutMetrics::Action
AlertName => Str
AlertSensitivityThreshold => Int
AnomalyDetectorArn => Str
[AlertDescription => Str]
[Tags => Paws::LookoutMetrics::TagMap]

Each argument is described in detail in: Paws::LookoutMetrics::CreateAlert

Returns: a Paws::LookoutMetrics::CreateAlertResponse instance

Creates an alert for an anomaly detector.

CreateAnomalyDetector

AnomalyDetectorConfig => Paws::LookoutMetrics::AnomalyDetectorConfig
AnomalyDetectorName => Str
[AnomalyDetectorDescription => Str]
[KmsKeyArn => Str]
[Tags => Paws::LookoutMetrics::TagMap]

Each argument is described in detail in: Paws::LookoutMetrics::CreateAnomalyDetector

Returns: a Paws::LookoutMetrics::CreateAnomalyDetectorResponse instance

Creates an anomaly detector.

CreateMetricSet

AnomalyDetectorArn => Str
MetricList => ArrayRef[Paws::LookoutMetrics::Metric]
MetricSetName => Str
MetricSource => Paws::LookoutMetrics::MetricSource
[DimensionList => ArrayRef[Str|Undef]]
[MetricSetDescription => Str]
[MetricSetFrequency => Str]
[Offset => Int]
[Tags => Paws::LookoutMetrics::TagMap]
[TimestampColumn => Paws::LookoutMetrics::TimestampColumn]
[Timezone => Str]

Each argument is described in detail in: Paws::LookoutMetrics::CreateMetricSet

Returns: a Paws::LookoutMetrics::CreateMetricSetResponse instance

Creates a dataset.

DeleteAlert

AlertArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::DeleteAlert

Returns: a Paws::LookoutMetrics::DeleteAlertResponse instance

Deletes an alert.

DeleteAnomalyDetector

AnomalyDetectorArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::DeleteAnomalyDetector

Returns: a Paws::LookoutMetrics::DeleteAnomalyDetectorResponse instance

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

DescribeAlert

AlertArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::DescribeAlert

Returns: a Paws::LookoutMetrics::DescribeAlertResponse instance

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.

DescribeAnomalyDetectionExecutions

AnomalyDetectorArn => Str
[MaxResults => Int]
[NextToken => Str]
[Timestamp => Str]

Each argument is described in detail in: Paws::LookoutMetrics::DescribeAnomalyDetectionExecutions

Returns: a Paws::LookoutMetrics::DescribeAnomalyDetectionExecutionsResponse instance

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

DescribeAnomalyDetector

AnomalyDetectorArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::DescribeAnomalyDetector

Returns: a Paws::LookoutMetrics::DescribeAnomalyDetectorResponse instance

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.

DescribeMetricSet

MetricSetArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::DescribeMetricSet

Returns: a Paws::LookoutMetrics::DescribeMetricSetResponse instance

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.

GetAnomalyGroup

AnomalyDetectorArn => Str
AnomalyGroupId => Str

Each argument is described in detail in: Paws::LookoutMetrics::GetAnomalyGroup

Returns: a Paws::LookoutMetrics::GetAnomalyGroupResponse instance

Returns details about a group of anomalous metrics.

GetFeedback

AnomalyDetectorArn => Str
AnomalyGroupTimeSeriesFeedback => Paws::LookoutMetrics::AnomalyGroupTimeSeries
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutMetrics::GetFeedback

Returns: a Paws::LookoutMetrics::GetFeedbackResponse instance

Get feedback for an anomaly group.

GetSampleData

[S3SourceConfig => Paws::LookoutMetrics::SampleDataS3SourceConfig]

Each argument is described in detail in: Paws::LookoutMetrics::GetSampleData

Returns: a Paws::LookoutMetrics::GetSampleDataResponse instance

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

ListAlerts

[AnomalyDetectorArn => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutMetrics::ListAlerts

Returns: a Paws::LookoutMetrics::ListAlertsResponse instance

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.

ListAnomalyDetectors

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutMetrics::ListAnomalyDetectors

Returns: a Paws::LookoutMetrics::ListAnomalyDetectorsResponse instance

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.

ListAnomalyGroupSummaries

AnomalyDetectorArn => Str
SensitivityThreshold => Int
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutMetrics::ListAnomalyGroupSummaries

Returns: a Paws::LookoutMetrics::ListAnomalyGroupSummariesResponse instance

Returns a list of anomaly groups.

ListAnomalyGroupTimeSeries

AnomalyDetectorArn => Str
AnomalyGroupId => Str
MetricName => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutMetrics::ListAnomalyGroupTimeSeries

Returns: a Paws::LookoutMetrics::ListAnomalyGroupTimeSeriesResponse instance

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

ListMetricSets

[AnomalyDetectorArn => Str]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::LookoutMetrics::ListMetricSets

Returns: a Paws::LookoutMetrics::ListMetricSetsResponse instance

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.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::LookoutMetrics::ListTagsForResource

Returns: a Paws::LookoutMetrics::ListTagsForResourceResponse instance

Gets a list of tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) for a detector, dataset, or alert.

PutFeedback

AnomalyDetectorArn => Str
AnomalyGroupTimeSeriesFeedback => Paws::LookoutMetrics::AnomalyGroupTimeSeriesFeedback

Each argument is described in detail in: Paws::LookoutMetrics::PutFeedback

Returns: a Paws::LookoutMetrics::PutFeedbackResponse instance

Add feedback for an anomalous metric.

TagResource

ResourceArn => Str
Tags => Paws::LookoutMetrics::TagMap

Each argument is described in detail in: Paws::LookoutMetrics::TagResource

Returns: a Paws::LookoutMetrics::TagResourceResponse instance

Adds tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) to a detector, dataset, or alert.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::LookoutMetrics::UntagResource

Returns: a Paws::LookoutMetrics::UntagResourceResponse instance

Removes tags (https://docs.aws.amazon.com/lookoutmetrics/latest/dev/detectors-tags.html) from a detector, dataset, or alert.

UpdateAnomalyDetector

AnomalyDetectorArn => Str
[AnomalyDetectorConfig => Paws::LookoutMetrics::AnomalyDetectorConfig]
[AnomalyDetectorDescription => Str]
[KmsKeyArn => Str]

Each argument is described in detail in: Paws::LookoutMetrics::UpdateAnomalyDetector

Returns: a Paws::LookoutMetrics::UpdateAnomalyDetectorResponse instance

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

UpdateMetricSet

MetricSetArn => Str
[DimensionList => ArrayRef[Str|Undef]]
[MetricList => ArrayRef[Paws::LookoutMetrics::Metric]]
[MetricSetDescription => Str]
[MetricSetFrequency => Str]
[MetricSource => Paws::LookoutMetrics::MetricSource]
[Offset => Int]
[TimestampColumn => Paws::LookoutMetrics::TimestampColumn]

Each argument is described in detail in: Paws::LookoutMetrics::UpdateMetricSet

Returns: a Paws::LookoutMetrics::UpdateMetricSetResponse instance

Updates a dataset.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues