Skip to content

Type definitions#

Index > CloudWatch > Type definitions

Auto-generated documentation for CloudWatch type annotations stubs module mypy-boto3-cloudwatch.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

AlarmHistoryItemTypeDef#

# AlarmHistoryItemTypeDef definition

class AlarmHistoryItemTypeDef(TypedDict):
    AlarmName: NotRequired[str],
    AlarmType: NotRequired[AlarmTypeType],  # (1)
    Timestamp: NotRequired[datetime],
    HistoryItemType: NotRequired[HistoryItemTypeType],  # (2)
    HistorySummary: NotRequired[str],
    HistoryData: NotRequired[str],
  1. See AlarmTypeType
  2. See HistoryItemTypeType

RangeTypeDef#

# RangeTypeDef definition

class RangeTypeDef(TypedDict):
    StartTime: datetime,
    EndTime: datetime,

DimensionTypeDef#

# DimensionTypeDef definition

class DimensionTypeDef(TypedDict):
    Name: str,
    Value: str,

CloudwatchEventStateTypeDef#

# CloudwatchEventStateTypeDef definition

class CloudwatchEventStateTypeDef(TypedDict):
    timestamp: str,
    value: str,
    reason: NotRequired[str],
    reasonData: NotRequired[str],
    actionsSuppressedBy: NotRequired[str],
    actionsSuppressedReason: NotRequired[str],

CloudwatchEventMetricStatsMetricTypeDef#

# CloudwatchEventMetricStatsMetricTypeDef definition

class CloudwatchEventMetricStatsMetricTypeDef(TypedDict):
    metricName: str,
    namespace: str,
    dimensions: Dict[str, str],

CompositeAlarmTypeDef#

# CompositeAlarmTypeDef definition

class CompositeAlarmTypeDef(TypedDict):
    ActionsEnabled: NotRequired[bool],
    AlarmActions: NotRequired[List[str]],
    AlarmArn: NotRequired[str],
    AlarmConfigurationUpdatedTimestamp: NotRequired[datetime],
    AlarmDescription: NotRequired[str],
    AlarmName: NotRequired[str],
    AlarmRule: NotRequired[str],
    InsufficientDataActions: NotRequired[List[str]],
    OKActions: NotRequired[List[str]],
    StateReason: NotRequired[str],
    StateReasonData: NotRequired[str],
    StateUpdatedTimestamp: NotRequired[datetime],
    StateValue: NotRequired[StateValueType],  # (1)
    StateTransitionedTimestamp: NotRequired[datetime],
    ActionsSuppressedBy: NotRequired[ActionsSuppressedByType],  # (2)
    ActionsSuppressedReason: NotRequired[str],
    ActionsSuppressor: NotRequired[str],
    ActionsSuppressorWaitPeriod: NotRequired[int],
    ActionsSuppressorExtensionPeriod: NotRequired[int],
  1. See StateValueType
  2. See ActionsSuppressedByType

DashboardEntryTypeDef#

# DashboardEntryTypeDef definition

class DashboardEntryTypeDef(TypedDict):
    DashboardName: NotRequired[str],
    DashboardArn: NotRequired[str],
    LastModified: NotRequired[datetime],
    Size: NotRequired[int],

DashboardValidationMessageTypeDef#

# DashboardValidationMessageTypeDef definition

class DashboardValidationMessageTypeDef(TypedDict):
    DataPath: NotRequired[str],
    Message: NotRequired[str],

DatapointTypeDef#

# DatapointTypeDef definition

class DatapointTypeDef(TypedDict):
    Timestamp: NotRequired[datetime],
    SampleCount: NotRequired[float],
    Average: NotRequired[float],
    Sum: NotRequired[float],
    Minimum: NotRequired[float],
    Maximum: NotRequired[float],
    Unit: NotRequired[StandardUnitType],  # (1)
    ExtendedStatistics: NotRequired[Dict[str, float]],
  1. See StandardUnitType

DeleteAlarmsInputRequestTypeDef#

# DeleteAlarmsInputRequestTypeDef definition

class DeleteAlarmsInputRequestTypeDef(TypedDict):
    AlarmNames: Sequence[str],

DeleteDashboardsInputRequestTypeDef#

# DeleteDashboardsInputRequestTypeDef definition

class DeleteDashboardsInputRequestTypeDef(TypedDict):
    DashboardNames: Sequence[str],

DeleteInsightRulesInputRequestTypeDef#

# DeleteInsightRulesInputRequestTypeDef definition

class DeleteInsightRulesInputRequestTypeDef(TypedDict):
    RuleNames: Sequence[str],

PartialFailureTypeDef#

# PartialFailureTypeDef definition

class PartialFailureTypeDef(TypedDict):
    FailureResource: NotRequired[str],
    ExceptionType: NotRequired[str],
    FailureCode: NotRequired[str],
    FailureDescription: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DeleteMetricStreamInputRequestTypeDef#

# DeleteMetricStreamInputRequestTypeDef definition

class DeleteMetricStreamInputRequestTypeDef(TypedDict):
    Name: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

class WaiterConfigTypeDef(TypedDict):
    Delay: NotRequired[int],
    MaxAttempts: NotRequired[int],

DescribeAlarmsInputRequestTypeDef#

# DescribeAlarmsInputRequestTypeDef definition

class DescribeAlarmsInputRequestTypeDef(TypedDict):
    AlarmNames: NotRequired[Sequence[str]],
    AlarmNamePrefix: NotRequired[str],
    AlarmTypes: NotRequired[Sequence[AlarmTypeType]],  # (1)
    ChildrenOfAlarmName: NotRequired[str],
    ParentsOfAlarmName: NotRequired[str],
    StateValue: NotRequired[StateValueType],  # (2)
    ActionPrefix: NotRequired[str],
    MaxRecords: NotRequired[int],
    NextToken: NotRequired[str],
  1. See AlarmTypeType
  2. See StateValueType

DescribeInsightRulesInputRequestTypeDef#

# DescribeInsightRulesInputRequestTypeDef definition

class DescribeInsightRulesInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

InsightRuleTypeDef#

# InsightRuleTypeDef definition

class InsightRuleTypeDef(TypedDict):
    Name: str,
    State: str,
    Schema: str,
    Definition: str,
    ManagedRule: NotRequired[bool],

DimensionFilterTypeDef#

# DimensionFilterTypeDef definition

class DimensionFilterTypeDef(TypedDict):
    Name: str,
    Value: NotRequired[str],

DisableAlarmActionsInputRequestTypeDef#

# DisableAlarmActionsInputRequestTypeDef definition

class DisableAlarmActionsInputRequestTypeDef(TypedDict):
    AlarmNames: Sequence[str],

DisableInsightRulesInputRequestTypeDef#

# DisableInsightRulesInputRequestTypeDef definition

class DisableInsightRulesInputRequestTypeDef(TypedDict):
    RuleNames: Sequence[str],

EnableAlarmActionsInputRequestTypeDef#

# EnableAlarmActionsInputRequestTypeDef definition

class EnableAlarmActionsInputRequestTypeDef(TypedDict):
    AlarmNames: Sequence[str],

EnableInsightRulesInputRequestTypeDef#

# EnableInsightRulesInputRequestTypeDef definition

class EnableInsightRulesInputRequestTypeDef(TypedDict):
    RuleNames: Sequence[str],

GetDashboardInputRequestTypeDef#

# GetDashboardInputRequestTypeDef definition

class GetDashboardInputRequestTypeDef(TypedDict):
    DashboardName: str,

InsightRuleMetricDatapointTypeDef#

# InsightRuleMetricDatapointTypeDef definition

class InsightRuleMetricDatapointTypeDef(TypedDict):
    Timestamp: datetime,
    UniqueContributors: NotRequired[float],
    MaxContributorValue: NotRequired[float],
    SampleCount: NotRequired[float],
    Average: NotRequired[float],
    Sum: NotRequired[float],
    Minimum: NotRequired[float],
    Maximum: NotRequired[float],

LabelOptionsTypeDef#

# LabelOptionsTypeDef definition

class LabelOptionsTypeDef(TypedDict):
    Timezone: NotRequired[str],

MessageDataTypeDef#

# MessageDataTypeDef definition

class MessageDataTypeDef(TypedDict):
    Code: NotRequired[str],
    Value: NotRequired[str],

GetMetricStreamInputRequestTypeDef#

# GetMetricStreamInputRequestTypeDef definition

class GetMetricStreamInputRequestTypeDef(TypedDict):
    Name: str,

MetricStreamFilterTypeDef#

# MetricStreamFilterTypeDef definition

class MetricStreamFilterTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricNames: NotRequired[List[str]],

GetMetricWidgetImageInputRequestTypeDef#

# GetMetricWidgetImageInputRequestTypeDef definition

class GetMetricWidgetImageInputRequestTypeDef(TypedDict):
    MetricWidget: str,
    OutputFormat: NotRequired[str],

InsightRuleContributorDatapointTypeDef#

# InsightRuleContributorDatapointTypeDef definition

class InsightRuleContributorDatapointTypeDef(TypedDict):
    Timestamp: datetime,
    ApproximateValue: float,

ListDashboardsInputRequestTypeDef#

# ListDashboardsInputRequestTypeDef definition

class ListDashboardsInputRequestTypeDef(TypedDict):
    DashboardNamePrefix: NotRequired[str],
    NextToken: NotRequired[str],

ListManagedInsightRulesInputRequestTypeDef#

# ListManagedInsightRulesInputRequestTypeDef definition

class ListManagedInsightRulesInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

ListMetricStreamsInputRequestTypeDef#

# ListMetricStreamsInputRequestTypeDef definition

class ListMetricStreamsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],

MetricStreamEntryTypeDef#

# MetricStreamEntryTypeDef definition

class MetricStreamEntryTypeDef(TypedDict):
    Arn: NotRequired[str],
    CreationDate: NotRequired[datetime],
    LastUpdateDate: NotRequired[datetime],
    Name: NotRequired[str],
    FirehoseArn: NotRequired[str],
    State: NotRequired[str],
    OutputFormat: NotRequired[MetricStreamOutputFormatType],  # (1)
  1. See MetricStreamOutputFormatType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    Key: str,
    Value: str,

ManagedRuleStateTypeDef#

# ManagedRuleStateTypeDef definition

class ManagedRuleStateTypeDef(TypedDict):
    RuleName: str,
    State: str,

StatisticSetTypeDef#

# StatisticSetTypeDef definition

class StatisticSetTypeDef(TypedDict):
    SampleCount: float,
    Sum: float,
    Minimum: float,
    Maximum: float,

MetricStreamStatisticsMetricTypeDef#

# MetricStreamStatisticsMetricTypeDef definition

class MetricStreamStatisticsMetricTypeDef(TypedDict):
    Namespace: str,
    MetricName: str,

PutDashboardInputRequestTypeDef#

# PutDashboardInputRequestTypeDef definition

class PutDashboardInputRequestTypeDef(TypedDict):
    DashboardName: str,
    DashboardBody: str,

SetAlarmStateInputAlarmSetStateTypeDef#

# SetAlarmStateInputAlarmSetStateTypeDef definition

class SetAlarmStateInputAlarmSetStateTypeDef(TypedDict):
    StateValue: StateValueType,  # (1)
    StateReason: str,
    StateReasonData: NotRequired[str],
  1. See StateValueType

SetAlarmStateInputRequestTypeDef#

# SetAlarmStateInputRequestTypeDef definition

class SetAlarmStateInputRequestTypeDef(TypedDict):
    AlarmName: str,
    StateValue: StateValueType,  # (1)
    StateReason: str,
    StateReasonData: NotRequired[str],
  1. See StateValueType

StartMetricStreamsInputRequestTypeDef#

# StartMetricStreamsInputRequestTypeDef definition

class StartMetricStreamsInputRequestTypeDef(TypedDict):
    Names: Sequence[str],

StopMetricStreamsInputRequestTypeDef#

# StopMetricStreamsInputRequestTypeDef definition

class StopMetricStreamsInputRequestTypeDef(TypedDict):
    Names: Sequence[str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    TagKeys: Sequence[str],

AnomalyDetectorConfigurationTypeDef#

# AnomalyDetectorConfigurationTypeDef definition

class AnomalyDetectorConfigurationTypeDef(TypedDict):
    ExcludedTimeRanges: NotRequired[List[RangeTypeDef]],  # (1)
    MetricTimezone: NotRequired[str],
  1. See RangeTypeDef

DescribeAlarmsForMetricInputRequestTypeDef#

# DescribeAlarmsForMetricInputRequestTypeDef definition

class DescribeAlarmsForMetricInputRequestTypeDef(TypedDict):
    MetricName: str,
    Namespace: str,
    Statistic: NotRequired[StatisticType],  # (1)
    ExtendedStatistic: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (2)
    Period: NotRequired[int],
    Unit: NotRequired[StandardUnitType],  # (3)
  1. See StatisticType
  2. See DimensionTypeDef
  3. See StandardUnitType

DescribeAnomalyDetectorsInputRequestTypeDef#

# DescribeAnomalyDetectorsInputRequestTypeDef definition

class DescribeAnomalyDetectorsInputRequestTypeDef(TypedDict):
    NextToken: NotRequired[str],
    MaxResults: NotRequired[int],
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    AnomalyDetectorTypes: NotRequired[Sequence[AnomalyDetectorTypeType]],  # (2)
  1. See DimensionTypeDef
  2. See AnomalyDetectorTypeType

MetricPaginatorTypeDef#

# MetricPaginatorTypeDef definition

class MetricPaginatorTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[List[DimensionTypeDef]],  # (1)
  1. See DimensionTypeDef

MetricTypeDef#

# MetricTypeDef definition

class MetricTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
  1. See DimensionTypeDef

SingleMetricAnomalyDetectorPaginatorTypeDef#

# SingleMetricAnomalyDetectorPaginatorTypeDef definition

class SingleMetricAnomalyDetectorPaginatorTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[List[DimensionTypeDef]],  # (1)
    Stat: NotRequired[str],
  1. See DimensionTypeDef

SingleMetricAnomalyDetectorTypeDef#

# SingleMetricAnomalyDetectorTypeDef definition

class SingleMetricAnomalyDetectorTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    Stat: NotRequired[str],
  1. See DimensionTypeDef

CloudwatchEventMetricStatsTypeDef#

# CloudwatchEventMetricStatsTypeDef definition

class CloudwatchEventMetricStatsTypeDef(TypedDict):
    period: str,
    stat: str,
    metric: NotRequired[CloudwatchEventMetricStatsMetricTypeDef],  # (1)
  1. See CloudwatchEventMetricStatsMetricTypeDef

DeleteInsightRulesOutputTypeDef#

# DeleteInsightRulesOutputTypeDef definition

class DeleteInsightRulesOutputTypeDef(TypedDict):
    Failures: List[PartialFailureTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PartialFailureTypeDef
  2. See ResponseMetadataTypeDef

DescribeAlarmHistoryOutputTypeDef#

# DescribeAlarmHistoryOutputTypeDef definition

class DescribeAlarmHistoryOutputTypeDef(TypedDict):
    AlarmHistoryItems: List[AlarmHistoryItemTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlarmHistoryItemTypeDef
  2. See ResponseMetadataTypeDef

DisableInsightRulesOutputTypeDef#

# DisableInsightRulesOutputTypeDef definition

class DisableInsightRulesOutputTypeDef(TypedDict):
    Failures: List[PartialFailureTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PartialFailureTypeDef
  2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EnableInsightRulesOutputTypeDef#

# EnableInsightRulesOutputTypeDef definition

class EnableInsightRulesOutputTypeDef(TypedDict):
    Failures: List[PartialFailureTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PartialFailureTypeDef
  2. See ResponseMetadataTypeDef

GetDashboardOutputTypeDef#

# GetDashboardOutputTypeDef definition

class GetDashboardOutputTypeDef(TypedDict):
    DashboardArn: str,
    DashboardBody: str,
    DashboardName: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetMetricStatisticsOutputTypeDef#

# GetMetricStatisticsOutputTypeDef definition

class GetMetricStatisticsOutputTypeDef(TypedDict):
    Label: str,
    Datapoints: List[DatapointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatapointTypeDef
  2. See ResponseMetadataTypeDef

GetMetricWidgetImageOutputTypeDef#

# GetMetricWidgetImageOutputTypeDef definition

class GetMetricWidgetImageOutputTypeDef(TypedDict):
    MetricWidgetImage: bytes,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListDashboardsOutputTypeDef#

# ListDashboardsOutputTypeDef definition

class ListDashboardsOutputTypeDef(TypedDict):
    DashboardEntries: List[DashboardEntryTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DashboardEntryTypeDef
  2. See ResponseMetadataTypeDef

PutDashboardOutputTypeDef#

# PutDashboardOutputTypeDef definition

class PutDashboardOutputTypeDef(TypedDict):
    DashboardValidationMessages: List[DashboardValidationMessageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DashboardValidationMessageTypeDef
  2. See ResponseMetadataTypeDef

PutManagedInsightRulesOutputTypeDef#

# PutManagedInsightRulesOutputTypeDef definition

class PutManagedInsightRulesOutputTypeDef(TypedDict):
    Failures: List[PartialFailureTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See PartialFailureTypeDef
  2. See ResponseMetadataTypeDef

PutMetricStreamOutputTypeDef#

# PutMetricStreamOutputTypeDef definition

class PutMetricStreamOutputTypeDef(TypedDict):
    Arn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef#

# DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef definition

class DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef(TypedDict):
    AlarmTypes: NotRequired[Sequence[AlarmTypeType]],  # (1)
    HistoryItemType: NotRequired[HistoryItemTypeType],  # (2)
    StartDate: NotRequired[Union[datetime, str]],
    EndDate: NotRequired[Union[datetime, str]],
    MaxRecords: NotRequired[int],
    NextToken: NotRequired[str],
    ScanBy: NotRequired[ScanByType],  # (3)
  1. See AlarmTypeType
  2. See HistoryItemTypeType
  3. See ScanByType

DescribeAlarmHistoryInputRequestTypeDef#

# DescribeAlarmHistoryInputRequestTypeDef definition

class DescribeAlarmHistoryInputRequestTypeDef(TypedDict):
    AlarmName: NotRequired[str],
    AlarmTypes: NotRequired[Sequence[AlarmTypeType]],  # (1)
    HistoryItemType: NotRequired[HistoryItemTypeType],  # (2)
    StartDate: NotRequired[Union[datetime, str]],
    EndDate: NotRequired[Union[datetime, str]],
    MaxRecords: NotRequired[int],
    NextToken: NotRequired[str],
    ScanBy: NotRequired[ScanByType],  # (3)
  1. See AlarmTypeType
  2. See HistoryItemTypeType
  3. See ScanByType

GetInsightRuleReportInputRequestTypeDef#

# GetInsightRuleReportInputRequestTypeDef definition

class GetInsightRuleReportInputRequestTypeDef(TypedDict):
    RuleName: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    Period: int,
    MaxContributorCount: NotRequired[int],
    Metrics: NotRequired[Sequence[str]],
    OrderBy: NotRequired[str],

GetMetricStatisticsInputMetricGetStatisticsTypeDef#

# GetMetricStatisticsInputMetricGetStatisticsTypeDef definition

class GetMetricStatisticsInputMetricGetStatisticsTypeDef(TypedDict):
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    Period: int,
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    Statistics: NotRequired[Sequence[StatisticType]],  # (2)
    ExtendedStatistics: NotRequired[Sequence[str]],
    Unit: NotRequired[StandardUnitType],  # (3)
  1. See DimensionTypeDef
  2. See StatisticType
  3. See StandardUnitType

GetMetricStatisticsInputRequestTypeDef#

# GetMetricStatisticsInputRequestTypeDef definition

class GetMetricStatisticsInputRequestTypeDef(TypedDict):
    Namespace: str,
    MetricName: str,
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    Period: int,
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    Statistics: NotRequired[Sequence[StatisticType]],  # (2)
    ExtendedStatistics: NotRequired[Sequence[str]],
    Unit: NotRequired[StandardUnitType],  # (3)
  1. See DimensionTypeDef
  2. See StatisticType
  3. See StandardUnitType

DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef#

# DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef definition

class DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef(TypedDict):
    AlarmName: NotRequired[str],
    AlarmTypes: NotRequired[Sequence[AlarmTypeType]],  # (1)
    HistoryItemType: NotRequired[HistoryItemTypeType],  # (2)
    StartDate: NotRequired[Union[datetime, str]],
    EndDate: NotRequired[Union[datetime, str]],
    ScanBy: NotRequired[ScanByType],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See AlarmTypeType
  2. See HistoryItemTypeType
  3. See ScanByType
  4. See PaginatorConfigTypeDef

DescribeAlarmsInputDescribeAlarmsPaginateTypeDef#

# DescribeAlarmsInputDescribeAlarmsPaginateTypeDef definition

class DescribeAlarmsInputDescribeAlarmsPaginateTypeDef(TypedDict):
    AlarmNames: NotRequired[Sequence[str]],
    AlarmNamePrefix: NotRequired[str],
    AlarmTypes: NotRequired[Sequence[AlarmTypeType]],  # (1)
    ChildrenOfAlarmName: NotRequired[str],
    ParentsOfAlarmName: NotRequired[str],
    StateValue: NotRequired[StateValueType],  # (2)
    ActionPrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See AlarmTypeType
  2. See StateValueType
  3. See PaginatorConfigTypeDef

DescribeAnomalyDetectorsInputDescribeAnomalyDetectorsPaginateTypeDef#

# DescribeAnomalyDetectorsInputDescribeAnomalyDetectorsPaginateTypeDef definition

class DescribeAnomalyDetectorsInputDescribeAnomalyDetectorsPaginateTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    AnomalyDetectorTypes: NotRequired[Sequence[AnomalyDetectorTypeType]],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See DimensionTypeDef
  2. See AnomalyDetectorTypeType
  3. See PaginatorConfigTypeDef

ListDashboardsInputListDashboardsPaginateTypeDef#

# ListDashboardsInputListDashboardsPaginateTypeDef definition

class ListDashboardsInputListDashboardsPaginateTypeDef(TypedDict):
    DashboardNamePrefix: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeAlarmsInputAlarmExistsWaitTypeDef#

# DescribeAlarmsInputAlarmExistsWaitTypeDef definition

class DescribeAlarmsInputAlarmExistsWaitTypeDef(TypedDict):
    AlarmNames: NotRequired[Sequence[str]],
    AlarmNamePrefix: NotRequired[str],
    AlarmTypes: NotRequired[Sequence[AlarmTypeType]],  # (1)
    ChildrenOfAlarmName: NotRequired[str],
    ParentsOfAlarmName: NotRequired[str],
    StateValue: NotRequired[StateValueType],  # (2)
    ActionPrefix: NotRequired[str],
    MaxRecords: NotRequired[int],
    NextToken: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (3)
  1. See AlarmTypeType
  2. See StateValueType
  3. See WaiterConfigTypeDef

DescribeAlarmsInputCompositeAlarmExistsWaitTypeDef#

# DescribeAlarmsInputCompositeAlarmExistsWaitTypeDef definition

class DescribeAlarmsInputCompositeAlarmExistsWaitTypeDef(TypedDict):
    AlarmNames: NotRequired[Sequence[str]],
    AlarmNamePrefix: NotRequired[str],
    AlarmTypes: NotRequired[Sequence[AlarmTypeType]],  # (1)
    ChildrenOfAlarmName: NotRequired[str],
    ParentsOfAlarmName: NotRequired[str],
    StateValue: NotRequired[StateValueType],  # (2)
    ActionPrefix: NotRequired[str],
    MaxRecords: NotRequired[int],
    NextToken: NotRequired[str],
    WaiterConfig: NotRequired[WaiterConfigTypeDef],  # (3)
  1. See AlarmTypeType
  2. See StateValueType
  3. See WaiterConfigTypeDef

DescribeInsightRulesOutputTypeDef#

# DescribeInsightRulesOutputTypeDef definition

class DescribeInsightRulesOutputTypeDef(TypedDict):
    NextToken: str,
    InsightRules: List[InsightRuleTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See InsightRuleTypeDef
  2. See ResponseMetadataTypeDef

ListMetricsInputListMetricsPaginateTypeDef#

# ListMetricsInputListMetricsPaginateTypeDef definition

class ListMetricsInputListMetricsPaginateTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionFilterTypeDef]],  # (1)
    RecentlyActive: NotRequired[RecentlyActiveType],  # (2)
    IncludeLinkedAccounts: NotRequired[bool],
    OwningAccount: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See DimensionFilterTypeDef
  2. See RecentlyActiveType
  3. See PaginatorConfigTypeDef

ListMetricsInputRequestTypeDef#

# ListMetricsInputRequestTypeDef definition

class ListMetricsInputRequestTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionFilterTypeDef]],  # (1)
    NextToken: NotRequired[str],
    RecentlyActive: NotRequired[RecentlyActiveType],  # (2)
    IncludeLinkedAccounts: NotRequired[bool],
    OwningAccount: NotRequired[str],
  1. See DimensionFilterTypeDef
  2. See RecentlyActiveType

MetricDataResultTypeDef#

# MetricDataResultTypeDef definition

class MetricDataResultTypeDef(TypedDict):
    Id: NotRequired[str],
    Label: NotRequired[str],
    Timestamps: NotRequired[List[datetime]],
    Values: NotRequired[List[float]],
    StatusCode: NotRequired[StatusCodeType],  # (1)
    Messages: NotRequired[List[MessageDataTypeDef]],  # (2)
  1. See StatusCodeType
  2. See MessageDataTypeDef

InsightRuleContributorTypeDef#

# InsightRuleContributorTypeDef definition

class InsightRuleContributorTypeDef(TypedDict):
    Keys: List[str],
    ApproximateAggregateValue: float,
    Datapoints: List[InsightRuleContributorDatapointTypeDef],  # (1)
  1. See InsightRuleContributorDatapointTypeDef

ListMetricStreamsOutputTypeDef#

# ListMetricStreamsOutputTypeDef definition

class ListMetricStreamsOutputTypeDef(TypedDict):
    NextToken: str,
    Entries: List[MetricStreamEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricStreamEntryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    Tags: List[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

ManagedRuleTypeDef#

# ManagedRuleTypeDef definition

class ManagedRuleTypeDef(TypedDict):
    TemplateName: str,
    ResourceARN: str,
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

PutCompositeAlarmInputRequestTypeDef#

# PutCompositeAlarmInputRequestTypeDef definition

class PutCompositeAlarmInputRequestTypeDef(TypedDict):
    AlarmName: str,
    AlarmRule: str,
    ActionsEnabled: NotRequired[bool],
    AlarmActions: NotRequired[Sequence[str]],
    AlarmDescription: NotRequired[str],
    InsufficientDataActions: NotRequired[Sequence[str]],
    OKActions: NotRequired[Sequence[str]],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
    ActionsSuppressor: NotRequired[str],
    ActionsSuppressorWaitPeriod: NotRequired[int],
    ActionsSuppressorExtensionPeriod: NotRequired[int],
  1. See TagTypeDef

PutInsightRuleInputRequestTypeDef#

# PutInsightRuleInputRequestTypeDef definition

class PutInsightRuleInputRequestTypeDef(TypedDict):
    RuleName: str,
    RuleDefinition: str,
    RuleState: NotRequired[str],
    Tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,
    Tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

ManagedRuleDescriptionTypeDef#

# ManagedRuleDescriptionTypeDef definition

class ManagedRuleDescriptionTypeDef(TypedDict):
    TemplateName: NotRequired[str],
    ResourceARN: NotRequired[str],
    RuleState: NotRequired[ManagedRuleStateTypeDef],  # (1)
  1. See ManagedRuleStateTypeDef

MetricDatumTypeDef#

# MetricDatumTypeDef definition

class MetricDatumTypeDef(TypedDict):
    MetricName: str,
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    Timestamp: NotRequired[Union[datetime, str]],
    Value: NotRequired[float],
    StatisticValues: NotRequired[StatisticSetTypeDef],  # (2)
    Values: NotRequired[Sequence[float]],
    Counts: NotRequired[Sequence[float]],
    Unit: NotRequired[StandardUnitType],  # (3)
    StorageResolution: NotRequired[int],
  1. See DimensionTypeDef
  2. See StatisticSetTypeDef
  3. See StandardUnitType

MetricStreamStatisticsConfigurationTypeDef#

# MetricStreamStatisticsConfigurationTypeDef definition

class MetricStreamStatisticsConfigurationTypeDef(TypedDict):
    IncludeMetrics: List[MetricStreamStatisticsMetricTypeDef],  # (1)
    AdditionalStatistics: List[str],
  1. See MetricStreamStatisticsMetricTypeDef

ListMetricsOutputPaginatorTypeDef#

# ListMetricsOutputPaginatorTypeDef definition

class ListMetricsOutputPaginatorTypeDef(TypedDict):
    Metrics: List[MetricPaginatorTypeDef],  # (1)
    NextToken: str,
    OwningAccounts: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricPaginatorTypeDef
  2. See ResponseMetadataTypeDef

MetricStatPaginatorTypeDef#

# MetricStatPaginatorTypeDef definition

class MetricStatPaginatorTypeDef(TypedDict):
    Metric: MetricPaginatorTypeDef,  # (1)
    Period: int,
    Stat: str,
    Unit: NotRequired[StandardUnitType],  # (2)
  1. See MetricPaginatorTypeDef
  2. See StandardUnitType

ListMetricsOutputTypeDef#

# ListMetricsOutputTypeDef definition

class ListMetricsOutputTypeDef(TypedDict):
    Metrics: List[MetricTypeDef],  # (1)
    NextToken: str,
    OwningAccounts: List[str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricTypeDef
  2. See ResponseMetadataTypeDef

MetricStatTypeDef#

# MetricStatTypeDef definition

class MetricStatTypeDef(TypedDict):
    Metric: MetricTypeDef,  # (1)
    Period: int,
    Stat: str,
    Unit: NotRequired[StandardUnitType],  # (2)
  1. See MetricTypeDef
  2. See StandardUnitType

CloudwatchEventMetricTypeDef#

# CloudwatchEventMetricTypeDef definition

class CloudwatchEventMetricTypeDef(TypedDict):
    id: str,
    returnData: bool,
    metricStat: NotRequired[CloudwatchEventMetricStatsTypeDef],  # (1)
    expression: NotRequired[str],
    label: NotRequired[str],
    period: NotRequired[int],
  1. See CloudwatchEventMetricStatsTypeDef

GetMetricDataOutputTypeDef#

# GetMetricDataOutputTypeDef definition

class GetMetricDataOutputTypeDef(TypedDict):
    MetricDataResults: List[MetricDataResultTypeDef],  # (1)
    NextToken: str,
    Messages: List[MessageDataTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See MetricDataResultTypeDef
  2. See MessageDataTypeDef
  3. See ResponseMetadataTypeDef

GetInsightRuleReportOutputTypeDef#

# GetInsightRuleReportOutputTypeDef definition

class GetInsightRuleReportOutputTypeDef(TypedDict):
    KeyLabels: List[str],
    AggregationStatistic: str,
    AggregateValue: float,
    ApproximateUniqueCount: int,
    Contributors: List[InsightRuleContributorTypeDef],  # (1)
    MetricDatapoints: List[InsightRuleMetricDatapointTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See InsightRuleContributorTypeDef
  2. See InsightRuleMetricDatapointTypeDef
  3. See ResponseMetadataTypeDef

PutManagedInsightRulesInputRequestTypeDef#

# PutManagedInsightRulesInputRequestTypeDef definition

class PutManagedInsightRulesInputRequestTypeDef(TypedDict):
    ManagedRules: Sequence[ManagedRuleTypeDef],  # (1)
  1. See ManagedRuleTypeDef

ListManagedInsightRulesOutputTypeDef#

# ListManagedInsightRulesOutputTypeDef definition

class ListManagedInsightRulesOutputTypeDef(TypedDict):
    ManagedRules: List[ManagedRuleDescriptionTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ManagedRuleDescriptionTypeDef
  2. See ResponseMetadataTypeDef

PutMetricDataInputRequestTypeDef#

# PutMetricDataInputRequestTypeDef definition

class PutMetricDataInputRequestTypeDef(TypedDict):
    Namespace: str,
    MetricData: Sequence[MetricDatumTypeDef],  # (1)
  1. See MetricDatumTypeDef

GetMetricStreamOutputTypeDef#

# GetMetricStreamOutputTypeDef definition

class GetMetricStreamOutputTypeDef(TypedDict):
    Arn: str,
    Name: str,
    IncludeFilters: List[MetricStreamFilterTypeDef],  # (1)
    ExcludeFilters: List[MetricStreamFilterTypeDef],  # (1)
    FirehoseArn: str,
    RoleArn: str,
    State: str,
    CreationDate: datetime,
    LastUpdateDate: datetime,
    OutputFormat: MetricStreamOutputFormatType,  # (3)
    StatisticsConfigurations: List[MetricStreamStatisticsConfigurationTypeDef],  # (4)
    IncludeLinkedAccountsMetrics: bool,
    ResponseMetadata: ResponseMetadataTypeDef,  # (5)
  1. See MetricStreamFilterTypeDef
  2. See MetricStreamFilterTypeDef
  3. See MetricStreamOutputFormatType
  4. See MetricStreamStatisticsConfigurationTypeDef
  5. See ResponseMetadataTypeDef

PutMetricStreamInputRequestTypeDef#

# PutMetricStreamInputRequestTypeDef definition

class PutMetricStreamInputRequestTypeDef(TypedDict):
    Name: str,
    FirehoseArn: str,
    RoleArn: str,
    OutputFormat: MetricStreamOutputFormatType,  # (1)
    IncludeFilters: NotRequired[Sequence[MetricStreamFilterTypeDef]],  # (2)
    ExcludeFilters: NotRequired[Sequence[MetricStreamFilterTypeDef]],  # (2)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    StatisticsConfigurations: NotRequired[Sequence[MetricStreamStatisticsConfigurationTypeDef]],  # (5)
    IncludeLinkedAccountsMetrics: NotRequired[bool],
  1. See MetricStreamOutputFormatType
  2. See MetricStreamFilterTypeDef
  3. See MetricStreamFilterTypeDef
  4. See TagTypeDef
  5. See MetricStreamStatisticsConfigurationTypeDef

MetricDataQueryPaginatorTypeDef#

# MetricDataQueryPaginatorTypeDef definition

class MetricDataQueryPaginatorTypeDef(TypedDict):
    Id: str,
    MetricStat: NotRequired[MetricStatPaginatorTypeDef],  # (1)
    Expression: NotRequired[str],
    Label: NotRequired[str],
    ReturnData: NotRequired[bool],
    Period: NotRequired[int],
    AccountId: NotRequired[str],
  1. See MetricStatPaginatorTypeDef

MetricDataQueryTypeDef#

# MetricDataQueryTypeDef definition

class MetricDataQueryTypeDef(TypedDict):
    Id: str,
    MetricStat: NotRequired[MetricStatTypeDef],  # (1)
    Expression: NotRequired[str],
    Label: NotRequired[str],
    ReturnData: NotRequired[bool],
    Period: NotRequired[int],
    AccountId: NotRequired[str],
  1. See MetricStatTypeDef

CloudwatchEventDetailConfigurationTypeDef#

# CloudwatchEventDetailConfigurationTypeDef definition

class CloudwatchEventDetailConfigurationTypeDef(TypedDict):
    id: NotRequired[str],
    description: NotRequired[str],
    metrics: NotRequired[List[CloudwatchEventMetricTypeDef]],  # (1)
    actionsSuppressor: NotRequired[str],
    actionsSuppressorWaitPeriod: NotRequired[int],
    actionsSuppressorExtensionPeriod: NotRequired[int],
    threshold: NotRequired[int],
    evaluationPeriods: NotRequired[int],
    alarmRule: NotRequired[str],
    alarmName: NotRequired[str],
    treatMissingData: NotRequired[str],
    comparisonOperator: NotRequired[str],
    timestamp: NotRequired[str],
    actionsEnabled: NotRequired[bool],
    okActions: NotRequired[List[str]],
    alarmActions: NotRequired[List[str]],
    insufficientDataActions: NotRequired[List[str]],
  1. See CloudwatchEventMetricTypeDef

GetMetricDataInputGetMetricDataPaginateTypeDef#

# GetMetricDataInputGetMetricDataPaginateTypeDef definition

class GetMetricDataInputGetMetricDataPaginateTypeDef(TypedDict):
    MetricDataQueries: Sequence[MetricDataQueryPaginatorTypeDef],  # (1)
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    ScanBy: NotRequired[ScanByType],  # (2)
    LabelOptions: NotRequired[LabelOptionsTypeDef],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See MetricDataQueryPaginatorTypeDef
  2. See ScanByType
  3. See LabelOptionsTypeDef
  4. See PaginatorConfigTypeDef

MetricAlarmPaginatorTypeDef#

# MetricAlarmPaginatorTypeDef definition

class MetricAlarmPaginatorTypeDef(TypedDict):
    AlarmName: NotRequired[str],
    AlarmArn: NotRequired[str],
    AlarmDescription: NotRequired[str],
    AlarmConfigurationUpdatedTimestamp: NotRequired[datetime],
    ActionsEnabled: NotRequired[bool],
    OKActions: NotRequired[List[str]],
    AlarmActions: NotRequired[List[str]],
    InsufficientDataActions: NotRequired[List[str]],
    StateValue: NotRequired[StateValueType],  # (1)
    StateReason: NotRequired[str],
    StateReasonData: NotRequired[str],
    StateUpdatedTimestamp: NotRequired[datetime],
    MetricName: NotRequired[str],
    Namespace: NotRequired[str],
    Statistic: NotRequired[StatisticType],  # (2)
    ExtendedStatistic: NotRequired[str],
    Dimensions: NotRequired[List[DimensionTypeDef]],  # (3)
    Period: NotRequired[int],
    Unit: NotRequired[StandardUnitType],  # (4)
    EvaluationPeriods: NotRequired[int],
    DatapointsToAlarm: NotRequired[int],
    Threshold: NotRequired[float],
    ComparisonOperator: NotRequired[ComparisonOperatorType],  # (5)
    TreatMissingData: NotRequired[str],
    EvaluateLowSampleCountPercentile: NotRequired[str],
    Metrics: NotRequired[List[MetricDataQueryPaginatorTypeDef]],  # (6)
    ThresholdMetricId: NotRequired[str],
    EvaluationState: NotRequired[EvaluationStateType],  # (7)
    StateTransitionedTimestamp: NotRequired[datetime],
  1. See StateValueType
  2. See StatisticType
  3. See DimensionTypeDef
  4. See StandardUnitType
  5. See ComparisonOperatorType
  6. See MetricDataQueryPaginatorTypeDef
  7. See EvaluationStateType

MetricMathAnomalyDetectorPaginatorTypeDef#

# MetricMathAnomalyDetectorPaginatorTypeDef definition

class MetricMathAnomalyDetectorPaginatorTypeDef(TypedDict):
    MetricDataQueries: NotRequired[List[MetricDataQueryPaginatorTypeDef]],  # (1)
  1. See MetricDataQueryPaginatorTypeDef

GetMetricDataInputRequestTypeDef#

# GetMetricDataInputRequestTypeDef definition

class GetMetricDataInputRequestTypeDef(TypedDict):
    MetricDataQueries: Sequence[MetricDataQueryTypeDef],  # (1)
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],
    NextToken: NotRequired[str],
    ScanBy: NotRequired[ScanByType],  # (2)
    MaxDatapoints: NotRequired[int],
    LabelOptions: NotRequired[LabelOptionsTypeDef],  # (3)
  1. See MetricDataQueryTypeDef
  2. See ScanByType
  3. See LabelOptionsTypeDef

MetricAlarmTypeDef#

# MetricAlarmTypeDef definition

class MetricAlarmTypeDef(TypedDict):
    AlarmName: NotRequired[str],
    AlarmArn: NotRequired[str],
    AlarmDescription: NotRequired[str],
    AlarmConfigurationUpdatedTimestamp: NotRequired[datetime],
    ActionsEnabled: NotRequired[bool],
    OKActions: NotRequired[List[str]],
    AlarmActions: NotRequired[List[str]],
    InsufficientDataActions: NotRequired[List[str]],
    StateValue: NotRequired[StateValueType],  # (1)
    StateReason: NotRequired[str],
    StateReasonData: NotRequired[str],
    StateUpdatedTimestamp: NotRequired[datetime],
    MetricName: NotRequired[str],
    Namespace: NotRequired[str],
    Statistic: NotRequired[StatisticType],  # (2)
    ExtendedStatistic: NotRequired[str],
    Dimensions: NotRequired[List[DimensionTypeDef]],  # (3)
    Period: NotRequired[int],
    Unit: NotRequired[StandardUnitType],  # (4)
    EvaluationPeriods: NotRequired[int],
    DatapointsToAlarm: NotRequired[int],
    Threshold: NotRequired[float],
    ComparisonOperator: NotRequired[ComparisonOperatorType],  # (5)
    TreatMissingData: NotRequired[str],
    EvaluateLowSampleCountPercentile: NotRequired[str],
    Metrics: NotRequired[List[MetricDataQueryTypeDef]],  # (6)
    ThresholdMetricId: NotRequired[str],
    EvaluationState: NotRequired[EvaluationStateType],  # (7)
    StateTransitionedTimestamp: NotRequired[datetime],
  1. See StateValueType
  2. See StatisticType
  3. See DimensionTypeDef
  4. See StandardUnitType
  5. See ComparisonOperatorType
  6. See MetricDataQueryTypeDef
  7. See EvaluationStateType

MetricMathAnomalyDetectorTypeDef#

# MetricMathAnomalyDetectorTypeDef definition

class MetricMathAnomalyDetectorTypeDef(TypedDict):
    MetricDataQueries: NotRequired[Sequence[MetricDataQueryTypeDef]],  # (1)
  1. See MetricDataQueryTypeDef

PutMetricAlarmInputMetricPutAlarmTypeDef#

# PutMetricAlarmInputMetricPutAlarmTypeDef definition

class PutMetricAlarmInputMetricPutAlarmTypeDef(TypedDict):
    AlarmName: str,
    EvaluationPeriods: int,
    ComparisonOperator: ComparisonOperatorType,  # (1)
    AlarmDescription: NotRequired[str],
    ActionsEnabled: NotRequired[bool],
    OKActions: NotRequired[Sequence[str]],
    AlarmActions: NotRequired[Sequence[str]],
    InsufficientDataActions: NotRequired[Sequence[str]],
    Statistic: NotRequired[StatisticType],  # (2)
    ExtendedStatistic: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (3)
    Period: NotRequired[int],
    Unit: NotRequired[StandardUnitType],  # (4)
    DatapointsToAlarm: NotRequired[int],
    Threshold: NotRequired[float],
    TreatMissingData: NotRequired[str],
    EvaluateLowSampleCountPercentile: NotRequired[str],
    Metrics: NotRequired[Sequence[MetricDataQueryTypeDef]],  # (5)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (6)
    ThresholdMetricId: NotRequired[str],
  1. See ComparisonOperatorType
  2. See StatisticType
  3. See DimensionTypeDef
  4. See StandardUnitType
  5. See MetricDataQueryTypeDef
  6. See TagTypeDef

PutMetricAlarmInputRequestTypeDef#

# PutMetricAlarmInputRequestTypeDef definition

class PutMetricAlarmInputRequestTypeDef(TypedDict):
    AlarmName: str,
    EvaluationPeriods: int,
    ComparisonOperator: ComparisonOperatorType,  # (1)
    AlarmDescription: NotRequired[str],
    ActionsEnabled: NotRequired[bool],
    OKActions: NotRequired[Sequence[str]],
    AlarmActions: NotRequired[Sequence[str]],
    InsufficientDataActions: NotRequired[Sequence[str]],
    MetricName: NotRequired[str],
    Namespace: NotRequired[str],
    Statistic: NotRequired[StatisticType],  # (2)
    ExtendedStatistic: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (3)
    Period: NotRequired[int],
    Unit: NotRequired[StandardUnitType],  # (4)
    DatapointsToAlarm: NotRequired[int],
    Threshold: NotRequired[float],
    TreatMissingData: NotRequired[str],
    EvaluateLowSampleCountPercentile: NotRequired[str],
    Metrics: NotRequired[Sequence[MetricDataQueryTypeDef]],  # (5)
    Tags: NotRequired[Sequence[TagTypeDef]],  # (6)
    ThresholdMetricId: NotRequired[str],
  1. See ComparisonOperatorType
  2. See StatisticType
  3. See DimensionTypeDef
  4. See StandardUnitType
  5. See MetricDataQueryTypeDef
  6. See TagTypeDef

CloudwatchEventDetailTypeDef#

# CloudwatchEventDetailTypeDef definition

class CloudwatchEventDetailTypeDef(TypedDict):
    alarmName: str,
    state: CloudwatchEventStateTypeDef,  # (3)
    operation: NotRequired[str],
    configuration: NotRequired[CloudwatchEventDetailConfigurationTypeDef],  # (1)
    previousConfiguration: NotRequired[CloudwatchEventDetailConfigurationTypeDef],  # (1)
    previousState: NotRequired[CloudwatchEventStateTypeDef],  # (3)
  1. See CloudwatchEventDetailConfigurationTypeDef
  2. See CloudwatchEventDetailConfigurationTypeDef
  3. See CloudwatchEventStateTypeDef
  4. See CloudwatchEventStateTypeDef

DescribeAlarmsOutputPaginatorTypeDef#

# DescribeAlarmsOutputPaginatorTypeDef definition

class DescribeAlarmsOutputPaginatorTypeDef(TypedDict):
    CompositeAlarms: List[CompositeAlarmTypeDef],  # (1)
    MetricAlarms: List[MetricAlarmPaginatorTypeDef],  # (2)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See CompositeAlarmTypeDef
  2. See MetricAlarmPaginatorTypeDef
  3. See ResponseMetadataTypeDef

AnomalyDetectorPaginatorTypeDef#

# AnomalyDetectorPaginatorTypeDef definition

class AnomalyDetectorPaginatorTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[List[DimensionTypeDef]],  # (1)
    Stat: NotRequired[str],
    Configuration: NotRequired[AnomalyDetectorConfigurationTypeDef],  # (2)
    StateValue: NotRequired[AnomalyDetectorStateValueType],  # (3)
    SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorPaginatorTypeDef],  # (4)
    MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorPaginatorTypeDef],  # (5)
  1. See DimensionTypeDef
  2. See AnomalyDetectorConfigurationTypeDef
  3. See AnomalyDetectorStateValueType
  4. See SingleMetricAnomalyDetectorPaginatorTypeDef
  5. See MetricMathAnomalyDetectorPaginatorTypeDef

DescribeAlarmsForMetricOutputTypeDef#

# DescribeAlarmsForMetricOutputTypeDef definition

class DescribeAlarmsForMetricOutputTypeDef(TypedDict):
    MetricAlarms: List[MetricAlarmTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricAlarmTypeDef
  2. See ResponseMetadataTypeDef

DescribeAlarmsOutputTypeDef#

# DescribeAlarmsOutputTypeDef definition

class DescribeAlarmsOutputTypeDef(TypedDict):
    CompositeAlarms: List[CompositeAlarmTypeDef],  # (1)
    MetricAlarms: List[MetricAlarmTypeDef],  # (2)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See CompositeAlarmTypeDef
  2. See MetricAlarmTypeDef
  3. See ResponseMetadataTypeDef

MetricStatAlarmTypeDef#

# MetricStatAlarmTypeDef definition

class MetricStatAlarmTypeDef(TypedDict):
    Metric: MetricAlarmTypeDef,  # (1)
    Period: int,
    Stat: str,
    Unit: NotRequired[StandardUnitType],  # (2)
  1. See MetricAlarmTypeDef
  2. See StandardUnitType

AnomalyDetectorTypeDef#

# AnomalyDetectorTypeDef definition

class AnomalyDetectorTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[List[DimensionTypeDef]],  # (1)
    Stat: NotRequired[str],
    Configuration: NotRequired[AnomalyDetectorConfigurationTypeDef],  # (2)
    StateValue: NotRequired[AnomalyDetectorStateValueType],  # (3)
    SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorTypeDef],  # (4)
    MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorTypeDef],  # (5)
  1. See DimensionTypeDef
  2. See AnomalyDetectorConfigurationTypeDef
  3. See AnomalyDetectorStateValueType
  4. See SingleMetricAnomalyDetectorTypeDef
  5. See MetricMathAnomalyDetectorTypeDef

DeleteAnomalyDetectorInputRequestTypeDef#

# DeleteAnomalyDetectorInputRequestTypeDef definition

class DeleteAnomalyDetectorInputRequestTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    Stat: NotRequired[str],
    SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorTypeDef],  # (2)
    MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorTypeDef],  # (3)
  1. See DimensionTypeDef
  2. See SingleMetricAnomalyDetectorTypeDef
  3. See MetricMathAnomalyDetectorTypeDef

PutAnomalyDetectorInputRequestTypeDef#

# PutAnomalyDetectorInputRequestTypeDef definition

class PutAnomalyDetectorInputRequestTypeDef(TypedDict):
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[Sequence[DimensionTypeDef]],  # (1)
    Stat: NotRequired[str],
    Configuration: NotRequired[AnomalyDetectorConfigurationTypeDef],  # (2)
    SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorTypeDef],  # (3)
    MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorTypeDef],  # (4)
  1. See DimensionTypeDef
  2. See AnomalyDetectorConfigurationTypeDef
  3. See SingleMetricAnomalyDetectorTypeDef
  4. See MetricMathAnomalyDetectorTypeDef

CloudwatchEventTypeDef#

# CloudwatchEventTypeDef definition

class CloudwatchEventTypeDef(TypedDict):
    version: str,
    id: str,
    detail-type: str,
    source: str,
    account: str,
    time: str,
    region: str,
    resources: List[str],
    detail: CloudwatchEventDetailTypeDef,  # (1)
  1. See CloudwatchEventDetailTypeDef

DescribeAnomalyDetectorsOutputPaginatorTypeDef#

# DescribeAnomalyDetectorsOutputPaginatorTypeDef definition

class DescribeAnomalyDetectorsOutputPaginatorTypeDef(TypedDict):
    AnomalyDetectors: List[AnomalyDetectorPaginatorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnomalyDetectorPaginatorTypeDef
  2. See ResponseMetadataTypeDef

MetricDataQueryAlarmTypeDef#

# MetricDataQueryAlarmTypeDef definition

class MetricDataQueryAlarmTypeDef(TypedDict):
    Id: str,
    MetricStat: NotRequired[MetricStatAlarmTypeDef],  # (1)
    Expression: NotRequired[str],
    Label: NotRequired[str],
    ReturnData: NotRequired[bool],
    Period: NotRequired[int],
    AccountId: NotRequired[str],
  1. See MetricStatAlarmTypeDef

DescribeAnomalyDetectorsOutputTypeDef#

# DescribeAnomalyDetectorsOutputTypeDef definition

class DescribeAnomalyDetectorsOutputTypeDef(TypedDict):
    AnomalyDetectors: List[AnomalyDetectorTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnomalyDetectorTypeDef
  2. See ResponseMetadataTypeDef