amazonka-lookoutmetrics-2.0: Amazon Lookout for Metrics SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.LookoutMetrics.Lens

Contents

Description

 
Synopsis

Operations

ActivateAnomalyDetector

BackTestAnomalyDetector

backTestAnomalyDetector_anomalyDetectorArn :: Lens' BackTestAnomalyDetector Text Source #

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

CreateAlert

createAlert_alertFilters :: Lens' CreateAlert (Maybe AlertFilters) Source #

The configuration of the alert filters, containing MetricList and DimensionFilterList.

createAlert_alertSensitivityThreshold :: Lens' CreateAlert (Maybe Natural) Source #

An integer from 0 to 100 specifying the alert sensitivity threshold.

createAlert_tags :: Lens' CreateAlert (Maybe (HashMap Text Text)) Source #

A list of tags to apply to the alert.

createAlert_anomalyDetectorArn :: Lens' CreateAlert Text Source #

The ARN of the detector to which the alert is attached.

createAlert_action :: Lens' CreateAlert Action Source #

Action that will be triggered when there is an alert.

CreateAnomalyDetector

createAnomalyDetector_kmsKeyArn :: Lens' CreateAnomalyDetector (Maybe Text) Source #

The ARN of the KMS key to use to encrypt your data.

createAnomalyDetector_tags :: Lens' CreateAnomalyDetector (Maybe (HashMap Text Text)) Source #

A list of tags to apply to the anomaly detector.

createAnomalyDetector_anomalyDetectorConfig :: Lens' CreateAnomalyDetector AnomalyDetectorConfig Source #

Contains information about the configuration of the anomaly detector.

CreateMetricSet

createMetricSet_dimensionFilterList :: Lens' CreateMetricSet (Maybe [MetricSetDimensionFilter]) Source #

A list of filters that specify which data is kept for anomaly detection.

createMetricSet_dimensionList :: Lens' CreateMetricSet (Maybe (NonEmpty Text)) Source #

A list of the fields you want to treat as dimensions.

createMetricSet_metricSetDescription :: Lens' CreateMetricSet (Maybe Text) Source #

A description of the dataset you are creating.

createMetricSet_metricSetFrequency :: Lens' CreateMetricSet (Maybe Frequency) Source #

The frequency with which the source data will be analyzed for anomalies.

createMetricSet_offset :: Lens' CreateMetricSet (Maybe Natural) Source #

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

createMetricSet_tags :: Lens' CreateMetricSet (Maybe (HashMap Text Text)) Source #

A list of tags to apply to the dataset.

createMetricSet_timestampColumn :: Lens' CreateMetricSet (Maybe TimestampColumn) Source #

Contains information about the column used for tracking time in your source data.

createMetricSet_timezone :: Lens' CreateMetricSet (Maybe Text) Source #

The time zone in which your source data was recorded.

createMetricSet_anomalyDetectorArn :: Lens' CreateMetricSet Text Source #

The ARN of the anomaly detector that will use the dataset.

createMetricSet_metricList :: Lens' CreateMetricSet (NonEmpty Metric) Source #

A list of metrics that the dataset will contain.

createMetricSet_metricSource :: Lens' CreateMetricSet MetricSource Source #

Contains information about how the source data should be interpreted.

DeactivateAnomalyDetector

deactivateAnomalyDetector_anomalyDetectorArn :: Lens' DeactivateAnomalyDetector Text Source #

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

DeleteAlert

deleteAlert_alertArn :: Lens' DeleteAlert Text Source #

The ARN of the alert to delete.

DeleteAnomalyDetector

DescribeAlert

describeAlert_alertArn :: Lens' DescribeAlert Text Source #

The ARN of the alert to describe.

describeAlertResponse_alert :: Lens' DescribeAlertResponse (Maybe Alert) Source #

Contains information about an alert.

DescribeAnomalyDetectionExecutions

describeAnomalyDetectionExecutions_nextToken :: Lens' DescribeAnomalyDetectionExecutions (Maybe Text) Source #

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

describeAnomalyDetectionExecutionsResponse_nextToken :: Lens' DescribeAnomalyDetectionExecutionsResponse (Maybe Text) Source #

The pagination token that's included if more results are available.

DescribeAnomalyDetector

describeAnomalyDetectorResponse_kmsKeyArn :: Lens' DescribeAnomalyDetectorResponse (Maybe Text) Source #

The ARN of the KMS key to use to encrypt your data.

DescribeMetricSet

describeMetricSetResponse_anomalyDetectorArn :: Lens' DescribeMetricSetResponse (Maybe Text) Source #

The ARN of the detector that contains the dataset.

describeMetricSetResponse_dimensionFilterList :: Lens' DescribeMetricSetResponse (Maybe [MetricSetDimensionFilter]) Source #

The dimensions and their values that were used to filter the dataset.

describeMetricSetResponse_metricSetFrequency :: Lens' DescribeMetricSetResponse (Maybe Frequency) Source #

The interval at which the data will be analyzed for anomalies.

describeMetricSetResponse_metricSource :: Lens' DescribeMetricSetResponse (Maybe MetricSource) Source #

Contains information about the dataset's source data.

describeMetricSetResponse_offset :: Lens' DescribeMetricSetResponse (Maybe Natural) Source #

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

describeMetricSetResponse_timestampColumn :: Lens' DescribeMetricSetResponse (Maybe TimestampColumn) Source #

Contains information about the column used for tracking time in your source data.

describeMetricSetResponse_timezone :: Lens' DescribeMetricSetResponse (Maybe Text) Source #

The time zone in which the dataset's data was recorded.

DetectMetricSetConfig

GetAnomalyGroup

getAnomalyGroup_anomalyDetectorArn :: Lens' GetAnomalyGroup Text Source #

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

GetDataQualityMetrics

getDataQualityMetrics_metricSetArn :: Lens' GetDataQualityMetrics (Maybe Text) Source #

The Amazon Resource Name (ARN) of a specific data quality metric set.

getDataQualityMetrics_anomalyDetectorArn :: Lens' GetDataQualityMetrics Text Source #

The Amazon Resource Name (ARN) of the anomaly detector that you want to investigate.

GetFeedback

getFeedback_maxResults :: Lens' GetFeedback (Maybe Natural) Source #

The maximum number of results to return.

getFeedback_nextToken :: Lens' GetFeedback (Maybe Text) Source #

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

getFeedback_anomalyDetectorArn :: Lens' GetFeedback Text Source #

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

getFeedbackResponse_nextToken :: Lens' GetFeedbackResponse (Maybe Text) Source #

The pagination token that's included if more results are available.

GetSampleData

getSampleDataResponse_headerValues :: Lens' GetSampleDataResponse (Maybe [Text]) Source #

A list of header labels for the records.

ListAlerts

listAlerts_anomalyDetectorArn :: Lens' ListAlerts (Maybe Text) Source #

The ARN of the alert's detector.

listAlerts_maxResults :: Lens' ListAlerts (Maybe Natural) Source #

The maximum number of results that will be displayed by the request.

listAlerts_nextToken :: Lens' ListAlerts (Maybe Text) Source #

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.

listAlertsResponse_nextToken :: Lens' ListAlertsResponse (Maybe Text) Source #

If the response is truncated, the service returns this token. To retrieve the next set of results, use this token in the next request.

ListAnomalyDetectors

listAnomalyDetectors_maxResults :: Lens' ListAnomalyDetectors (Maybe Natural) Source #

The maximum number of results to return.

listAnomalyDetectors_nextToken :: Lens' ListAnomalyDetectors (Maybe Text) Source #

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.

listAnomalyDetectorsResponse_nextToken :: Lens' ListAnomalyDetectorsResponse (Maybe Text) Source #

If the response is truncated, the service returns this token. To retrieve the next set of results, use the token in the next request.

ListAnomalyGroupRelatedMetrics

listAnomalyGroupRelatedMetrics_nextToken :: Lens' ListAnomalyGroupRelatedMetrics (Maybe Text) Source #

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

listAnomalyGroupRelatedMetrics_relationshipTypeFilter :: Lens' ListAnomalyGroupRelatedMetrics (Maybe RelationshipType) Source #

Filter for potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP) or downstream effects (EFFECT_OF_INPUT_ANOMALY_GROUP) of the anomaly group.

listAnomalyGroupRelatedMetricsResponse_interMetricImpactList :: Lens' ListAnomalyGroupRelatedMetricsResponse (Maybe [InterMetricImpactDetails]) Source #

Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.

listAnomalyGroupRelatedMetricsResponse_nextToken :: Lens' ListAnomalyGroupRelatedMetricsResponse (Maybe Text) Source #

The pagination token that's included if more results are available.

ListAnomalyGroupSummaries

listAnomalyGroupSummaries_nextToken :: Lens' ListAnomalyGroupSummaries (Maybe Text) Source #

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

listAnomalyGroupSummaries_anomalyDetectorArn :: Lens' ListAnomalyGroupSummaries Text Source #

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

listAnomalyGroupSummaries_sensitivityThreshold :: Lens' ListAnomalyGroupSummaries Natural Source #

The minimum severity score for inclusion in the output.

listAnomalyGroupSummariesResponse_nextToken :: Lens' ListAnomalyGroupSummariesResponse (Maybe Text) Source #

The pagination token that's included if more results are available.

ListAnomalyGroupTimeSeries

listAnomalyGroupTimeSeries_nextToken :: Lens' ListAnomalyGroupTimeSeries (Maybe Text) Source #

Specify the pagination token that's returned by a previous request to retrieve the next page of results.

listAnomalyGroupTimeSeries_anomalyDetectorArn :: Lens' ListAnomalyGroupTimeSeries Text Source #

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

listAnomalyGroupTimeSeriesResponse_nextToken :: Lens' ListAnomalyGroupTimeSeriesResponse (Maybe Text) Source #

The pagination token that's included if more results are available.

ListMetricSets

listMetricSets_anomalyDetectorArn :: Lens' ListMetricSets (Maybe Text) Source #

The ARN of the anomaly detector containing the metrics sets to list.

listMetricSets_maxResults :: Lens' ListMetricSets (Maybe Natural) Source #

The maximum number of results to return.

listMetricSets_nextToken :: Lens' ListMetricSets (Maybe Text) Source #

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.

listMetricSetsResponse_metricSetSummaryList :: Lens' ListMetricSetsResponse (Maybe [MetricSetSummary]) Source #

A list of the datasets in the AWS Region, with configuration details for each.

listMetricSetsResponse_nextToken :: Lens' ListMetricSetsResponse (Maybe Text) Source #

If the response is truncated, the list call returns this token. To retrieve the next set of results, use the token in the next list request.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The resource's Amazon Resource Name (ARN).

PutFeedback

putFeedback_anomalyDetectorArn :: Lens' PutFeedback Text Source #

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

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The resource's Amazon Resource Name (ARN).

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

Tags to apply to the resource. Tag keys and values can contain letters, numbers, spaces, and the following symbols: _.:/=+@-

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The resource's Amazon Resource Name (ARN).

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

Keys to remove from the resource's tags.

UpdateAlert

updateAlert_action :: Lens' UpdateAlert (Maybe Action) Source #

Action that will be triggered when there is an alert.

updateAlert_alertFilters :: Lens' UpdateAlert (Maybe AlertFilters) Source #

The configuration of the alert filters, containing MetricList and DimensionFilterList.

updateAlert_alertSensitivityThreshold :: Lens' UpdateAlert (Maybe Natural) Source #

An integer from 0 to 100 specifying the alert sensitivity threshold.

updateAlert_alertArn :: Lens' UpdateAlert Text Source #

The ARN of the alert to update.

UpdateAnomalyDetector

updateAnomalyDetector_anomalyDetectorConfig :: Lens' UpdateAnomalyDetector (Maybe AnomalyDetectorConfig) Source #

Contains information about the configuration to which the detector will be updated.

updateAnomalyDetector_kmsKeyArn :: Lens' UpdateAnomalyDetector (Maybe Text) Source #

The Amazon Resource Name (ARN) of an AWS KMS encryption key.

UpdateMetricSet

updateMetricSet_dimensionFilterList :: Lens' UpdateMetricSet (Maybe [MetricSetDimensionFilter]) Source #

Describes a list of filters for choosing specific dimensions and specific values. Each filter consists of the dimension and one of its values that you want to include. When multiple dimensions or values are specified, the dimensions are joined with an AND operation and the values are joined with an OR operation.

updateMetricSet_offset :: Lens' UpdateMetricSet (Maybe Natural) Source #

After an interval ends, the amount of seconds that the detector waits before importing data. Offset is only supported for S3, Redshift, Athena and datasources.

updateMetricSet_metricSetArn :: Lens' UpdateMetricSet Text Source #

The ARN of the dataset to update.

Types

Action

action_lambdaConfiguration :: Lens' Action (Maybe LambdaConfiguration) Source #

A configuration for an AWS Lambda channel.

action_sNSConfiguration :: Lens' Action (Maybe SNSConfiguration) Source #

A configuration for an Amazon SNS channel.

Alert

alert_action :: Lens' Alert (Maybe Action) Source #

Action that will be triggered when there is an alert.

alert_alertArn :: Lens' Alert (Maybe Text) Source #

The ARN of the alert.

alert_alertDescription :: Lens' Alert (Maybe Text) Source #

A description of the alert.

alert_alertFilters :: Lens' Alert (Maybe AlertFilters) Source #

The configuration of the alert filters, containing MetricList and DimensionFilter.

alert_alertName :: Lens' Alert (Maybe Text) Source #

The name of the alert.

alert_alertSensitivityThreshold :: Lens' Alert (Maybe Natural) Source #

The minimum severity for an anomaly to trigger the alert.

alert_alertStatus :: Lens' Alert (Maybe AlertStatus) Source #

The status of the alert.

alert_alertType :: Lens' Alert (Maybe AlertType) Source #

The type of the alert.

alert_anomalyDetectorArn :: Lens' Alert (Maybe Text) Source #

The ARN of the detector to which the alert is attached.

alert_creationTime :: Lens' Alert (Maybe UTCTime) Source #

The time at which the alert was created.

alert_lastModificationTime :: Lens' Alert (Maybe UTCTime) Source #

The time at which the alert was last modified.

AlertFilters

alertFilters_dimensionFilterList :: Lens' AlertFilters (Maybe (NonEmpty DimensionFilter)) Source #

The list of DimensionFilter objects that are used for dimension-based filtering.

alertFilters_metricList :: Lens' AlertFilters (Maybe (NonEmpty Text)) Source #

The list of measures that you want to get alerts for.

AlertSummary

alertSummary_alertSensitivityThreshold :: Lens' AlertSummary (Maybe Natural) Source #

The minimum severity for an anomaly to trigger the alert.

alertSummary_anomalyDetectorArn :: Lens' AlertSummary (Maybe Text) Source #

The ARN of the detector to which the alert is attached.

alertSummary_creationTime :: Lens' AlertSummary (Maybe UTCTime) Source #

The time at which the alert was created.

alertSummary_lastModificationTime :: Lens' AlertSummary (Maybe UTCTime) Source #

The time at which the alert was last modified.

AnomalyDetectorConfig

anomalyDetectorConfig_anomalyDetectorFrequency :: Lens' AnomalyDetectorConfig (Maybe Frequency) Source #

The frequency at which the detector analyzes its source data.

AnomalyDetectorConfigSummary

AnomalyDetectorDataQualityMetric

anomalyDetectorDataQualityMetric_metricSetDataQualityMetricList :: Lens' AnomalyDetectorDataQualityMetric (Maybe [MetricSetDataQualityMetric]) Source #

An array of DataQualityMetricList objects. Each object in the array contains information about a data quality metric.

AnomalyDetectorSummary

anomalyDetectorSummary_creationTime :: Lens' AnomalyDetectorSummary (Maybe UTCTime) Source #

The time at which the detector was created.

anomalyDetectorSummary_lastModificationTime :: Lens' AnomalyDetectorSummary (Maybe UTCTime) Source #

The time at which the detector was last modified.

AnomalyGroup

anomalyGroup_endTime :: Lens' AnomalyGroup (Maybe Text) Source #

The end time for the group.

anomalyGroup_metricLevelImpactList :: Lens' AnomalyGroup (Maybe [MetricLevelImpact]) Source #

A list of measures affected by the anomaly.

anomalyGroup_primaryMetricName :: Lens' AnomalyGroup (Maybe Text) Source #

The name of the primary affected measure for the group.

anomalyGroup_startTime :: Lens' AnomalyGroup (Maybe Text) Source #

The start time for the group.

AnomalyGroupStatistics

anomalyGroupStatistics_evaluationStartDate :: Lens' AnomalyGroupStatistics (Maybe Text) Source #

The start of the time range that was searched.

AnomalyGroupSummary

anomalyGroupSummary_primaryMetricName :: Lens' AnomalyGroupSummary (Maybe Text) Source #

The name of the primary affected measure for the group.

AnomalyGroupTimeSeries

AnomalyGroupTimeSeriesFeedback

anomalyGroupTimeSeriesFeedback_isAnomaly :: Lens' AnomalyGroupTimeSeriesFeedback Bool Source #

Feedback on whether the metric is a legitimate anomaly.

AppFlowConfig

appFlowConfig_roleArn :: Lens' AppFlowConfig (Maybe Text) Source #

An IAM role that gives Amazon Lookout for Metrics permission to access the flow.

AthenaSourceConfig

athenaSourceConfig_roleArn :: Lens' AthenaSourceConfig (Maybe Text) Source #

An IAM role that gives Amazon Lookout for Metrics permission to access the data.

AttributeValue

attributeValue_bs :: Lens' AttributeValue (Maybe [Text]) Source #

A list of binary values.

AutoDetectionMetricSource

AutoDetectionS3SourceConfig

BackTestConfiguration

backTestConfiguration_runBackTestMode :: Lens' BackTestConfiguration Bool Source #

Run a backtest instead of monitoring new data.

CloudWatchConfig

cloudWatchConfig_roleArn :: Lens' CloudWatchConfig (Maybe Text) Source #

An IAM role that gives Amazon Lookout for Metrics permission to access data in Amazon CloudWatch.

ContributionMatrix

CsvFormatDescriptor

csvFormatDescriptor_charset :: Lens' CsvFormatDescriptor (Maybe Text) Source #

The character set in which the source CSV file is written.

csvFormatDescriptor_containsHeader :: Lens' CsvFormatDescriptor (Maybe Bool) Source #

Whether or not the source CSV file contains a header.

csvFormatDescriptor_delimiter :: Lens' CsvFormatDescriptor (Maybe Text) Source #

The character used to delimit the source CSV file.

csvFormatDescriptor_headerList :: Lens' CsvFormatDescriptor (Maybe [Text]) Source #

A list of the source CSV file's headers, if any.

csvFormatDescriptor_quoteSymbol :: Lens' CsvFormatDescriptor (Maybe Text) Source #

The character used as a quote character.

DataQualityMetric

dataQualityMetric_metricDescription :: Lens' DataQualityMetric (Maybe Text) Source #

A description of the data quality metric.

dataQualityMetric_metricValue :: Lens' DataQualityMetric (Maybe Double) Source #

The value of the data quality metric.

DetectedCsvFormatDescriptor

DetectedField

DetectedFileFormatDescriptor

DetectedJsonFormatDescriptor

DetectedMetricSetConfig

DetectedMetricSource

DetectedS3SourceConfig

DimensionContribution

DimensionFilter

dimensionFilter_dimensionName :: Lens' DimensionFilter (Maybe Text) Source #

The name of the dimension to filter on.

dimensionFilter_dimensionValueList :: Lens' DimensionFilter (Maybe (NonEmpty Text)) Source #

The list of values for the dimension specified in DimensionName that you want to filter on.

DimensionNameValue

DimensionValueContribution

ExecutionStatus

executionStatus_failureReason :: Lens' ExecutionStatus (Maybe Text) Source #

The reason that the run failed, if applicable.

FileFormatDescriptor

fileFormatDescriptor_csvFormatDescriptor :: Lens' FileFormatDescriptor (Maybe CsvFormatDescriptor) Source #

Contains information about how a source CSV data file should be analyzed.

fileFormatDescriptor_jsonFormatDescriptor :: Lens' FileFormatDescriptor (Maybe JsonFormatDescriptor) Source #

Contains information about how a source JSON data file should be analyzed.

Filter

filter_dimensionValue :: Lens' Filter (Maybe Text) Source #

The value that you want to include in the filter.

InterMetricImpactDetails

interMetricImpactDetails_contributionPercentage :: Lens' InterMetricImpactDetails (Maybe Double) Source #

For potential causes (CAUSE_OF_INPUT_ANOMALY_GROUP), the percentage contribution the measure has in causing the anomalies.

interMetricImpactDetails_relationshipType :: Lens' InterMetricImpactDetails (Maybe RelationshipType) Source #

Whether a measure is a potential cause of the anomaly group (CAUSE_OF_INPUT_ANOMALY_GROUP), or whether the measure is impacted by the anomaly group (EFFECT_OF_INPUT_ANOMALY_GROUP).

ItemizedMetricStats

itemizedMetricStats_occurrenceCount :: Lens' ItemizedMetricStats (Maybe Int) Source #

The number of times that the measure appears.

JsonFormatDescriptor

jsonFormatDescriptor_charset :: Lens' JsonFormatDescriptor (Maybe Text) Source #

The character set in which the source JSON file is written.

LambdaConfiguration

lambdaConfiguration_roleArn :: Lens' LambdaConfiguration Text Source #

The ARN of an IAM role that has permission to invoke the Lambda function.

Metric

metric_namespace :: Lens' Metric (Maybe Text) Source #

The namespace for the metric.

metric_metricName :: Lens' Metric Text Source #

The name of the metric.

metric_aggregationFunction :: Lens' Metric AggregationFunction Source #

The function with which the metric is calculated.

MetricLevelImpact

metricLevelImpact_contributionMatrix :: Lens' MetricLevelImpact (Maybe ContributionMatrix) Source #

Details about the dimensions that contributed to the anomaly.

metricLevelImpact_numTimeSeries :: Lens' MetricLevelImpact (Maybe Int) Source #

The number of anomalous metrics for the measure.

MetricSetDataQualityMetric

metricSetDataQualityMetric_dataQualityMetricList :: Lens' MetricSetDataQualityMetric (Maybe [DataQualityMetric]) Source #

The array of data quality metrics contained in the data quality metric set.

metricSetDataQualityMetric_metricSetArn :: Lens' MetricSetDataQualityMetric (Maybe Text) Source #

The Amazon Resource Name (ARN) of the data quality metric array.

MetricSetDimensionFilter

metricSetDimensionFilter_name :: Lens' MetricSetDimensionFilter (Maybe Text) Source #

The dimension that you want to filter on.

MetricSetSummary

metricSetSummary_anomalyDetectorArn :: Lens' MetricSetSummary (Maybe Text) Source #

The ARN of the detector to which the dataset belongs.

metricSetSummary_creationTime :: Lens' MetricSetSummary (Maybe UTCTime) Source #

The time at which the dataset was created.

metricSetSummary_lastModificationTime :: Lens' MetricSetSummary (Maybe UTCTime) Source #

The time at which the dataset was last modified.

MetricSource

metricSource_appFlowConfig :: Lens' MetricSource (Maybe AppFlowConfig) Source #

Details about an AppFlow datasource.

metricSource_athenaSourceConfig :: Lens' MetricSource (Maybe AthenaSourceConfig) Source #

Details about an Amazon Athena datasource.

metricSource_cloudWatchConfig :: Lens' MetricSource (Maybe CloudWatchConfig) Source #

Details about an Amazon CloudWatch monitoring datasource.

metricSource_rDSSourceConfig :: Lens' MetricSource (Maybe RDSSourceConfig) Source #

Details about an Amazon Relational Database Service (RDS) datasource.

metricSource_redshiftSourceConfig :: Lens' MetricSource (Maybe RedshiftSourceConfig) Source #

Details about an Amazon Redshift database datasource.

RDSSourceConfig

rDSSourceConfig_dbInstanceIdentifier :: Lens' RDSSourceConfig (Maybe Text) Source #

A string identifying the database instance.

rDSSourceConfig_databasePort :: Lens' RDSSourceConfig (Maybe Natural) Source #

The port number where the database can be accessed.

rDSSourceConfig_roleArn :: Lens' RDSSourceConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role.

rDSSourceConfig_secretManagerArn :: Lens' RDSSourceConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

rDSSourceConfig_tableName :: Lens' RDSSourceConfig (Maybe Text) Source #

The name of the table in the database.

rDSSourceConfig_vpcConfiguration :: Lens' RDSSourceConfig (Maybe VpcConfiguration) Source #

An object containing information about the Amazon Virtual Private Cloud (VPC) configuration.

RedshiftSourceConfig

redshiftSourceConfig_clusterIdentifier :: Lens' RedshiftSourceConfig (Maybe Text) Source #

A string identifying the Redshift cluster.

redshiftSourceConfig_databasePort :: Lens' RedshiftSourceConfig (Maybe Natural) Source #

The port number where the database can be accessed.

redshiftSourceConfig_roleArn :: Lens' RedshiftSourceConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the role providing access to the database.

redshiftSourceConfig_secretManagerArn :: Lens' RedshiftSourceConfig (Maybe Text) Source #

The Amazon Resource Name (ARN) of the AWS Secrets Manager role.

redshiftSourceConfig_tableName :: Lens' RedshiftSourceConfig (Maybe Text) Source #

The table name of the Redshift database.

redshiftSourceConfig_vpcConfiguration :: Lens' RedshiftSourceConfig (Maybe VpcConfiguration) Source #

Contains information about the Amazon Virtual Private Cloud (VPC) configuration.

S3SourceConfig

s3SourceConfig_fileFormatDescriptor :: Lens' S3SourceConfig (Maybe FileFormatDescriptor) Source #

Contains information about a source file's formatting.

s3SourceConfig_historicalDataPathList :: Lens' S3SourceConfig (Maybe (NonEmpty Text)) Source #

A list of paths to the historical data files.

s3SourceConfig_roleArn :: Lens' S3SourceConfig (Maybe Text) Source #

The ARN of an IAM role that has read and write access permissions to the source S3 bucket.

s3SourceConfig_templatedPathList :: Lens' S3SourceConfig (Maybe (NonEmpty Text)) Source #

A list of templated paths to the source files.

SNSConfiguration

sNSConfiguration_snsFormat :: Lens' SNSConfiguration (Maybe SnsFormat) Source #

The format of the SNS topic.

  • JSON – Send JSON alerts with an anomaly ID and a link to the anomaly detail page. This is the default.
  • LONG_TEXT – Send human-readable alerts with information about the impacted timeseries and a link to the anomaly detail page. We recommend this for email.
  • SHORT_TEXT – Send human-readable alerts with a link to the anomaly detail page. We recommend this for SMS.

sNSConfiguration_roleArn :: Lens' SNSConfiguration Text Source #

The ARN of the IAM role that has access to the target SNS topic.

sNSConfiguration_snsTopicArn :: Lens' SNSConfiguration Text Source #

The ARN of the target SNS topic.

SampleDataS3SourceConfig

sampleDataS3SourceConfig_historicalDataPathList :: Lens' SampleDataS3SourceConfig (Maybe (NonEmpty Text)) Source #

An array of strings containing the historical set of data paths.

sampleDataS3SourceConfig_templatedPathList :: Lens' SampleDataS3SourceConfig (Maybe (NonEmpty Text)) Source #

An array of strings containing the list of templated paths.

sampleDataS3SourceConfig_roleArn :: Lens' SampleDataS3SourceConfig Text Source #

The Amazon Resource Name (ARN) of the role.

TimeSeries

timeSeries_metricValueList :: Lens' TimeSeries [Double] Source #

The values for the metric.

TimeSeriesFeedback

timeSeriesFeedback_isAnomaly :: Lens' TimeSeriesFeedback (Maybe Bool) Source #

Feedback on whether the metric is a legitimate anomaly.

TimestampColumn

timestampColumn_columnFormat :: Lens' TimestampColumn (Maybe Text) Source #

The format of the timestamp column.

timestampColumn_columnName :: Lens' TimestampColumn (Maybe Text) Source #

The name of the timestamp column.

VpcConfiguration

vpcConfiguration_subnetIdList :: Lens' VpcConfiguration [Text] Source #

An array of strings containing the Amazon VPC subnet IDs (e.g., subnet-0bb1c79de3EXAMPLE.

vpcConfiguration_securityGroupIdList :: Lens' VpcConfiguration [Text] Source #

An array of strings containing the list of security groups.