Typed dictionaries

Index > CloudWatch > Typed dictionaries

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

AlarmHistoryItemTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import AlarmHistoryItemTypeDef

def get_value() -> AlarmHistoryItemTypeDef:
    return {
        "AlarmName": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import RangeTypeDef

def get_value() -> RangeTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
    }

Definition

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

DimensionTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DimensionTypeDef

def get_value() -> DimensionTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }

Definition

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

CompositeAlarmTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import CompositeAlarmTypeDef

def get_value() -> CompositeAlarmTypeDef:
    return {
        "ActionsEnabled": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DashboardEntryTypeDef

def get_value() -> DashboardEntryTypeDef:
    return {
        "DashboardName": ...,
    }

Definition

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

DashboardValidationMessageTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DashboardValidationMessageTypeDef

def get_value() -> DashboardValidationMessageTypeDef:
    return {
        "DataPath": ...,
    }

Definition

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

DatapointTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DatapointTypeDef

def get_value() -> DatapointTypeDef:
    return {
        "Timestamp": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DeleteAlarmsInputRequestTypeDef

def get_value() -> DeleteAlarmsInputRequestTypeDef:
    return {
        "AlarmNames": ...,
    }

Definition

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

DeleteDashboardsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DeleteDashboardsInputRequestTypeDef

def get_value() -> DeleteDashboardsInputRequestTypeDef:
    return {
        "DashboardNames": ...,
    }

Definition

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

DeleteInsightRulesInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DeleteInsightRulesInputRequestTypeDef

def get_value() -> DeleteInsightRulesInputRequestTypeDef:
    return {
        "RuleNames": ...,
    }

Definition

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

PartialFailureTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PartialFailureTypeDef

def get_value() -> PartialFailureTypeDef:
    return {
        "FailureResource": ...,
    }

Definition

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

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

Definition

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

DeleteMetricStreamInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DeleteMetricStreamInputRequestTypeDef

def get_value() -> DeleteMetricStreamInputRequestTypeDef:
    return {
        "Name": ...,
    }

Definition

class DeleteMetricStreamInputRequestTypeDef(TypedDict):
    Name: str,

DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef

def get_value() -> DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef:
    return {
        "AlarmTypes": ...,
    }

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

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }

Definition

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

DescribeAlarmHistoryInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmHistoryInputRequestTypeDef

def get_value() -> DescribeAlarmHistoryInputRequestTypeDef:
    return {
        "AlarmName": ...,
    }

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

WaiterConfigTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import WaiterConfigTypeDef

def get_value() -> WaiterConfigTypeDef:
    return {
        "Delay": ...,
    }

Definition

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

DescribeAlarmsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmsInputRequestTypeDef

def get_value() -> DescribeAlarmsInputRequestTypeDef:
    return {
        "AlarmNames": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeInsightRulesInputRequestTypeDef

def get_value() -> DescribeInsightRulesInputRequestTypeDef:
    return {
        "NextToken": ...,
    }

Definition

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

InsightRuleTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import InsightRuleTypeDef

def get_value() -> InsightRuleTypeDef:
    return {
        "Name": ...,
        "State": ...,
        "Schema": ...,
        "Definition": ...,
    }

Definition

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

DimensionFilterTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DimensionFilterTypeDef

def get_value() -> DimensionFilterTypeDef:
    return {
        "Name": ...,
    }

Definition

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

DisableAlarmActionsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DisableAlarmActionsInputRequestTypeDef

def get_value() -> DisableAlarmActionsInputRequestTypeDef:
    return {
        "AlarmNames": ...,
    }

Definition

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

DisableInsightRulesInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DisableInsightRulesInputRequestTypeDef

def get_value() -> DisableInsightRulesInputRequestTypeDef:
    return {
        "RuleNames": ...,
    }

Definition

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

EnableAlarmActionsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import EnableAlarmActionsInputRequestTypeDef

def get_value() -> EnableAlarmActionsInputRequestTypeDef:
    return {
        "AlarmNames": ...,
    }

Definition

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

EnableInsightRulesInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import EnableInsightRulesInputRequestTypeDef

def get_value() -> EnableInsightRulesInputRequestTypeDef:
    return {
        "RuleNames": ...,
    }

Definition

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

GetDashboardInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetDashboardInputRequestTypeDef

def get_value() -> GetDashboardInputRequestTypeDef:
    return {
        "DashboardName": ...,
    }

Definition

class GetDashboardInputRequestTypeDef(TypedDict):
    DashboardName: str,

GetInsightRuleReportInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetInsightRuleReportInputRequestTypeDef

def get_value() -> GetInsightRuleReportInputRequestTypeDef:
    return {
        "RuleName": ...,
        "StartTime": ...,
        "EndTime": ...,
        "Period": ...,
    }

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

InsightRuleMetricDatapointTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import InsightRuleMetricDatapointTypeDef

def get_value() -> InsightRuleMetricDatapointTypeDef:
    return {
        "Timestamp": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import LabelOptionsTypeDef

def get_value() -> LabelOptionsTypeDef:
    return {
        "Timezone": ...,
    }

Definition

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

MessageDataTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MessageDataTypeDef

def get_value() -> MessageDataTypeDef:
    return {
        "Code": ...,
    }

Definition

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

GetMetricStreamInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricStreamInputRequestTypeDef

def get_value() -> GetMetricStreamInputRequestTypeDef:
    return {
        "Name": ...,
    }

Definition

class GetMetricStreamInputRequestTypeDef(TypedDict):
    Name: str,

MetricStreamFilterTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricStreamFilterTypeDef

def get_value() -> MetricStreamFilterTypeDef:
    return {
        "Namespace": ...,
    }

Definition

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

GetMetricWidgetImageInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricWidgetImageInputRequestTypeDef

def get_value() -> GetMetricWidgetImageInputRequestTypeDef:
    return {
        "MetricWidget": ...,
    }

Definition

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

InsightRuleContributorDatapointTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import InsightRuleContributorDatapointTypeDef

def get_value() -> InsightRuleContributorDatapointTypeDef:
    return {
        "Timestamp": ...,
        "ApproximateValue": ...,
    }

Definition

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

ListDashboardsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListDashboardsInputRequestTypeDef

def get_value() -> ListDashboardsInputRequestTypeDef:
    return {
        "DashboardNamePrefix": ...,
    }

Definition

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

ListManagedInsightRulesInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListManagedInsightRulesInputRequestTypeDef

def get_value() -> ListManagedInsightRulesInputRequestTypeDef:
    return {
        "ResourceARN": ...,
    }

Definition

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

ListMetricStreamsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListMetricStreamsInputRequestTypeDef

def get_value() -> ListMetricStreamsInputRequestTypeDef:
    return {
        "NextToken": ...,
    }

Definition

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

MetricStreamEntryTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricStreamEntryTypeDef

def get_value() -> MetricStreamEntryTypeDef:
    return {
        "Arn": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListTagsForResourceInputRequestTypeDef

def get_value() -> ListTagsForResourceInputRequestTypeDef:
    return {
        "ResourceARN": ...,
    }

Definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    ResourceARN: str,

TagTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import TagTypeDef

def get_value() -> TagTypeDef:
    return {
        "Key": ...,
        "Value": ...,
    }

Definition

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

ManagedRuleStateTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ManagedRuleStateTypeDef

def get_value() -> ManagedRuleStateTypeDef:
    return {
        "RuleName": ...,
        "State": ...,
    }

Definition

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

StatisticSetTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import StatisticSetTypeDef

def get_value() -> StatisticSetTypeDef:
    return {
        "SampleCount": ...,
        "Sum": ...,
        "Minimum": ...,
        "Maximum": ...,
    }

Definition

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

MetricStreamStatisticsMetricTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricStreamStatisticsMetricTypeDef

def get_value() -> MetricStreamStatisticsMetricTypeDef:
    return {
        "Namespace": ...,
        "MetricName": ...,
    }

Definition

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

PutDashboardInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutDashboardInputRequestTypeDef

def get_value() -> PutDashboardInputRequestTypeDef:
    return {
        "DashboardName": ...,
        "DashboardBody": ...,
    }

Definition

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

ServiceResourceAlarmRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ServiceResourceAlarmRequestTypeDef

def get_value() -> ServiceResourceAlarmRequestTypeDef:
    return {
        "name": ...,
    }

Definition

class ServiceResourceAlarmRequestTypeDef(TypedDict):
    name: str,

ServiceResourceMetricRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ServiceResourceMetricRequestTypeDef

def get_value() -> ServiceResourceMetricRequestTypeDef:
    return {
        "namespace": ...,
        "name": ...,
    }

Definition

class ServiceResourceMetricRequestTypeDef(TypedDict):
    namespace: str,
    name: str,

SetAlarmStateInputAlarmSetStateTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import SetAlarmStateInputAlarmSetStateTypeDef

def get_value() -> SetAlarmStateInputAlarmSetStateTypeDef:
    return {
        "StateValue": ...,
        "StateReason": ...,
    }

Definition

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

1. See StateValueType

SetAlarmStateInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import SetAlarmStateInputRequestTypeDef

def get_value() -> SetAlarmStateInputRequestTypeDef:
    return {
        "AlarmName": ...,
        "StateValue": ...,
        "StateReason": ...,
    }

Definition

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

1. See StateValueType

StartMetricStreamsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import StartMetricStreamsInputRequestTypeDef

def get_value() -> StartMetricStreamsInputRequestTypeDef:
    return {
        "Names": ...,
    }

Definition

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

StopMetricStreamsInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import StopMetricStreamsInputRequestTypeDef

def get_value() -> StopMetricStreamsInputRequestTypeDef:
    return {
        "Names": ...,
    }

Definition

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

UntagResourceInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import UntagResourceInputRequestTypeDef

def get_value() -> UntagResourceInputRequestTypeDef:
    return {
        "ResourceARN": ...,
        "TagKeys": ...,
    }

Definition

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

AnomalyDetectorConfigurationTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import AnomalyDetectorConfigurationTypeDef

def get_value() -> AnomalyDetectorConfigurationTypeDef:
    return {
        "ExcludedTimeRanges": ...,
    }

Definition

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

1. See RangeTypeDef

DescribeAlarmsForMetricInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmsForMetricInputRequestTypeDef

def get_value() -> DescribeAlarmsForMetricInputRequestTypeDef:
    return {
        "MetricName": ...,
        "Namespace": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAnomalyDetectorsInputRequestTypeDef

def get_value() -> DescribeAnomalyDetectorsInputRequestTypeDef:
    return {
        "NextToken": ...,
    }

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

GetMetricStatisticsInputMetricGetStatisticsTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricStatisticsInputMetricGetStatisticsTypeDef

def get_value() -> GetMetricStatisticsInputMetricGetStatisticsTypeDef:
    return {
        "StartTime": ...,
        "EndTime": ...,
        "Period": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricStatisticsInputRequestTypeDef

def get_value() -> GetMetricStatisticsInputRequestTypeDef:
    return {
        "Namespace": ...,
        "MetricName": ...,
        "StartTime": ...,
        "EndTime": ...,
        "Period": ...,
    }

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

MetricTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricTypeDef

def get_value() -> MetricTypeDef:
    return {
        "Namespace": ...,
    }

Definition

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

1. See DimensionTypeDef

SingleMetricAnomalyDetectorTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import SingleMetricAnomalyDetectorTypeDef

def get_value() -> SingleMetricAnomalyDetectorTypeDef:
    return {
        "Namespace": ...,
    }

Definition

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

1. See DimensionTypeDef

DeleteInsightRulesOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DeleteInsightRulesOutputTypeDef

def get_value() -> DeleteInsightRulesOutputTypeDef:
    return {
        "Failures": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PartialFailureTypeDef
2. See ResponseMetadataTypeDef

DescribeAlarmHistoryOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmHistoryOutputTypeDef

def get_value() -> DescribeAlarmHistoryOutputTypeDef:
    return {
        "AlarmHistoryItems": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AlarmHistoryItemTypeDef
2. See ResponseMetadataTypeDef

DisableInsightRulesOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DisableInsightRulesOutputTypeDef

def get_value() -> DisableInsightRulesOutputTypeDef:
    return {
        "Failures": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PartialFailureTypeDef
2. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

EnableInsightRulesOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import EnableInsightRulesOutputTypeDef

def get_value() -> EnableInsightRulesOutputTypeDef:
    return {
        "Failures": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PartialFailureTypeDef
2. See ResponseMetadataTypeDef

GetDashboardOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetDashboardOutputTypeDef

def get_value() -> GetDashboardOutputTypeDef:
    return {
        "DashboardArn": ...,
        "DashboardBody": ...,
        "DashboardName": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

GetMetricStatisticsOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricStatisticsOutputTypeDef

def get_value() -> GetMetricStatisticsOutputTypeDef:
    return {
        "Label": ...,
        "Datapoints": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DatapointTypeDef
2. See ResponseMetadataTypeDef

GetMetricWidgetImageOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricWidgetImageOutputTypeDef

def get_value() -> GetMetricWidgetImageOutputTypeDef:
    return {
        "MetricWidgetImage": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

ListDashboardsOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListDashboardsOutputTypeDef

def get_value() -> ListDashboardsOutputTypeDef:
    return {
        "DashboardEntries": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DashboardEntryTypeDef
2. See ResponseMetadataTypeDef

PutDashboardOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutDashboardOutputTypeDef

def get_value() -> PutDashboardOutputTypeDef:
    return {
        "DashboardValidationMessages": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See DashboardValidationMessageTypeDef
2. See ResponseMetadataTypeDef

PutManagedInsightRulesOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutManagedInsightRulesOutputTypeDef

def get_value() -> PutManagedInsightRulesOutputTypeDef:
    return {
        "Failures": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See PartialFailureTypeDef
2. See ResponseMetadataTypeDef

PutMetricStreamOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutMetricStreamOutputTypeDef

def get_value() -> PutMetricStreamOutputTypeDef:
    return {
        "Arn": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ResponseMetadataTypeDef

DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef

def get_value() -> DescribeAlarmHistoryInputDescribeAlarmHistoryPaginateTypeDef:
    return {
        "AlarmName": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmsInputDescribeAlarmsPaginateTypeDef

def get_value() -> DescribeAlarmsInputDescribeAlarmsPaginateTypeDef:
    return {
        "AlarmNames": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAnomalyDetectorsInputDescribeAnomalyDetectorsPaginateTypeDef

def get_value() -> DescribeAnomalyDetectorsInputDescribeAnomalyDetectorsPaginateTypeDef:
    return {
        "Namespace": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListDashboardsInputListDashboardsPaginateTypeDef

def get_value() -> ListDashboardsInputListDashboardsPaginateTypeDef:
    return {
        "DashboardNamePrefix": ...,
    }

Definition

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

1. See PaginatorConfigTypeDef

DescribeAlarmsInputAlarmExistsWaitTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmsInputAlarmExistsWaitTypeDef

def get_value() -> DescribeAlarmsInputAlarmExistsWaitTypeDef:
    return {
        "AlarmNames": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmsInputCompositeAlarmExistsWaitTypeDef

def get_value() -> DescribeAlarmsInputCompositeAlarmExistsWaitTypeDef:
    return {
        "AlarmNames": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeInsightRulesOutputTypeDef

def get_value() -> DescribeInsightRulesOutputTypeDef:
    return {
        "NextToken": ...,
        "InsightRules": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See InsightRuleTypeDef
2. See ResponseMetadataTypeDef

ListMetricsInputListMetricsPaginateTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListMetricsInputListMetricsPaginateTypeDef

def get_value() -> ListMetricsInputListMetricsPaginateTypeDef:
    return {
        "Namespace": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListMetricsInputRequestTypeDef

def get_value() -> ListMetricsInputRequestTypeDef:
    return {
        "Namespace": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricDataResultTypeDef

def get_value() -> MetricDataResultTypeDef:
    return {
        "Id": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import InsightRuleContributorTypeDef

def get_value() -> InsightRuleContributorTypeDef:
    return {
        "Keys": ...,
        "ApproximateAggregateValue": ...,
        "Datapoints": ...,
    }

Definition

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

1. See InsightRuleContributorDatapointTypeDef

ListMetricStreamsOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListMetricStreamsOutputTypeDef

def get_value() -> ListMetricStreamsOutputTypeDef:
    return {
        "NextToken": ...,
        "Entries": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See MetricStreamEntryTypeDef
2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListTagsForResourceOutputTypeDef

def get_value() -> ListTagsForResourceOutputTypeDef:
    return {
        "Tags": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See TagTypeDef
2. See ResponseMetadataTypeDef

ManagedRuleTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ManagedRuleTypeDef

def get_value() -> ManagedRuleTypeDef:
    return {
        "TemplateName": ...,
        "ResourceARN": ...,
    }

Definition

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

1. See TagTypeDef

PutCompositeAlarmInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutCompositeAlarmInputRequestTypeDef

def get_value() -> PutCompositeAlarmInputRequestTypeDef:
    return {
        "AlarmName": ...,
        "AlarmRule": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutInsightRuleInputRequestTypeDef

def get_value() -> PutInsightRuleInputRequestTypeDef:
    return {
        "RuleName": ...,
        "RuleDefinition": ...,
    }

Definition

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

1. See TagTypeDef

TagResourceInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import TagResourceInputRequestTypeDef

def get_value() -> TagResourceInputRequestTypeDef:
    return {
        "ResourceARN": ...,
        "Tags": ...,
    }

Definition

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

1. See TagTypeDef

ManagedRuleDescriptionTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ManagedRuleDescriptionTypeDef

def get_value() -> ManagedRuleDescriptionTypeDef:
    return {
        "TemplateName": ...,
    }

Definition

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

1. See ManagedRuleStateTypeDef

MetricDatumTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricDatumTypeDef

def get_value() -> MetricDatumTypeDef:
    return {
        "MetricName": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricStreamStatisticsConfigurationTypeDef

def get_value() -> MetricStreamStatisticsConfigurationTypeDef:
    return {
        "IncludeMetrics": ...,
        "AdditionalStatistics": ...,
    }

Definition

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

1. See MetricStreamStatisticsMetricTypeDef

ListMetricsOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListMetricsOutputTypeDef

def get_value() -> ListMetricsOutputTypeDef:
    return {
        "Metrics": ...,
        "NextToken": ...,
        "OwningAccounts": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See MetricTypeDef
2. See ResponseMetadataTypeDef

MetricStatTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricStatTypeDef

def get_value() -> MetricStatTypeDef:
    return {
        "Metric": ...,
        "Period": ...,
        "Stat": ...,
    }

Definition

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

1. See MetricTypeDef
2. See StandardUnitType

GetMetricDataOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricDataOutputTypeDef

def get_value() -> GetMetricDataOutputTypeDef:
    return {
        "MetricDataResults": ...,
        "NextToken": ...,
        "Messages": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetInsightRuleReportOutputTypeDef

def get_value() -> GetInsightRuleReportOutputTypeDef:
    return {
        "KeyLabels": ...,
        "AggregationStatistic": ...,
        "AggregateValue": ...,
        "ApproximateUniqueCount": ...,
        "Contributors": ...,
        "MetricDatapoints": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutManagedInsightRulesInputRequestTypeDef

def get_value() -> PutManagedInsightRulesInputRequestTypeDef:
    return {
        "ManagedRules": ...,
    }

Definition

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

1. See ManagedRuleTypeDef

ListManagedInsightRulesOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import ListManagedInsightRulesOutputTypeDef

def get_value() -> ListManagedInsightRulesOutputTypeDef:
    return {
        "ManagedRules": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See ManagedRuleDescriptionTypeDef
2. See ResponseMetadataTypeDef

PutMetricDataInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutMetricDataInputRequestTypeDef

def get_value() -> PutMetricDataInputRequestTypeDef:
    return {
        "Namespace": ...,
        "MetricData": ...,
    }

Definition

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

1. See MetricDatumTypeDef

GetMetricStreamOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricStreamOutputTypeDef

def get_value() -> GetMetricStreamOutputTypeDef:
    return {
        "Arn": ...,
        "Name": ...,
        "IncludeFilters": ...,
        "ExcludeFilters": ...,
        "FirehoseArn": ...,
        "RoleArn": ...,
        "State": ...,
        "CreationDate": ...,
        "LastUpdateDate": ...,
        "OutputFormat": ...,
        "StatisticsConfigurations": ...,
        "IncludeLinkedAccountsMetrics": ...,
        "ResponseMetadata": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutMetricStreamInputRequestTypeDef

def get_value() -> PutMetricStreamInputRequestTypeDef:
    return {
        "Name": ...,
        "FirehoseArn": ...,
        "RoleArn": ...,
        "OutputFormat": ...,
    }

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

MetricDataQueryTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricDataQueryTypeDef

def get_value() -> MetricDataQueryTypeDef:
    return {
        "Id": ...,
    }

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

GetMetricDataInputGetMetricDataPaginateTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricDataInputGetMetricDataPaginateTypeDef

def get_value() -> GetMetricDataInputGetMetricDataPaginateTypeDef:
    return {
        "MetricDataQueries": ...,
        "StartTime": ...,
        "EndTime": ...,
    }

Definition

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

1. See MetricDataQueryTypeDef
2. See ScanByType
3. See LabelOptionsTypeDef
4. See PaginatorConfigTypeDef

GetMetricDataInputRequestTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import GetMetricDataInputRequestTypeDef

def get_value() -> GetMetricDataInputRequestTypeDef:
    return {
        "MetricDataQueries": ...,
        "StartTime": ...,
        "EndTime": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricAlarmTypeDef

def get_value() -> MetricAlarmTypeDef:
    return {
        "AlarmName": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import MetricMathAnomalyDetectorTypeDef

def get_value() -> MetricMathAnomalyDetectorTypeDef:
    return {
        "MetricDataQueries": ...,
    }

Definition

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

1. See MetricDataQueryTypeDef

PutMetricAlarmInputMetricPutAlarmTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutMetricAlarmInputMetricPutAlarmTypeDef

def get_value() -> PutMetricAlarmInputMetricPutAlarmTypeDef:
    return {
        "AlarmName": ...,
        "EvaluationPeriods": ...,
        "ComparisonOperator": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutMetricAlarmInputRequestTypeDef

def get_value() -> PutMetricAlarmInputRequestTypeDef:
    return {
        "AlarmName": ...,
        "EvaluationPeriods": ...,
        "ComparisonOperator": ...,
    }

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

DescribeAlarmsForMetricOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmsForMetricOutputTypeDef

def get_value() -> DescribeAlarmsForMetricOutputTypeDef:
    return {
        "MetricAlarms": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See MetricAlarmTypeDef
2. See ResponseMetadataTypeDef

DescribeAlarmsOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAlarmsOutputTypeDef

def get_value() -> DescribeAlarmsOutputTypeDef:
    return {
        "CompositeAlarms": ...,
        "MetricAlarms": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

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

AnomalyDetectorTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import AnomalyDetectorTypeDef

def get_value() -> AnomalyDetectorTypeDef:
    return {
        "Namespace": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import DeleteAnomalyDetectorInputRequestTypeDef

def get_value() -> DeleteAnomalyDetectorInputRequestTypeDef:
    return {
        "Namespace": ...,
    }

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

Usage Example

from mypy_boto3_cloudwatch.type_defs import PutAnomalyDetectorInputRequestTypeDef

def get_value() -> PutAnomalyDetectorInputRequestTypeDef:
    return {
        "Namespace": ...,
    }

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

DescribeAnomalyDetectorsOutputTypeDef

Usage Example

from mypy_boto3_cloudwatch.type_defs import DescribeAnomalyDetectorsOutputTypeDef

def get_value() -> DescribeAnomalyDetectorsOutputTypeDef:
    return {
        "AnomalyDetectors": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

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

1. See AnomalyDetectorTypeDef
2. See ResponseMetadataTypeDef