Module types

Module types 

Source
Expand description

Data structures used by operation inputs/outputs.

Modules§

builders
Builders
error
Error types that Amazon Lookout for Metrics can respond with.

Structs§

Action

A configuration that specifies the action to perform when anomalies are detected.

Alert

A configuration for Amazon SNS-integrated notifications.

AlertFilters

The configuration of the alert filters.

AlertSummary

Provides a summary of an alert's configuration.

AnomalyDetectorConfig

Contains information about a detector's configuration.

AnomalyDetectorConfigSummary

Contains information about a detector's configuration.

AnomalyDetectorDataQualityMetric

Aggregated details about the data quality metrics collected for the AnomalyDetectorArn provided in the GetDataQualityMetrics object.

AnomalyDetectorSummary

Contains information about an an anomaly detector.

AnomalyGroup

A group of anomalous metrics

AnomalyGroupStatistics

Aggregated statistics for a group of anomalous metrics.

AnomalyGroupSummary

Details about a group of anomalous metrics.

AnomalyGroupTimeSeries

An anomalous metric in an anomaly group.

AnomalyGroupTimeSeriesFeedback

Feedback for an anomalous metric.

AppFlowConfig

Details about an Amazon AppFlow flow datasource.

AthenaSourceConfig

Details about an Amazon Athena datasource.

AttributeValue

An attribute value.

AutoDetectionMetricSource

An auto detection metric source.

AutoDetectionS3SourceConfig

An auto detection source config.

BackTestConfiguration

Settings for backtest mode.

CloudWatchConfig

Details about an Amazon CloudWatch datasource.

ContributionMatrix

Details about dimensions that contributed to an anomaly.

CsvFormatDescriptor

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

DataQualityMetric

An array that describes a data quality metric. Each DataQualityMetric object contains the data quality metric name, its value, a description of the metric, and the affected column.

DetectedCsvFormatDescriptor

Properties of an inferred CSV format.

DetectedField

An inferred field.

DetectedFileFormatDescriptor

Properties of an inferred data format.

DetectedJsonFormatDescriptor

A detected JSON format descriptor.

DetectedMetricSetConfig

An inferred dataset configuration.

DetectedMetricSource

An inferred data source.

DetectedS3SourceConfig

An inferred source configuration.

DimensionContribution

Details about a dimension that contributed to an anomaly.

DimensionFilter

The dimension filter, containing DimensionName and DimensionValueList.

DimensionNameValue

A dimension name and value.

DimensionValueContribution

The severity of a value of a dimension that contributed to an anomaly.

ExecutionStatus

The status of an anomaly detector run.

FileFormatDescriptor

Contains information about a source file's formatting.

Filter

Describes a filter for choosing a subset of dimension values. Each filter consists of the dimension that you want to include and the condition statement. The condition statement is specified in the FilterOperation object.

InterMetricImpactDetails

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

ItemizedMetricStats

Aggregated statistics about a measure affected by an anomaly.

JsonFormatDescriptor

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

LambdaConfiguration

Contains information about a Lambda configuration.

Metric

A calculation made by contrasting a measure and a dimension from your source data.

MetricLevelImpact

Details about a measure affected by an anomaly.

MetricSetDataQualityMetric

An array of DataQualityMetric objects that describes one or more data quality metrics.

MetricSetDimensionFilter

Describes a list of filters for choosing a subset of dimension 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.

MetricSetSummary

Contains information about a dataset.

MetricSource

Contains information about source data used to generate metrics.

RdsSourceConfig

Contains information about the Amazon Relational Database Service (RDS) configuration.

RedshiftSourceConfig

Provides information about the Amazon Redshift database configuration.

S3SourceConfig

Contains information about the configuration of the S3 bucket that contains source files.

SampleDataS3SourceConfig

Contains information about the source configuration in Amazon S3.

SnsConfiguration

Contains information about the SNS topic to which you want to send your alerts and the IAM role that has access to that topic.

TimeSeries

Details about a metric. A metric is an aggregation of the values of a measure for a dimension value, such as availability in the us-east-1 Region.

TimeSeriesFeedback

Details about feedback submitted for an anomalous metric.

TimestampColumn

Contains information about the column used to track time in a source data file.

ValidationExceptionField

Contains information about a a field in a validation exception.

VpcConfiguration

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

Enums§

AggregationFunction
When writing a match expression against AggregationFunction, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AlertStatus
When writing a match expression against AlertStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AlertType
When writing a match expression against AlertType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AnomalyDetectionTaskStatus
When writing a match expression against AnomalyDetectionTaskStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AnomalyDetectorFailureType
When writing a match expression against AnomalyDetectorFailureType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
AnomalyDetectorStatus
When writing a match expression against AnomalyDetectorStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Confidence
When writing a match expression against Confidence, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
CsvFileCompression
When writing a match expression against CsvFileCompression, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
DataQualityMetricType
When writing a match expression against DataQualityMetricType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
FilterOperation
When writing a match expression against FilterOperation, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
Frequency
When writing a match expression against Frequency, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
JsonFileCompression
When writing a match expression against JsonFileCompression, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
RelationshipType
When writing a match expression against RelationshipType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
SnsFormat
When writing a match expression against SnsFormat, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.
ValidationExceptionReason
When writing a match expression against ValidationExceptionReason, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.