Type definitions#
Index > LookoutMetrics > Type definitions
Auto-generated documentation for LookoutMetrics type annotations stubs module mypy-boto3-lookoutmetrics.
LambdaConfigurationTypeDef#
# LambdaConfigurationTypeDef definition
class LambdaConfigurationTypeDef(TypedDict):
RoleArn: str,
LambdaArn: str,
SNSConfigurationTypeDef#
# SNSConfigurationTypeDef definition
class SNSConfigurationTypeDef(TypedDict):
RoleArn: str,
SnsTopicArn: str,
SnsFormat: NotRequired[SnsFormatType], # (1)
- See SnsFormatType
ActivateAnomalyDetectorRequestRequestTypeDef#
# ActivateAnomalyDetectorRequestRequestTypeDef definition
class ActivateAnomalyDetectorRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: 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]],
- See AlertTypeType
- See AlertStatusType
AnomalyDetectorConfigSummaryTypeDef#
# AnomalyDetectorConfigSummaryTypeDef definition
class AnomalyDetectorConfigSummaryTypeDef(TypedDict):
AnomalyDetectorFrequency: NotRequired[FrequencyType], # (1)
- See FrequencyType
AnomalyDetectorConfigTypeDef#
# AnomalyDetectorConfigTypeDef definition
class AnomalyDetectorConfigTypeDef(TypedDict):
AnomalyDetectorFrequency: NotRequired[FrequencyType], # (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]],
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,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
MetricTypeDef#
# MetricTypeDef definition
class MetricTypeDef(TypedDict):
MetricName: str,
AggregationFunction: AggregationFunctionType, # (1)
Namespace: NotRequired[str],
TimestampColumnTypeDef#
# TimestampColumnTypeDef definition
class TimestampColumnTypeDef(TypedDict):
ColumnName: NotRequired[str],
ColumnFormat: NotRequired[str],
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],
DataQualityMetricTypeDef#
# DataQualityMetricTypeDef definition
class DataQualityMetricTypeDef(TypedDict):
MetricType: NotRequired[DataQualityMetricTypeType], # (1)
MetricDescription: NotRequired[str],
RelatedColumnName: NotRequired[str],
MetricValue: NotRequired[float],
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],
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],
FilterTypeDef#
# FilterTypeDef definition
class FilterTypeDef(TypedDict):
DimensionValue: NotRequired[str],
FilterOperation: NotRequired[FilterOperationType], # (1)
GetAnomalyGroupRequestRequestTypeDef#
# GetAnomalyGroupRequestRequestTypeDef definition
class GetAnomalyGroupRequestRequestTypeDef(TypedDict):
AnomalyGroupId: str,
AnomalyDetectorArn: str,
GetDataQualityMetricsRequestRequestTypeDef#
# GetDataQualityMetricsRequestRequestTypeDef definition
class GetDataQualityMetricsRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: str,
MetricSetArn: NotRequired[str],
TimeSeriesFeedbackTypeDef#
# TimeSeriesFeedbackTypeDef definition
class TimeSeriesFeedbackTypeDef(TypedDict):
TimeSeriesId: NotRequired[str],
IsAnomaly: NotRequired[bool],
InterMetricImpactDetailsTypeDef#
# InterMetricImpactDetailsTypeDef definition
class InterMetricImpactDetailsTypeDef(TypedDict):
MetricName: NotRequired[str],
AnomalyGroupId: NotRequired[str],
RelationshipType: NotRequired[RelationshipTypeType], # (1)
ContributionPercentage: NotRequired[float],
ListAlertsRequestRequestTypeDef#
# ListAlertsRequestRequestTypeDef definition
class ListAlertsRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: NotRequired[str],
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListAnomalyDetectorsRequestRequestTypeDef#
# ListAnomalyDetectorsRequestRequestTypeDef definition
class ListAnomalyDetectorsRequestRequestTypeDef(TypedDict):
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListAnomalyGroupRelatedMetricsRequestRequestTypeDef#
# ListAnomalyGroupRelatedMetricsRequestRequestTypeDef definition
class ListAnomalyGroupRelatedMetricsRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: str,
AnomalyGroupId: str,
RelationshipTypeFilter: NotRequired[RelationshipTypeType], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListAnomalyGroupSummariesRequestRequestTypeDef#
# ListAnomalyGroupSummariesRequestRequestTypeDef definition
class ListAnomalyGroupSummariesRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: str,
SensitivityThreshold: int,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListAnomalyGroupTimeSeriesRequestRequestTypeDef#
# ListAnomalyGroupTimeSeriesRequestRequestTypeDef definition
class ListAnomalyGroupTimeSeriesRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: str,
AnomalyGroupId: str,
MetricName: str,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ListMetricSetsRequestRequestTypeDef#
# ListMetricSetsRequestRequestTypeDef definition
class ListMetricSetsRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: NotRequired[str],
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
MetricSetSummaryTypeDef#
# MetricSetSummaryTypeDef definition
class MetricSetSummaryTypeDef(TypedDict):
MetricSetArn: NotRequired[str],
AnomalyDetectorArn: NotRequired[str],
MetricSetDescription: NotRequired[str],
MetricSetName: NotRequired[str],
CreationTime: NotRequired[datetime],
LastModificationTime: NotRequired[datetime],
Tags: NotRequired[Dict[str, str]],
ListTagsForResourceRequestRequestTypeDef#
# ListTagsForResourceRequestRequestTypeDef definition
class ListTagsForResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
VpcConfigurationTypeDef#
# VpcConfigurationTypeDef definition
class VpcConfigurationTypeDef(TypedDict):
SubnetIdList: Sequence[str],
SecurityGroupIdList: Sequence[str],
TagResourceRequestRequestTypeDef#
# TagResourceRequestRequestTypeDef definition
class TagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
Tags: Mapping[str, str],
UntagResourceRequestRequestTypeDef#
# UntagResourceRequestRequestTypeDef definition
class UntagResourceRequestRequestTypeDef(TypedDict):
ResourceArn: str,
TagKeys: Sequence[str],
ActionTypeDef#
# ActionTypeDef definition
class ActionTypeDef(TypedDict):
SNSConfiguration: NotRequired[SNSConfigurationTypeDef], # (1)
LambdaConfiguration: NotRequired[LambdaConfigurationTypeDef], # (2)
AlertFiltersTypeDef#
# AlertFiltersTypeDef definition
class AlertFiltersTypeDef(TypedDict):
MetricList: NotRequired[Sequence[str]],
DimensionFilterList: NotRequired[Sequence[DimensionFilterTypeDef]], # (1)
CreateAnomalyDetectorRequestRequestTypeDef#
# CreateAnomalyDetectorRequestRequestTypeDef definition
class CreateAnomalyDetectorRequestRequestTypeDef(TypedDict):
AnomalyDetectorName: str,
AnomalyDetectorConfig: AnomalyDetectorConfigTypeDef, # (1)
AnomalyDetectorDescription: NotRequired[str],
KmsKeyArn: NotRequired[str],
Tags: NotRequired[Mapping[str, str]],
UpdateAnomalyDetectorRequestRequestTypeDef#
# UpdateAnomalyDetectorRequestRequestTypeDef definition
class UpdateAnomalyDetectorRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: str,
KmsKeyArn: NotRequired[str],
AnomalyDetectorDescription: NotRequired[str],
AnomalyDetectorConfig: NotRequired[AnomalyDetectorConfigTypeDef], # (1)
AnomalyGroupStatisticsTypeDef#
# AnomalyGroupStatisticsTypeDef definition
class AnomalyGroupStatisticsTypeDef(TypedDict):
EvaluationStartDate: NotRequired[str],
TotalCount: NotRequired[int],
ItemizedMetricStatsList: NotRequired[List[ItemizedMetricStatsTypeDef]], # (1)
PutFeedbackRequestRequestTypeDef#
# PutFeedbackRequestRequestTypeDef definition
class PutFeedbackRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: str,
AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesFeedbackTypeDef, # (1)
GetFeedbackRequestRequestTypeDef#
# GetFeedbackRequestRequestTypeDef definition
class GetFeedbackRequestRequestTypeDef(TypedDict):
AnomalyDetectorArn: str,
AnomalyGroupTimeSeriesFeedback: AnomalyGroupTimeSeriesTypeDef, # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
AthenaSourceConfigTypeDef#
# AthenaSourceConfigTypeDef definition
class AthenaSourceConfigTypeDef(TypedDict):
RoleArn: NotRequired[str],
DatabaseName: NotRequired[str],
DataCatalog: NotRequired[str],
TableName: NotRequired[str],
WorkGroupName: NotRequired[str],
S3ResultsPath: NotRequired[str],
BackTestConfiguration: NotRequired[BackTestConfigurationTypeDef], # (1)
CloudWatchConfigTypeDef#
# CloudWatchConfigTypeDef definition
class CloudWatchConfigTypeDef(TypedDict):
RoleArn: NotRequired[str],
BackTestConfiguration: NotRequired[BackTestConfigurationTypeDef], # (1)
DetectedFieldTypeDef#
# DetectedFieldTypeDef definition
class DetectedFieldTypeDef(TypedDict):
Value: NotRequired[AttributeValueTypeDef], # (1)
Confidence: NotRequired[ConfidenceType], # (2)
Message: NotRequired[str],
- See AttributeValueTypeDef
- See ConfidenceType
AutoDetectionMetricSourceTypeDef#
# AutoDetectionMetricSourceTypeDef definition
class AutoDetectionMetricSourceTypeDef(TypedDict):
S3SourceConfig: NotRequired[AutoDetectionS3SourceConfigTypeDef], # (1)
CreateAlertResponseTypeDef#
# CreateAlertResponseTypeDef definition
class CreateAlertResponseTypeDef(TypedDict):
AlertArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateAnomalyDetectorResponseTypeDef#
# CreateAnomalyDetectorResponseTypeDef definition
class CreateAnomalyDetectorResponseTypeDef(TypedDict):
AnomalyDetectorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateMetricSetResponseTypeDef#
# CreateMetricSetResponseTypeDef definition
class CreateMetricSetResponseTypeDef(TypedDict):
MetricSetArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeAnomalyDetectorResponseTypeDef#
# DescribeAnomalyDetectorResponseTypeDef definition
class DescribeAnomalyDetectorResponseTypeDef(TypedDict):
AnomalyDetectorArn: str,
AnomalyDetectorName: str,
AnomalyDetectorDescription: str,
AnomalyDetectorConfig: AnomalyDetectorConfigSummaryTypeDef, # (1)
CreationTime: datetime,
LastModificationTime: datetime,
Status: AnomalyDetectorStatusType, # (2)
FailureReason: str,
KmsKeyArn: str,
FailureType: AnomalyDetectorFailureTypeType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See AnomalyDetectorConfigSummaryTypeDef
- See AnomalyDetectorStatusType
- See AnomalyDetectorFailureTypeType
- See ResponseMetadataTypeDef
GetSampleDataResponseTypeDef#
# GetSampleDataResponseTypeDef definition
class GetSampleDataResponseTypeDef(TypedDict):
HeaderValues: List[str],
SampleRows: List[List[str]],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListAlertsResponseTypeDef#
# ListAlertsResponseTypeDef definition
class ListAlertsResponseTypeDef(TypedDict):
AlertSummaryList: List[AlertSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListAnomalyDetectorsResponseTypeDef#
# ListAnomalyDetectorsResponseTypeDef definition
class ListAnomalyDetectorsResponseTypeDef(TypedDict):
AnomalyDetectorSummaryList: List[AnomalyDetectorSummaryTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListTagsForResourceResponseTypeDef#
# ListTagsForResourceResponseTypeDef definition
class ListTagsForResourceResponseTypeDef(TypedDict):
Tags: Dict[str, str],
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAlertResponseTypeDef#
# UpdateAlertResponseTypeDef definition
class UpdateAlertResponseTypeDef(TypedDict):
AlertArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateAnomalyDetectorResponseTypeDef#
# UpdateAnomalyDetectorResponseTypeDef definition
class UpdateAnomalyDetectorResponseTypeDef(TypedDict):
AnomalyDetectorArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateMetricSetResponseTypeDef#
# UpdateMetricSetResponseTypeDef definition
class UpdateMetricSetResponseTypeDef(TypedDict):
MetricSetArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MetricSetDataQualityMetricTypeDef#
# MetricSetDataQualityMetricTypeDef definition
class MetricSetDataQualityMetricTypeDef(TypedDict):
MetricSetArn: NotRequired[str],
DataQualityMetricList: NotRequired[List[DataQualityMetricTypeDef]], # (1)