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,
]

MetricStreamFilterUnionTypeDef#

# MetricStreamFilterUnionTypeDef definition

MetricStreamFilterUnionTypeDef = Union[
    MetricStreamFilterTypeDef,  # (1)
    MetricStreamFilterOutputTypeDef,  # (2)
]
  1. See MetricStreamFilterTypeDef
  2. See MetricStreamFilterOutputTypeDef

RangeUnionTypeDef#

# RangeUnionTypeDef definition

RangeUnionTypeDef = Union[
    RangeTypeDef,  # (1)
    RangeOutputTypeDef,  # (2)
]
  1. See RangeTypeDef
  2. See RangeOutputTypeDef

MetricStreamStatisticsConfigurationUnionTypeDef#

# MetricStreamStatisticsConfigurationUnionTypeDef definition

MetricStreamStatisticsConfigurationUnionTypeDef = Union[
    MetricStreamStatisticsConfigurationTypeDef,  # (1)
    MetricStreamStatisticsConfigurationOutputTypeDef,  # (2)
]
  1. See MetricStreamStatisticsConfigurationTypeDef
  2. See MetricStreamStatisticsConfigurationOutputTypeDef

MetricDataQueryUnionTypeDef#

# MetricDataQueryUnionTypeDef definition

MetricDataQueryUnionTypeDef = Union[
    MetricDataQueryTypeDef,  # (1)
    MetricDataQueryOutputTypeDef,  # (2)
]
  1. See MetricDataQueryTypeDef
  2. See MetricDataQueryOutputTypeDef

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

RangeOutputTypeDef#

# RangeOutputTypeDef definition

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

DimensionTypeDef#

# DimensionTypeDef definition

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

MetricCharacteristicsTypeDef#

# MetricCharacteristicsTypeDef definition

class MetricCharacteristicsTypeDef(TypedDict):
    PeriodicSpikes: NotRequired[bool],

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],

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

WaiterConfigTypeDef#

# WaiterConfigTypeDef definition

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

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],

EntityTypeDef#

# EntityTypeDef definition

class EntityTypeDef(TypedDict):
    KeyAttributes: NotRequired[Mapping[str, str]],
    Attributes: NotRequired[Mapping[str, 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,

MetricStreamFilterOutputTypeDef#

# MetricStreamFilterOutputTypeDef definition

class MetricStreamFilterOutputTypeDef(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,

MetricStreamFilterTypeDef#

# MetricStreamFilterTypeDef definition

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

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],

AnomalyDetectorConfigurationOutputTypeDef#

# AnomalyDetectorConfigurationOutputTypeDef definition

class AnomalyDetectorConfigurationOutputTypeDef(TypedDict):
    ExcludedTimeRanges: NotRequired[list[RangeOutputTypeDef]],  # (1)
    MetricTimezone: NotRequired[str],
  1. See RangeOutputTypeDef

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

MetricOutputTypeDef#

# MetricOutputTypeDef definition

class MetricOutputTypeDef(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

SingleMetricAnomalyDetectorOutputTypeDef#

# SingleMetricAnomalyDetectorOutputTypeDef definition

class SingleMetricAnomalyDetectorOutputTypeDef(TypedDict):
    AccountId: NotRequired[str],
    Namespace: NotRequired[str],
    MetricName: NotRequired[str],
    Dimensions: NotRequired[list[DimensionTypeDef]],  # (1)
    Stat: NotRequired[str],
  1. See DimensionTypeDef

SingleMetricAnomalyDetectorTypeDef#

# SingleMetricAnomalyDetectorTypeDef definition

class SingleMetricAnomalyDetectorTypeDef(TypedDict):
    AccountId: NotRequired[str],
    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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  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[TimestampTypeDef],
    EndDate: NotRequired[TimestampTypeDef],
    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[TimestampTypeDef],
    EndDate: NotRequired[TimestampTypeDef],
    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: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    Period: int,
    MaxContributorCount: NotRequired[int],
    Metrics: NotRequired[Sequence[str]],
    OrderBy: NotRequired[str],

GetMetricStatisticsInputMetricGetStatisticsTypeDef#

# GetMetricStatisticsInputMetricGetStatisticsTypeDef definition

class GetMetricStatisticsInputMetricGetStatisticsTypeDef(TypedDict):
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    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: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    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

RangeTypeDef#

# RangeTypeDef definition

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

DescribeAlarmHistoryInputPaginateTypeDef#

# DescribeAlarmHistoryInputPaginateTypeDef definition

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

DescribeAlarmsInputPaginateTypeDef#

# DescribeAlarmsInputPaginateTypeDef definition

class DescribeAlarmsInputPaginateTypeDef(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

DescribeAnomalyDetectorsInputPaginateTypeDef#

# DescribeAnomalyDetectorsInputPaginateTypeDef definition

class DescribeAnomalyDetectorsInputPaginateTypeDef(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

ListDashboardsInputPaginateTypeDef#

# ListDashboardsInputPaginateTypeDef definition

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

DescribeAlarmsInputWaitTypeDef#

# DescribeAlarmsInputWaitTypeDef definition

class DescribeAlarmsInputWaitTypeDef(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):
    InsightRules: list[InsightRuleTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See InsightRuleTypeDef
  2. See ResponseMetadataTypeDef

ListMetricsInputPaginateTypeDef#

# ListMetricsInputPaginateTypeDef definition

class ListMetricsInputPaginateTypeDef(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):
    Entries: list[MetricStreamEntryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  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[TimestampTypeDef],
    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

MetricStreamStatisticsConfigurationOutputTypeDef#

# MetricStreamStatisticsConfigurationOutputTypeDef definition

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

MetricStreamStatisticsConfigurationTypeDef#

# MetricStreamStatisticsConfigurationTypeDef definition

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

ListMetricsOutputTypeDef#

# ListMetricsOutputTypeDef definition

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

MetricStatOutputTypeDef#

# MetricStatOutputTypeDef definition

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

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)
    Messages: list[MessageDataTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See ManagedRuleDescriptionTypeDef
  2. See ResponseMetadataTypeDef

EntityMetricDataTypeDef#

# EntityMetricDataTypeDef definition

class EntityMetricDataTypeDef(TypedDict):
    Entity: NotRequired[EntityTypeDef],  # (1)
    MetricData: NotRequired[Sequence[MetricDatumTypeDef]],  # (2)
  1. See EntityTypeDef
  2. See MetricDatumTypeDef

GetMetricStreamOutputTypeDef#

# GetMetricStreamOutputTypeDef definition

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

MetricDataQueryOutputTypeDef#

# MetricDataQueryOutputTypeDef definition

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

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

AnomalyDetectorConfigurationTypeDef#

# AnomalyDetectorConfigurationTypeDef definition

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

PutMetricDataInputMetricPutDataTypeDef#

# PutMetricDataInputMetricPutDataTypeDef definition

class PutMetricDataInputMetricPutDataTypeDef(TypedDict):
    EntityMetricData: NotRequired[Sequence[EntityMetricDataTypeDef]],  # (1)
    StrictEntityValidation: NotRequired[bool],
  1. See EntityMetricDataTypeDef

PutMetricDataInputRequestTypeDef#

# PutMetricDataInputRequestTypeDef definition

class PutMetricDataInputRequestTypeDef(TypedDict):
    Namespace: str,
    MetricData: NotRequired[Sequence[MetricDatumTypeDef]],  # (1)
    EntityMetricData: NotRequired[Sequence[EntityMetricDataTypeDef]],  # (2)
    StrictEntityValidation: NotRequired[bool],
  1. See MetricDatumTypeDef
  2. See EntityMetricDataTypeDef

PutMetricStreamInputRequestTypeDef#

# PutMetricStreamInputRequestTypeDef definition

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

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[MetricDataQueryOutputTypeDef]],  # (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 MetricDataQueryOutputTypeDef
  7. See EvaluationStateType

MetricMathAnomalyDetectorOutputTypeDef#

# MetricMathAnomalyDetectorOutputTypeDef definition

class MetricMathAnomalyDetectorOutputTypeDef(TypedDict):
    MetricDataQueries: NotRequired[list[MetricDataQueryOutputTypeDef]],  # (1)
  1. See MetricDataQueryOutputTypeDef

GetMetricDataInputPaginateTypeDef#

# GetMetricDataInputPaginateTypeDef definition

class GetMetricDataInputPaginateTypeDef(TypedDict):
    MetricDataQueries: Sequence[MetricDataQueryTypeDef],  # (1)
    StartTime: TimestampTypeDef,
    EndTime: TimestampTypeDef,
    ScanBy: NotRequired[ScanByType],  # (2)
    LabelOptions: NotRequired[LabelOptionsTypeDef],  # (3)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (4)
  1. See MetricDataQueryTypeDef
  2. See ScanByType
  3. See LabelOptionsTypeDef
  4. See PaginatorConfigTypeDef

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

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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
    NextToken: NotRequired[str],
  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[AnomalyDetectorConfigurationOutputTypeDef],  # (2)
    StateValue: NotRequired[AnomalyDetectorStateValueType],  # (3)
    MetricCharacteristics: NotRequired[MetricCharacteristicsTypeDef],  # (4)
    SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorOutputTypeDef],  # (5)
    MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorOutputTypeDef],  # (6)
  1. See DimensionTypeDef
  2. See AnomalyDetectorConfigurationOutputTypeDef
  3. See AnomalyDetectorStateValueType
  4. See MetricCharacteristicsTypeDef
  5. See SingleMetricAnomalyDetectorOutputTypeDef
  6. See MetricMathAnomalyDetectorOutputTypeDef

GetMetricDataInputRequestTypeDef#

# GetMetricDataInputRequestTypeDef definition

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

MetricMathAnomalyDetectorTypeDef#

# MetricMathAnomalyDetectorTypeDef definition

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

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

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)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    NextToken: NotRequired[str],
  1. See AnomalyDetectorTypeDef
  2. See ResponseMetadataTypeDef

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)
    MetricCharacteristics: NotRequired[MetricCharacteristicsTypeDef],  # (3)
    SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorTypeDef],  # (4)
    MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorTypeDef],  # (5)
  1. See DimensionTypeDef
  2. See AnomalyDetectorConfigurationTypeDef
  3. See MetricCharacteristicsTypeDef
  4. See SingleMetricAnomalyDetectorTypeDef
  5. See MetricMathAnomalyDetectorTypeDef