Skip to content

Type definitions#

Index > LookoutMetrics > Type definitions

Auto-generated documentation for LookoutMetrics type annotations stubs module mypy-boto3-lookoutmetrics.

AlertFiltersUnionTypeDef#

# AlertFiltersUnionTypeDef definition

AlertFiltersUnionTypeDef = Union[
    AlertFiltersTypeDef,  # (1)
    AlertFiltersOutputTypeDef,  # (2)
]
  1. See AlertFiltersTypeDef
  2. See AlertFiltersOutputTypeDef

MetricSetDimensionFilterUnionTypeDef#

# MetricSetDimensionFilterUnionTypeDef definition

MetricSetDimensionFilterUnionTypeDef = Union[
    MetricSetDimensionFilterTypeDef,  # (1)
    MetricSetDimensionFilterOutputTypeDef,  # (2)
]
  1. See MetricSetDimensionFilterTypeDef
  2. See MetricSetDimensionFilterOutputTypeDef

MetricSourceUnionTypeDef#

# MetricSourceUnionTypeDef definition

MetricSourceUnionTypeDef = Union[
    MetricSourceTypeDef,  # (1)
    MetricSourceOutputTypeDef,  # (2)
]
  1. See MetricSourceTypeDef
  2. See MetricSourceOutputTypeDef

LambdaConfigurationTypeDef#

# LambdaConfigurationTypeDef definition

class LambdaConfigurationTypeDef(TypedDict):
    RoleArn: str,
    LambdaArn: str,

SNSConfigurationTypeDef#

# SNSConfigurationTypeDef definition

class SNSConfigurationTypeDef(TypedDict):
    RoleArn: str,
    SnsTopicArn: str,
    SnsFormat: NotRequired[SnsFormatType],  # (1)
  1. See SnsFormatType

ActivateAnomalyDetectorRequestRequestTypeDef#

# ActivateAnomalyDetectorRequestRequestTypeDef definition

class ActivateAnomalyDetectorRequestRequestTypeDef(TypedDict):
    AnomalyDetectorArn: str,

DimensionFilterOutputTypeDef#

# DimensionFilterOutputTypeDef definition

class DimensionFilterOutputTypeDef(TypedDict):
    DimensionName: NotRequired[str],
    DimensionValueList: NotRequired[List[str]],

DimensionFilterTypeDef#

# DimensionFilterTypeDef definition

class DimensionFilterTypeDef(TypedDict):
    DimensionName: NotRequired[str],
    DimensionValueList: NotRequired[Sequence[str]],

AlertSummaryTypeDef#

# AlertSummaryTypeDef definition

class AlertSummaryTypeDef(TypedDict):
    AlertArn: NotRequired[str],
    AnomalyDetectorArn: NotRequired[str],
    AlertName: NotRequired[str],
    AlertSensitivityThreshold: NotRequired[int],
    AlertType: NotRequired[AlertTypeType],  # (1)
    AlertStatus: NotRequired[AlertStatusType],  # (2)
    LastModificationTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],
    Tags: NotRequired[Dict[str, str]],
  1. See AlertTypeType
  2. See AlertStatusType

AnomalyDetectorConfigSummaryTypeDef#

# AnomalyDetectorConfigSummaryTypeDef definition

class AnomalyDetectorConfigSummaryTypeDef(TypedDict):
    AnomalyDetectorFrequency: NotRequired[FrequencyType],  # (1)
  1. See FrequencyType

AnomalyDetectorConfigTypeDef#

# AnomalyDetectorConfigTypeDef definition

class AnomalyDetectorConfigTypeDef(TypedDict):
    AnomalyDetectorFrequency: NotRequired[FrequencyType],  # (1)
  1. See FrequencyType

AnomalyDetectorSummaryTypeDef#

# AnomalyDetectorSummaryTypeDef definition

class AnomalyDetectorSummaryTypeDef(TypedDict):
    AnomalyDetectorArn: NotRequired[str],
    AnomalyDetectorName: NotRequired[str],
    AnomalyDetectorDescription: NotRequired[str],
    CreationTime: NotRequired[datetime],
    LastModificationTime: NotRequired[datetime],
    Status: NotRequired[AnomalyDetectorStatusType],  # (1)
    Tags: NotRequired[Dict[str, str]],
  1. See AnomalyDetectorStatusType

ItemizedMetricStatsTypeDef#

# ItemizedMetricStatsTypeDef definition

class ItemizedMetricStatsTypeDef(TypedDict):
    MetricName: NotRequired[str],
    OccurrenceCount: NotRequired[int],

AnomalyGroupSummaryTypeDef#

# AnomalyGroupSummaryTypeDef definition

class AnomalyGroupSummaryTypeDef(TypedDict):
    StartTime: NotRequired[str],
    EndTime: NotRequired[str],
    AnomalyGroupId: NotRequired[str],
    AnomalyGroupScore: NotRequired[float],
    PrimaryMetricName: NotRequired[str],

AnomalyGroupTimeSeriesFeedbackTypeDef#

# AnomalyGroupTimeSeriesFeedbackTypeDef definition

class AnomalyGroupTimeSeriesFeedbackTypeDef(TypedDict):
    AnomalyGroupId: str,
    TimeSeriesId: str,
    IsAnomaly: bool,

AnomalyGroupTimeSeriesTypeDef#

# AnomalyGroupTimeSeriesTypeDef definition

class AnomalyGroupTimeSeriesTypeDef(TypedDict):
    AnomalyGroupId: str,
    TimeSeriesId: NotRequired[str],

AppFlowConfigTypeDef#

# AppFlowConfigTypeDef definition

class AppFlowConfigTypeDef(TypedDict):
    RoleArn: NotRequired[str],
    FlowName: NotRequired[str],

BackTestConfigurationTypeDef#

# BackTestConfigurationTypeDef definition

class BackTestConfigurationTypeDef(TypedDict):
    RunBackTestMode: bool,

AttributeValueTypeDef#

# AttributeValueTypeDef definition

class AttributeValueTypeDef(TypedDict):
    S: NotRequired[str],
    N: NotRequired[str],
    B: NotRequired[str],
    SS: NotRequired[List[str]],
    NS: NotRequired[List[str]],
    BS: NotRequired[List[str]],

AutoDetectionS3SourceConfigTypeDef#

# AutoDetectionS3SourceConfigTypeDef definition

class AutoDetectionS3SourceConfigTypeDef(TypedDict):
    TemplatedPathList: NotRequired[Sequence[str]],
    HistoricalDataPathList: NotRequired[Sequence[str]],

BackTestAnomalyDetectorRequestRequestTypeDef#

# BackTestAnomalyDetectorRequestRequestTypeDef definition

class BackTestAnomalyDetectorRequestRequestTypeDef(TypedDict):
    AnomalyDetectorArn: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

MetricTypeDef#

# MetricTypeDef definition

class MetricTypeDef(TypedDict):
    MetricName: str,
    AggregationFunction: AggregationFunctionType,  # (1)
    Namespace: NotRequired[str],
  1. See AggregationFunctionType

TimestampColumnTypeDef#

# TimestampColumnTypeDef definition

class TimestampColumnTypeDef(TypedDict):
    ColumnName: NotRequired[str],
    ColumnFormat: NotRequired[str],

CsvFormatDescriptorOutputTypeDef#

# CsvFormatDescriptorOutputTypeDef definition

class CsvFormatDescriptorOutputTypeDef(TypedDict):
    FileCompression: NotRequired[CSVFileCompressionType],  # (1)
    Charset: NotRequired[str],
    ContainsHeader: NotRequired[bool],
    Delimiter: NotRequired[str],
    HeaderList: NotRequired[List[str]],
    QuoteSymbol: NotRequired[str],
  1. See CSVFileCompressionType

CsvFormatDescriptorTypeDef#

# CsvFormatDescriptorTypeDef definition

class CsvFormatDescriptorTypeDef(TypedDict):
    FileCompression: NotRequired[CSVFileCompressionType],  # (1)
    Charset: NotRequired[str],
    ContainsHeader: NotRequired[bool],
    Delimiter: NotRequired[str],
    HeaderList: NotRequired[Sequence[str]],
    QuoteSymbol: NotRequired[str],
  1. See CSVFileCompressionType

DataQualityMetricTypeDef#

# DataQualityMetricTypeDef definition

class DataQualityMetricTypeDef(TypedDict):
    MetricType: NotRequired[DataQualityMetricTypeType],  # (1)
    MetricDescription: NotRequired[str],
    RelatedColumnName: NotRequired[str],
    MetricValue: NotRequired[float],
  1. See DataQualityMetricTypeType

DeactivateAnomalyDetectorRequestRequestTypeDef#

# DeactivateAnomalyDetectorRequestRequestTypeDef definition

class DeactivateAnomalyDetectorRequestRequestTypeDef(TypedDict):
    AnomalyDetectorArn: str,

DeleteAlertRequestRequestTypeDef#

# DeleteAlertRequestRequestTypeDef definition

class DeleteAlertRequestRequestTypeDef(TypedDict):
    AlertArn: str,

DeleteAnomalyDetectorRequestRequestTypeDef#

# DeleteAnomalyDetectorRequestRequestTypeDef definition

class DeleteAnomalyDetectorRequestRequestTypeDef(TypedDict):
    AnomalyDetectorArn: str,

DescribeAlertRequestRequestTypeDef#

# DescribeAlertRequestRequestTypeDef definition

class DescribeAlertRequestRequestTypeDef(TypedDict):
    AlertArn: str,

DescribeAnomalyDetectionExecutionsRequestRequestTypeDef#

# DescribeAnomalyDetectionExecutionsRequestRequestTypeDef definition

class DescribeAnomalyDetectionExecutionsRequestRequestTypeDef(TypedDict):
    AnomalyDetectorArn: str,
    Timestamp: NotRequired[str],
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ExecutionStatusTypeDef#

# ExecutionStatusTypeDef definition

class ExecutionStatusTypeDef(TypedDict):
    Timestamp: NotRequired[str],
    Status: NotRequired[AnomalyDetectionTaskStatusType],  # (1)
    FailureReason: NotRequired[str],
  1. See AnomalyDetectionTaskStatusType

DescribeAnomalyDetectorRequestRequestTypeDef#

# DescribeAnomalyDetectorRequestRequestTypeDef definition

class DescribeAnomalyDetectorRequestRequestTypeDef(TypedDict):
    AnomalyDetectorArn: str,

DescribeMetricSetRequestRequestTypeDef#

# DescribeMetricSetRequestRequestTypeDef definition

class DescribeMetricSetRequestRequestTypeDef(TypedDict):
    MetricSetArn: str,

DimensionValueContributionTypeDef#

# DimensionValueContributionTypeDef definition

class DimensionValueContributionTypeDef(TypedDict):
    DimensionValue: NotRequired[str],
    ContributionScore: NotRequired[float],

DimensionNameValueTypeDef#

# DimensionNameValueTypeDef definition

class DimensionNameValueTypeDef(TypedDict):
    DimensionName: str,
    DimensionValue: str,

JsonFormatDescriptorTypeDef#

# JsonFormatDescriptorTypeDef definition

class JsonFormatDescriptorTypeDef(TypedDict):
    FileCompression: NotRequired[JsonFileCompressionType],  # (1)
    Charset: NotRequired[str],
  1. See JsonFileCompressionType

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    DimensionValue: NotRequired[str],
    FilterOperation: NotRequired[FilterOperationType],  # (1)
  1. See FilterOperationType

GetAnomalyGroupRequestRequestTypeDef#

# G