Expand description
Data structures used by operation inputs/outputs.
Modules§
Structs§
- Action
A configuration that specifies the action to perform when anomalies are detected.
- Alert
A configuration for Amazon SNS-integrated notifications.
- Alert
Filters The configuration of the alert filters.
- Alert
Summary Provides a summary of an alert's configuration.
- Anomaly
Detector Config Contains information about a detector's configuration.
- Anomaly
Detector Config Summary Contains information about a detector's configuration.
- Anomaly
Detector Data Quality Metric Aggregated details about the data quality metrics collected for the
AnomalyDetectorArn
provided in theGetDataQualityMetrics
object.- Anomaly
Detector Summary Contains information about an an anomaly detector.
- Anomaly
Group A group of anomalous metrics
- Anomaly
Group Statistics Aggregated statistics for a group of anomalous metrics.
- Anomaly
Group Summary Details about a group of anomalous metrics.
- Anomaly
Group Time Series An anomalous metric in an anomaly group.
- Anomaly
Group Time Series Feedback Feedback for an anomalous metric.
- AppFlow
Config Details about an Amazon AppFlow flow datasource.
- Athena
Source Config Details about an Amazon Athena datasource.
- Attribute
Value An attribute value.
- Auto
Detection Metric Source An auto detection metric source.
- Auto
Detection S3Source Config An auto detection source config.
- Back
Test Configuration Settings for backtest mode.
- Cloud
Watch Config Details about an Amazon CloudWatch datasource.
- Contribution
Matrix Details about dimensions that contributed to an anomaly.
- CsvFormat
Descriptor Contains information about how a source CSV data file should be analyzed.
- Data
Quality Metric 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.- Detected
CsvFormat Descriptor Properties of an inferred CSV format.
- Detected
Field An inferred field.
- Detected
File Format Descriptor Properties of an inferred data format.
- Detected
Json Format Descriptor A detected JSON format descriptor.
- Detected
Metric SetConfig An inferred dataset configuration.
- Detected
Metric Source An inferred data source.
- Detected
S3Source Config An inferred source configuration.
- Dimension
Contribution Details about a dimension that contributed to an anomaly.
- Dimension
Filter The dimension filter, containing DimensionName and DimensionValueList.
- Dimension
Name Value A dimension name and value.
- Dimension
Value Contribution The severity of a value of a dimension that contributed to an anomaly.
- Execution
Status The status of an anomaly detector run.
- File
Format Descriptor 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.- Inter
Metric Impact Details Aggregated details about the measures contributing to the anomaly group, and the measures potentially impacted by the anomaly group.
- Itemized
Metric Stats Aggregated statistics about a measure affected by an anomaly.
- Json
Format Descriptor Contains information about how a source JSON data file should be analyzed.
- Lambda
Configuration Contains information about a Lambda configuration.
- Metric
A calculation made by contrasting a measure and a dimension from your source data.
- Metric
Level Impact Details about a measure affected by an anomaly.
- Metric
SetData Quality Metric An array of
DataQualityMetric
objects that describes one or more data quality metrics.- Metric
SetDimension Filter 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.
- Metric
SetSummary Contains information about a dataset.
- Metric
Source Contains information about source data used to generate metrics.
- RdsSource
Config Contains information about the Amazon Relational Database Service (RDS) configuration.
- Redshift
Source Config Provides information about the Amazon Redshift database configuration.
- S3Source
Config Contains information about the configuration of the S3 bucket that contains source files.
- Sample
Data S3Source Config 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.
- Time
Series 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.
- Time
Series Feedback Details about feedback submitted for an anomalous metric.
- Timestamp
Column Contains information about the column used to track time in a source data file.
- Validation
Exception Field Contains information about a a field in a validation exception.
- VpcConfiguration
Contains configuration information about the Amazon Virtual Private Cloud (VPC).
Enums§
- Aggregation
Function - 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. - Alert
Status - 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. - Alert
Type - 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. - Anomaly
Detection Task Status - 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. - Anomaly
Detector Failure Type - 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. - Anomaly
Detector Status - 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. - CsvFile
Compression - 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. - Data
Quality Metric Type - 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. - Filter
Operation - 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. - Json
File Compression - 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. - Relationship
Type - 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. - Validation
Exception Reason - 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.