Type definitions#
Index > CloudWatch > Type definitions
Auto-generated documentation for CloudWatch type annotations stubs module types-boto3-cloudwatch.
TimestampTypeDef#
# TimestampTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import TimestampTypeDef
def get_value() -> TimestampTypeDef:
return ...
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
MetricStreamFilterUnionTypeDef#
# MetricStreamFilterUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import MetricStreamFilterUnionTypeDef
def get_value() -> MetricStreamFilterUnionTypeDef:
return ...
# MetricStreamFilterUnionTypeDef definition
MetricStreamFilterUnionTypeDef = Union[
MetricStreamFilterTypeDef, # (1)
MetricStreamFilterOutputTypeDef, # (2)
]
MetricUnionTypeDef#
# MetricUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import MetricUnionTypeDef
def get_value() -> MetricUnionTypeDef:
return ...
# MetricUnionTypeDef definition
MetricUnionTypeDef = Union[
MetricTypeDef, # (1)
MetricOutputTypeDef, # (2)
]
- See MetricTypeDef
- See MetricOutputTypeDef
SingleMetricAnomalyDetectorUnionTypeDef#
# SingleMetricAnomalyDetectorUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import SingleMetricAnomalyDetectorUnionTypeDef
def get_value() -> SingleMetricAnomalyDetectorUnionTypeDef:
return ...
# SingleMetricAnomalyDetectorUnionTypeDef definition
SingleMetricAnomalyDetectorUnionTypeDef = Union[
SingleMetricAnomalyDetectorTypeDef, # (1)
SingleMetricAnomalyDetectorOutputTypeDef, # (2)
]
MetricStreamStatisticsConfigurationUnionTypeDef#
# MetricStreamStatisticsConfigurationUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import MetricStreamStatisticsConfigurationUnionTypeDef
def get_value() -> MetricStreamStatisticsConfigurationUnionTypeDef:
return ...
# MetricStreamStatisticsConfigurationUnionTypeDef definition
MetricStreamStatisticsConfigurationUnionTypeDef = Union[
MetricStreamStatisticsConfigurationTypeDef, # (1)
MetricStreamStatisticsConfigurationOutputTypeDef, # (2)
]
AnomalyDetectorConfigurationUnionTypeDef#
# AnomalyDetectorConfigurationUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import AnomalyDetectorConfigurationUnionTypeDef
def get_value() -> AnomalyDetectorConfigurationUnionTypeDef:
return ...
# AnomalyDetectorConfigurationUnionTypeDef definition
AnomalyDetectorConfigurationUnionTypeDef = Union[
AnomalyDetectorConfigurationTypeDef, # (1)
AnomalyDetectorConfigurationOutputTypeDef, # (2)
]
MetricStatUnionTypeDef#
# MetricStatUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import MetricStatUnionTypeDef
def get_value() -> MetricStatUnionTypeDef:
return ...
# MetricStatUnionTypeDef definition
MetricStatUnionTypeDef = Union[
MetricStatTypeDef, # (1)
MetricStatOutputTypeDef, # (2)
]
MetricDataQueryUnionTypeDef#
# MetricDataQueryUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import MetricDataQueryUnionTypeDef
def get_value() -> MetricDataQueryUnionTypeDef:
return ...
# MetricDataQueryUnionTypeDef definition
MetricDataQueryUnionTypeDef = Union[
MetricDataQueryTypeDef, # (1)
MetricDataQueryOutputTypeDef, # (2)
]
MetricMathAnomalyDetectorUnionTypeDef#
# MetricMathAnomalyDetectorUnionTypeDef Union usage example
from types_boto3_cloudwatch.type_defs import MetricMathAnomalyDetectorUnionTypeDef
def get_value() -> MetricMathAnomalyDetectorUnionTypeDef:
return ...
# MetricMathAnomalyDetectorUnionTypeDef definition
MetricMathAnomalyDetectorUnionTypeDef = Union[
MetricMathAnomalyDetectorTypeDef, # (1)
MetricMathAnomalyDetectorOutputTypeDef, # (2)
]
AlarmHistoryItemTypeDef#
# AlarmHistoryItemTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import AlarmHistoryItemTypeDef
def get_value() -> AlarmHistoryItemTypeDef:
return {
"AlarmName": ...,
}
# 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],
- See AlarmTypeType
- See HistoryItemTypeType
RangeOutputTypeDef#
# RangeOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import RangeOutputTypeDef
def get_value() -> RangeOutputTypeDef:
return {
"StartTime": ...,
}
# RangeOutputTypeDef definition
class RangeOutputTypeDef(TypedDict):
StartTime: datetime,
EndTime: datetime,
DimensionTypeDef#
# DimensionTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DimensionTypeDef
def get_value() -> DimensionTypeDef:
return {
"Name": ...,
}
# DimensionTypeDef definition
class DimensionTypeDef(TypedDict):
Name: str,
Value: str,
MetricCharacteristicsTypeDef#
# MetricCharacteristicsTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricCharacteristicsTypeDef
def get_value() -> MetricCharacteristicsTypeDef:
return {
"PeriodicSpikes": ...,
}
# MetricCharacteristicsTypeDef definition
class MetricCharacteristicsTypeDef(TypedDict):
PeriodicSpikes: NotRequired[bool],
CloudwatchEventStateTypeDef#
# CloudwatchEventStateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CloudwatchEventStateTypeDef
def get_value() -> CloudwatchEventStateTypeDef:
return {
"reason": ...,
}
# CloudwatchEventStateTypeDef definition
class CloudwatchEventStateTypeDef(TypedDict):
timestamp: str,
value: str,
reason: NotRequired[str],
reasonData: NotRequired[str],
actionsSuppressedBy: NotRequired[str],
actionsSuppressedReason: NotRequired[str],
CloudwatchEventMetricStatsMetricTypeDef#
# CloudwatchEventMetricStatsMetricTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CloudwatchEventMetricStatsMetricTypeDef
def get_value() -> CloudwatchEventMetricStatsMetricTypeDef:
return {
"metricName": ...,
}
# CloudwatchEventMetricStatsMetricTypeDef definition
class CloudwatchEventMetricStatsMetricTypeDef(TypedDict):
metricName: str,
namespace: str,
dimensions: Dict[str, str],
CompositeAlarmTypeDef#
# CompositeAlarmTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CompositeAlarmTypeDef
def get_value() -> CompositeAlarmTypeDef:
return {
"ActionsEnabled": ...,
}
# 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],
DashboardEntryTypeDef#
# DashboardEntryTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DashboardEntryTypeDef
def get_value() -> DashboardEntryTypeDef:
return {
"DashboardName": ...,
}
# DashboardEntryTypeDef definition
class DashboardEntryTypeDef(TypedDict):
DashboardName: NotRequired[str],
DashboardArn: NotRequired[str],
LastModified: NotRequired[datetime],
Size: NotRequired[int],
DashboardValidationMessageTypeDef#
# DashboardValidationMessageTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DashboardValidationMessageTypeDef
def get_value() -> DashboardValidationMessageTypeDef:
return {
"DataPath": ...,
}
# DashboardValidationMessageTypeDef definition
class DashboardValidationMessageTypeDef(TypedDict):
DataPath: NotRequired[str],
Message: NotRequired[str],
DatapointTypeDef#
# DatapointTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DatapointTypeDef
def get_value() -> DatapointTypeDef:
return {
"Timestamp": ...,
}
# 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]],
- See StandardUnitType
DeleteAlarmsInputTypeDef#
# DeleteAlarmsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DeleteAlarmsInputTypeDef
def get_value() -> DeleteAlarmsInputTypeDef:
return {
"AlarmNames": ...,
}
# DeleteAlarmsInputTypeDef definition
class DeleteAlarmsInputTypeDef(TypedDict):
AlarmNames: Sequence[str],
DeleteDashboardsInputTypeDef#
# DeleteDashboardsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DeleteDashboardsInputTypeDef
def get_value() -> DeleteDashboardsInputTypeDef:
return {
"DashboardNames": ...,
}
# DeleteDashboardsInputTypeDef definition
class DeleteDashboardsInputTypeDef(TypedDict):
DashboardNames: Sequence[str],
DeleteInsightRulesInputTypeDef#
# DeleteInsightRulesInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DeleteInsightRulesInputTypeDef
def get_value() -> DeleteInsightRulesInputTypeDef:
return {
"RuleNames": ...,
}
# DeleteInsightRulesInputTypeDef definition
class DeleteInsightRulesInputTypeDef(TypedDict):
RuleNames: Sequence[str],
PartialFailureTypeDef#
# PartialFailureTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PartialFailureTypeDef
def get_value() -> PartialFailureTypeDef:
return {
"FailureResource": ...,
}
# PartialFailureTypeDef definition
class PartialFailureTypeDef(TypedDict):
FailureResource: NotRequired[str],
ExceptionType: NotRequired[str],
FailureCode: NotRequired[str],
FailureDescription: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
DeleteMetricStreamInputTypeDef#
# DeleteMetricStreamInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DeleteMetricStreamInputTypeDef
def get_value() -> DeleteMetricStreamInputTypeDef:
return {
"Name": ...,
}
# DeleteMetricStreamInputTypeDef definition
class DeleteMetricStreamInputTypeDef(TypedDict):
Name: str,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeAlarmsInputTypeDef#
# DescribeAlarmsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmsInputTypeDef
def get_value() -> DescribeAlarmsInputTypeDef:
return {
"AlarmNames": ...,
}
# DescribeAlarmsInputTypeDef definition
class DescribeAlarmsInputTypeDef(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],
- See AlarmTypeType
- See StateValueType
WaiterConfigTypeDef#
# WaiterConfigTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import WaiterConfigTypeDef
def get_value() -> WaiterConfigTypeDef:
return {
"Delay": ...,
}
# WaiterConfigTypeDef definition
class WaiterConfigTypeDef(TypedDict):
Delay: NotRequired[int],
MaxAttempts: NotRequired[int],
DescribeInsightRulesInputTypeDef#
# DescribeInsightRulesInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeInsightRulesInputTypeDef
def get_value() -> DescribeInsightRulesInputTypeDef:
return {
"NextToken": ...,
}
# DescribeInsightRulesInputTypeDef definition
class DescribeInsightRulesInputTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
InsightRuleTypeDef#
# InsightRuleTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import InsightRuleTypeDef
def get_value() -> InsightRuleTypeDef:
return {
"Name": ...,
}
# InsightRuleTypeDef definition
class InsightRuleTypeDef(TypedDict):
Name: str,
State: str,
Schema: str,
Definition: str,
ManagedRule: NotRequired[bool],
DimensionFilterTypeDef#
# DimensionFilterTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DimensionFilterTypeDef
def get_value() -> DimensionFilterTypeDef:
return {
"Name": ...,
}
# DimensionFilterTypeDef definition
class DimensionFilterTypeDef(TypedDict):
Name: str,
Value: NotRequired[str],
DisableAlarmActionsInputTypeDef#
# DisableAlarmActionsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DisableAlarmActionsInputTypeDef
def get_value() -> DisableAlarmActionsInputTypeDef:
return {
"AlarmNames": ...,
}
# DisableAlarmActionsInputTypeDef definition
class DisableAlarmActionsInputTypeDef(TypedDict):
AlarmNames: Sequence[str],
DisableInsightRulesInputTypeDef#
# DisableInsightRulesInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DisableInsightRulesInputTypeDef
def get_value() -> DisableInsightRulesInputTypeDef:
return {
"RuleNames": ...,
}
# DisableInsightRulesInputTypeDef definition
class DisableInsightRulesInputTypeDef(TypedDict):
RuleNames: Sequence[str],
EnableAlarmActionsInputTypeDef#
# EnableAlarmActionsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import EnableAlarmActionsInputTypeDef
def get_value() -> EnableAlarmActionsInputTypeDef:
return {
"AlarmNames": ...,
}
# EnableAlarmActionsInputTypeDef definition
class EnableAlarmActionsInputTypeDef(TypedDict):
AlarmNames: Sequence[str],
EnableInsightRulesInputTypeDef#
# EnableInsightRulesInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import EnableInsightRulesInputTypeDef
def get_value() -> EnableInsightRulesInputTypeDef:
return {
"RuleNames": ...,
}
# EnableInsightRulesInputTypeDef definition
class EnableInsightRulesInputTypeDef(TypedDict):
RuleNames: Sequence[str],
EntityTypeDef#
# EntityTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import EntityTypeDef
def get_value() -> EntityTypeDef:
return {
"KeyAttributes": ...,
}
# EntityTypeDef definition
class EntityTypeDef(TypedDict):
KeyAttributes: NotRequired[Mapping[str, str]],
Attributes: NotRequired[Mapping[str, str]],
GetDashboardInputTypeDef#
# GetDashboardInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetDashboardInputTypeDef
def get_value() -> GetDashboardInputTypeDef:
return {
"DashboardName": ...,
}
# GetDashboardInputTypeDef definition
class GetDashboardInputTypeDef(TypedDict):
DashboardName: str,
InsightRuleMetricDatapointTypeDef#
# InsightRuleMetricDatapointTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import InsightRuleMetricDatapointTypeDef
def get_value() -> InsightRuleMetricDatapointTypeDef:
return {
"Timestamp": ...,
}
# 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 TypedDict usage example
from types_boto3_cloudwatch.type_defs import LabelOptionsTypeDef
def get_value() -> LabelOptionsTypeDef:
return {
"Timezone": ...,
}
# LabelOptionsTypeDef definition
class LabelOptionsTypeDef(TypedDict):
Timezone: NotRequired[str],
MessageDataTypeDef#
# MessageDataTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MessageDataTypeDef
def get_value() -> MessageDataTypeDef:
return {
"Code": ...,
}
# MessageDataTypeDef definition
class MessageDataTypeDef(TypedDict):
Code: NotRequired[str],
Value: NotRequired[str],
GetMetricStreamInputTypeDef#
# GetMetricStreamInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricStreamInputTypeDef
def get_value() -> GetMetricStreamInputTypeDef:
return {
"Name": ...,
}
# GetMetricStreamInputTypeDef definition
class GetMetricStreamInputTypeDef(TypedDict):
Name: str,
MetricStreamFilterOutputTypeDef#
# MetricStreamFilterOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStreamFilterOutputTypeDef
def get_value() -> MetricStreamFilterOutputTypeDef:
return {
"Namespace": ...,
}
# MetricStreamFilterOutputTypeDef definition
class MetricStreamFilterOutputTypeDef(TypedDict):
Namespace: NotRequired[str],
MetricNames: NotRequired[List[str]],
GetMetricWidgetImageInputTypeDef#
# GetMetricWidgetImageInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricWidgetImageInputTypeDef
def get_value() -> GetMetricWidgetImageInputTypeDef:
return {
"MetricWidget": ...,
}
# GetMetricWidgetImageInputTypeDef definition
class GetMetricWidgetImageInputTypeDef(TypedDict):
MetricWidget: str,
OutputFormat: NotRequired[str],
InsightRuleContributorDatapointTypeDef#
# InsightRuleContributorDatapointTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import InsightRuleContributorDatapointTypeDef
def get_value() -> InsightRuleContributorDatapointTypeDef:
return {
"Timestamp": ...,
}
# InsightRuleContributorDatapointTypeDef definition
class InsightRuleContributorDatapointTypeDef(TypedDict):
Timestamp: datetime,
ApproximateValue: float,
ListDashboardsInputTypeDef#
# ListDashboardsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListDashboardsInputTypeDef
def get_value() -> ListDashboardsInputTypeDef:
return {
"DashboardNamePrefix": ...,
}
# ListDashboardsInputTypeDef definition
class ListDashboardsInputTypeDef(TypedDict):
DashboardNamePrefix: NotRequired[str],
NextToken: NotRequired[str],
ListManagedInsightRulesInputTypeDef#
# ListManagedInsightRulesInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListManagedInsightRulesInputTypeDef
def get_value() -> ListManagedInsightRulesInputTypeDef:
return {
"ResourceARN": ...,
}
# ListManagedInsightRulesInputTypeDef definition
class ListManagedInsightRulesInputTypeDef(TypedDict):
ResourceARN: str,
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
ListMetricStreamsInputTypeDef#
# ListMetricStreamsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListMetricStreamsInputTypeDef
def get_value() -> ListMetricStreamsInputTypeDef:
return {
"NextToken": ...,
}
# ListMetricStreamsInputTypeDef definition
class ListMetricStreamsInputTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
MetricStreamEntryTypeDef#
# MetricStreamEntryTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStreamEntryTypeDef
def get_value() -> MetricStreamEntryTypeDef:
return {
"Arn": ...,
}
# 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)
ListTagsForResourceInputTypeDef#
# ListTagsForResourceInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListTagsForResourceInputTypeDef
def get_value() -> ListTagsForResourceInputTypeDef:
return {
"ResourceARN": ...,
}
# ListTagsForResourceInputTypeDef definition
class ListTagsForResourceInputTypeDef(TypedDict):
ResourceARN: str,
TagTypeDef#
# TagTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"Key": ...,
}
# TagTypeDef definition
class TagTypeDef(TypedDict):
Key: str,
Value: str,
ManagedRuleStateTypeDef#
# ManagedRuleStateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ManagedRuleStateTypeDef
def get_value() -> ManagedRuleStateTypeDef:
return {
"RuleName": ...,
}
# ManagedRuleStateTypeDef definition
class ManagedRuleStateTypeDef(TypedDict):
RuleName: str,
State: str,
StatisticSetTypeDef#
# StatisticSetTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import StatisticSetTypeDef
def get_value() -> StatisticSetTypeDef:
return {
"SampleCount": ...,
}
# StatisticSetTypeDef definition
class StatisticSetTypeDef(TypedDict):
SampleCount: float,
Sum: float,
Minimum: float,
Maximum: float,
MetricStreamFilterTypeDef#
# MetricStreamFilterTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStreamFilterTypeDef
def get_value() -> MetricStreamFilterTypeDef:
return {
"Namespace": ...,
}
# MetricStreamFilterTypeDef definition
class MetricStreamFilterTypeDef(TypedDict):
Namespace: NotRequired[str],
MetricNames: NotRequired[Sequence[str]],
MetricStreamStatisticsMetricTypeDef#
# MetricStreamStatisticsMetricTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStreamStatisticsMetricTypeDef
def get_value() -> MetricStreamStatisticsMetricTypeDef:
return {
"Namespace": ...,
}
# MetricStreamStatisticsMetricTypeDef definition
class MetricStreamStatisticsMetricTypeDef(TypedDict):
Namespace: str,
MetricName: str,
PutDashboardInputTypeDef#
# PutDashboardInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutDashboardInputTypeDef
def get_value() -> PutDashboardInputTypeDef:
return {
"DashboardName": ...,
}
# PutDashboardInputTypeDef definition
class PutDashboardInputTypeDef(TypedDict):
DashboardName: str,
DashboardBody: str,
SetAlarmStateInputAlarmSetStateTypeDef#
# SetAlarmStateInputAlarmSetStateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import SetAlarmStateInputAlarmSetStateTypeDef
def get_value() -> SetAlarmStateInputAlarmSetStateTypeDef:
return {
"StateValue": ...,
}
# SetAlarmStateInputAlarmSetStateTypeDef definition
class SetAlarmStateInputAlarmSetStateTypeDef(TypedDict):
StateValue: StateValueType, # (1)
StateReason: str,
StateReasonData: NotRequired[str],
- See StateValueType
SetAlarmStateInputTypeDef#
# SetAlarmStateInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import SetAlarmStateInputTypeDef
def get_value() -> SetAlarmStateInputTypeDef:
return {
"AlarmName": ...,
}
# SetAlarmStateInputTypeDef definition
class SetAlarmStateInputTypeDef(TypedDict):
AlarmName: str,
StateValue: StateValueType, # (1)
StateReason: str,
StateReasonData: NotRequired[str],
- See StateValueType
StartMetricStreamsInputTypeDef#
# StartMetricStreamsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import StartMetricStreamsInputTypeDef
def get_value() -> StartMetricStreamsInputTypeDef:
return {
"Names": ...,
}
# StartMetricStreamsInputTypeDef definition
class StartMetricStreamsInputTypeDef(TypedDict):
Names: Sequence[str],
StopMetricStreamsInputTypeDef#
# StopMetricStreamsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import StopMetricStreamsInputTypeDef
def get_value() -> StopMetricStreamsInputTypeDef:
return {
"Names": ...,
}
# StopMetricStreamsInputTypeDef definition
class StopMetricStreamsInputTypeDef(TypedDict):
Names: Sequence[str],
UntagResourceInputTypeDef#
# UntagResourceInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import UntagResourceInputTypeDef
def get_value() -> UntagResourceInputTypeDef:
return {
"ResourceARN": ...,
}
# UntagResourceInputTypeDef definition
class UntagResourceInputTypeDef(TypedDict):
ResourceARN: str,
TagKeys: Sequence[str],
AnomalyDetectorConfigurationOutputTypeDef#
# AnomalyDetectorConfigurationOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import AnomalyDetectorConfigurationOutputTypeDef
def get_value() -> AnomalyDetectorConfigurationOutputTypeDef:
return {
"ExcludedTimeRanges": ...,
}
# AnomalyDetectorConfigurationOutputTypeDef definition
class AnomalyDetectorConfigurationOutputTypeDef(TypedDict):
ExcludedTimeRanges: NotRequired[List[RangeOutputTypeDef]], # (1)
MetricTimezone: NotRequired[str],
DescribeAlarmsForMetricInputTypeDef#
# DescribeAlarmsForMetricInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmsForMetricInputTypeDef
def get_value() -> DescribeAlarmsForMetricInputTypeDef:
return {
"MetricName": ...,
}
# DescribeAlarmsForMetricInputTypeDef definition
class DescribeAlarmsForMetricInputTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: NotRequired[StatisticType], # (1)
ExtendedStatistic: NotRequired[str],
Dimensions: NotRequired[Sequence[DimensionTypeDef]], # (2)
Period: NotRequired[int],
Unit: NotRequired[StandardUnitType], # (3)
- See StatisticType
- See DimensionTypeDef
- See StandardUnitType
DescribeAnomalyDetectorsInputTypeDef#
# DescribeAnomalyDetectorsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAnomalyDetectorsInputTypeDef
def get_value() -> DescribeAnomalyDetectorsInputTypeDef:
return {
"NextToken": ...,
}
# DescribeAnomalyDetectorsInputTypeDef definition
class DescribeAnomalyDetectorsInputTypeDef(TypedDict):
NextToken: NotRequired[str],
MaxResults: NotRequired[int],
Namespace: NotRequired[str],
MetricName: NotRequired[str],
Dimensions: NotRequired[Sequence[DimensionTypeDef]], # (1)
AnomalyDetectorTypes: NotRequired[Sequence[AnomalyDetectorTypeType]], # (2)
MetricOutputTypeDef#
# MetricOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricOutputTypeDef
def get_value() -> MetricOutputTypeDef:
return {
"Namespace": ...,
}
# MetricOutputTypeDef definition
class MetricOutputTypeDef(TypedDict):
Namespace: NotRequired[str],
MetricName: NotRequired[str],
Dimensions: NotRequired[List[DimensionTypeDef]], # (1)
- See DimensionTypeDef
MetricTypeDef#
# MetricTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricTypeDef
def get_value() -> MetricTypeDef:
return {
"Namespace": ...,
}
# MetricTypeDef definition
class MetricTypeDef(TypedDict):
Namespace: NotRequired[str],
MetricName: NotRequired[str],
Dimensions: NotRequired[Sequence[DimensionTypeDef]], # (1)
- See DimensionTypeDef
SingleMetricAnomalyDetectorOutputTypeDef#
# SingleMetricAnomalyDetectorOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import SingleMetricAnomalyDetectorOutputTypeDef
def get_value() -> SingleMetricAnomalyDetectorOutputTypeDef:
return {
"AccountId": ...,
}
# SingleMetricAnomalyDetectorOutputTypeDef definition
class SingleMetricAnomalyDetectorOutputTypeDef(TypedDict):
AccountId: NotRequired[str],
Namespace: NotRequired[str],
MetricName: NotRequired[str],
Dimensions: NotRequired[List[DimensionTypeDef]], # (1)
Stat: NotRequired[str],
- See DimensionTypeDef
SingleMetricAnomalyDetectorTypeDef#
# SingleMetricAnomalyDetectorTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import SingleMetricAnomalyDetectorTypeDef
def get_value() -> SingleMetricAnomalyDetectorTypeDef:
return {
"AccountId": ...,
}
# SingleMetricAnomalyDetectorTypeDef definition
class SingleMetricAnomalyDetectorTypeDef(TypedDict):
AccountId: NotRequired[str],
Namespace: NotRequired[str],
MetricName: NotRequired[str],
Dimensions: NotRequired[Sequence[DimensionTypeDef]], # (1)
Stat: NotRequired[str],
- See DimensionTypeDef
CloudwatchEventMetricStatsTypeDef#
# CloudwatchEventMetricStatsTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CloudwatchEventMetricStatsTypeDef
def get_value() -> CloudwatchEventMetricStatsTypeDef:
return {
"metric": ...,
}
# CloudwatchEventMetricStatsTypeDef definition
class CloudwatchEventMetricStatsTypeDef(TypedDict):
period: str,
stat: str,
metric: NotRequired[CloudwatchEventMetricStatsMetricTypeDef], # (1)
DeleteInsightRulesOutputTypeDef#
# DeleteInsightRulesOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DeleteInsightRulesOutputTypeDef
def get_value() -> DeleteInsightRulesOutputTypeDef:
return {
"Failures": ...,
}
# DeleteInsightRulesOutputTypeDef definition
class DeleteInsightRulesOutputTypeDef(TypedDict):
Failures: List[PartialFailureTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAlarmHistoryOutputTypeDef#
# DescribeAlarmHistoryOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmHistoryOutputTypeDef
def get_value() -> DescribeAlarmHistoryOutputTypeDef:
return {
"AlarmHistoryItems": ...,
}
# DescribeAlarmHistoryOutputTypeDef definition
class DescribeAlarmHistoryOutputTypeDef(TypedDict):
AlarmHistoryItems: List[AlarmHistoryItemTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
DisableInsightRulesOutputTypeDef#
# DisableInsightRulesOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DisableInsightRulesOutputTypeDef
def get_value() -> DisableInsightRulesOutputTypeDef:
return {
"Failures": ...,
}
# DisableInsightRulesOutputTypeDef definition
class DisableInsightRulesOutputTypeDef(TypedDict):
Failures: List[PartialFailureTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
EmptyResponseMetadataTypeDef#
# EmptyResponseMetadataTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import EmptyResponseMetadataTypeDef
def get_value() -> EmptyResponseMetadataTypeDef:
return {
"ResponseMetadata": ...,
}
# EmptyResponseMetadataTypeDef definition
class EmptyResponseMetadataTypeDef(TypedDict):
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EnableInsightRulesOutputTypeDef#
# EnableInsightRulesOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import EnableInsightRulesOutputTypeDef
def get_value() -> EnableInsightRulesOutputTypeDef:
return {
"Failures": ...,
}
# EnableInsightRulesOutputTypeDef definition
class EnableInsightRulesOutputTypeDef(TypedDict):
Failures: List[PartialFailureTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetDashboardOutputTypeDef#
# GetDashboardOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetDashboardOutputTypeDef
def get_value() -> GetDashboardOutputTypeDef:
return {
"DashboardArn": ...,
}
# GetDashboardOutputTypeDef definition
class GetDashboardOutputTypeDef(TypedDict):
DashboardArn: str,
DashboardBody: str,
DashboardName: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetMetricStatisticsOutputTypeDef#
# GetMetricStatisticsOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricStatisticsOutputTypeDef
def get_value() -> GetMetricStatisticsOutputTypeDef:
return {
"Label": ...,
}
# GetMetricStatisticsOutputTypeDef definition
class GetMetricStatisticsOutputTypeDef(TypedDict):
Label: str,
Datapoints: List[DatapointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMetricWidgetImageOutputTypeDef#
# GetMetricWidgetImageOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricWidgetImageOutputTypeDef
def get_value() -> GetMetricWidgetImageOutputTypeDef:
return {
"MetricWidgetImage": ...,
}
# GetMetricWidgetImageOutputTypeDef definition
class GetMetricWidgetImageOutputTypeDef(TypedDict):
MetricWidgetImage: bytes,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListDashboardsOutputTypeDef#
# ListDashboardsOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListDashboardsOutputTypeDef
def get_value() -> ListDashboardsOutputTypeDef:
return {
"DashboardEntries": ...,
}
# ListDashboardsOutputTypeDef definition
class ListDashboardsOutputTypeDef(TypedDict):
DashboardEntries: List[DashboardEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
PutDashboardOutputTypeDef#
# PutDashboardOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutDashboardOutputTypeDef
def get_value() -> PutDashboardOutputTypeDef:
return {
"DashboardValidationMessages": ...,
}
# PutDashboardOutputTypeDef definition
class PutDashboardOutputTypeDef(TypedDict):
DashboardValidationMessages: List[DashboardValidationMessageTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutManagedInsightRulesOutputTypeDef#
# PutManagedInsightRulesOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutManagedInsightRulesOutputTypeDef
def get_value() -> PutManagedInsightRulesOutputTypeDef:
return {
"Failures": ...,
}
# PutManagedInsightRulesOutputTypeDef definition
class PutManagedInsightRulesOutputTypeDef(TypedDict):
Failures: List[PartialFailureTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
PutMetricStreamOutputTypeDef#
# PutMetricStreamOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutMetricStreamOutputTypeDef
def get_value() -> PutMetricStreamOutputTypeDef:
return {
"Arn": ...,
}
# PutMetricStreamOutputTypeDef definition
class PutMetricStreamOutputTypeDef(TypedDict):
Arn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef#
# DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef
def get_value() -> DescribeAlarmHistoryInputAlarmDescribeHistoryTypeDef:
return {
"AlarmTypes": ...,
}
# 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)
- See AlarmTypeType
- See HistoryItemTypeType
- See ScanByType
DescribeAlarmHistoryInputTypeDef#
# DescribeAlarmHistoryInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmHistoryInputTypeDef
def get_value() -> DescribeAlarmHistoryInputTypeDef:
return {
"AlarmName": ...,
}
# DescribeAlarmHistoryInputTypeDef definition
class DescribeAlarmHistoryInputTypeDef(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)
- See AlarmTypeType
- See HistoryItemTypeType
- See ScanByType
GetInsightRuleReportInputTypeDef#
# GetInsightRuleReportInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetInsightRuleReportInputTypeDef
def get_value() -> GetInsightRuleReportInputTypeDef:
return {
"RuleName": ...,
}
# GetInsightRuleReportInputTypeDef definition
class GetInsightRuleReportInputTypeDef(TypedDict):
RuleName: str,
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
Period: int,
MaxContributorCount: NotRequired[int],
Metrics: NotRequired[Sequence[str]],
OrderBy: NotRequired[str],
GetMetricStatisticsInputMetricGetStatisticsTypeDef#
# GetMetricStatisticsInputMetricGetStatisticsTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricStatisticsInputMetricGetStatisticsTypeDef
def get_value() -> GetMetricStatisticsInputMetricGetStatisticsTypeDef:
return {
"StartTime": ...,
}
# 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)
- See DimensionTypeDef
- See StatisticType
- See StandardUnitType
GetMetricStatisticsInputTypeDef#
# GetMetricStatisticsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricStatisticsInputTypeDef
def get_value() -> GetMetricStatisticsInputTypeDef:
return {
"Namespace": ...,
}
# GetMetricStatisticsInputTypeDef definition
class GetMetricStatisticsInputTypeDef(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)
- See DimensionTypeDef
- See StatisticType
- See StandardUnitType
RangeTypeDef#
# RangeTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import RangeTypeDef
def get_value() -> RangeTypeDef:
return {
"StartTime": ...,
}
# RangeTypeDef definition
class RangeTypeDef(TypedDict):
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
DescribeAlarmHistoryInputPaginateTypeDef#
# DescribeAlarmHistoryInputPaginateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmHistoryInputPaginateTypeDef
def get_value() -> DescribeAlarmHistoryInputPaginateTypeDef:
return {
"AlarmName": ...,
}
# 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)
- See AlarmTypeType
- See HistoryItemTypeType
- See ScanByType
- See PaginatorConfigTypeDef
DescribeAlarmsInputPaginateTypeDef#
# DescribeAlarmsInputPaginateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmsInputPaginateTypeDef
def get_value() -> DescribeAlarmsInputPaginateTypeDef:
return {
"AlarmNames": ...,
}
# 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)
- See AlarmTypeType
- See StateValueType
- See PaginatorConfigTypeDef
DescribeAnomalyDetectorsInputPaginateTypeDef#
# DescribeAnomalyDetectorsInputPaginateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAnomalyDetectorsInputPaginateTypeDef
def get_value() -> DescribeAnomalyDetectorsInputPaginateTypeDef:
return {
"Namespace": ...,
}
# 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)
ListDashboardsInputPaginateTypeDef#
# ListDashboardsInputPaginateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListDashboardsInputPaginateTypeDef
def get_value() -> ListDashboardsInputPaginateTypeDef:
return {
"DashboardNamePrefix": ...,
}
# ListDashboardsInputPaginateTypeDef definition
class ListDashboardsInputPaginateTypeDef(TypedDict):
DashboardNamePrefix: NotRequired[str],
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeAlarmsInputWaitExtraTypeDef#
# DescribeAlarmsInputWaitExtraTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmsInputWaitExtraTypeDef
def get_value() -> DescribeAlarmsInputWaitExtraTypeDef:
return {
"AlarmNames": ...,
}
# DescribeAlarmsInputWaitExtraTypeDef definition
class DescribeAlarmsInputWaitExtraTypeDef(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)
- See AlarmTypeType
- See StateValueType
- See WaiterConfigTypeDef
DescribeAlarmsInputWaitTypeDef#
# DescribeAlarmsInputWaitTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmsInputWaitTypeDef
def get_value() -> DescribeAlarmsInputWaitTypeDef:
return {
"AlarmNames": ...,
}
# 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)
- See AlarmTypeType
- See StateValueType
- See WaiterConfigTypeDef
DescribeInsightRulesOutputTypeDef#
# DescribeInsightRulesOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeInsightRulesOutputTypeDef
def get_value() -> DescribeInsightRulesOutputTypeDef:
return {
"NextToken": ...,
}
# DescribeInsightRulesOutputTypeDef definition
class DescribeInsightRulesOutputTypeDef(TypedDict):
InsightRules: List[InsightRuleTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListMetricsInputPaginateTypeDef#
# ListMetricsInputPaginateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListMetricsInputPaginateTypeDef
def get_value() -> ListMetricsInputPaginateTypeDef:
return {
"Namespace": ...,
}
# 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)
ListMetricsInputTypeDef#
# ListMetricsInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListMetricsInputTypeDef
def get_value() -> ListMetricsInputTypeDef:
return {
"Namespace": ...,
}
# ListMetricsInputTypeDef definition
class ListMetricsInputTypeDef(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],
MetricDataResultTypeDef#
# MetricDataResultTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricDataResultTypeDef
def get_value() -> MetricDataResultTypeDef:
return {
"Id": ...,
}
# 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)
- See StatusCodeType
- See MessageDataTypeDef
InsightRuleContributorTypeDef#
# InsightRuleContributorTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import InsightRuleContributorTypeDef
def get_value() -> InsightRuleContributorTypeDef:
return {
"Keys": ...,
}
# InsightRuleContributorTypeDef definition
class InsightRuleContributorTypeDef(TypedDict):
Keys: List[str],
ApproximateAggregateValue: float,
Datapoints: List[InsightRuleContributorDatapointTypeDef], # (1)
ListMetricStreamsOutputTypeDef#
# ListMetricStreamsOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListMetricStreamsOutputTypeDef
def get_value() -> ListMetricStreamsOutputTypeDef:
return {
"NextToken": ...,
}
# ListMetricStreamsOutputTypeDef definition
class ListMetricStreamsOutputTypeDef(TypedDict):
Entries: List[MetricStreamEntryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
ListTagsForResourceOutputTypeDef#
# ListTagsForResourceOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListTagsForResourceOutputTypeDef
def get_value() -> ListTagsForResourceOutputTypeDef:
return {
"Tags": ...,
}
# ListTagsForResourceOutputTypeDef definition
class ListTagsForResourceOutputTypeDef(TypedDict):
Tags: List[TagTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See TagTypeDef
- See ResponseMetadataTypeDef
ManagedRuleTypeDef#
# ManagedRuleTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ManagedRuleTypeDef
def get_value() -> ManagedRuleTypeDef:
return {
"TemplateName": ...,
}
# ManagedRuleTypeDef definition
class ManagedRuleTypeDef(TypedDict):
TemplateName: str,
ResourceARN: str,
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
PutCompositeAlarmInputTypeDef#
# PutCompositeAlarmInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutCompositeAlarmInputTypeDef
def get_value() -> PutCompositeAlarmInputTypeDef:
return {
"AlarmName": ...,
}
# PutCompositeAlarmInputTypeDef definition
class PutCompositeAlarmInputTypeDef(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],
- See TagTypeDef
PutInsightRuleInputTypeDef#
# PutInsightRuleInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutInsightRuleInputTypeDef
def get_value() -> PutInsightRuleInputTypeDef:
return {
"RuleName": ...,
}
# PutInsightRuleInputTypeDef definition
class PutInsightRuleInputTypeDef(TypedDict):
RuleName: str,
RuleDefinition: str,
RuleState: NotRequired[str],
Tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
TagResourceInputTypeDef#
# TagResourceInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import TagResourceInputTypeDef
def get_value() -> TagResourceInputTypeDef:
return {
"ResourceARN": ...,
}
# TagResourceInputTypeDef definition
class TagResourceInputTypeDef(TypedDict):
ResourceARN: str,
Tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
ManagedRuleDescriptionTypeDef#
# ManagedRuleDescriptionTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ManagedRuleDescriptionTypeDef
def get_value() -> ManagedRuleDescriptionTypeDef:
return {
"TemplateName": ...,
}
# ManagedRuleDescriptionTypeDef definition
class ManagedRuleDescriptionTypeDef(TypedDict):
TemplateName: NotRequired[str],
ResourceARN: NotRequired[str],
RuleState: NotRequired[ManagedRuleStateTypeDef], # (1)
MetricDatumTypeDef#
# MetricDatumTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricDatumTypeDef
def get_value() -> MetricDatumTypeDef:
return {
"MetricName": ...,
}
# 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],
- See DimensionTypeDef
- See StatisticSetTypeDef
- See StandardUnitType
MetricStreamStatisticsConfigurationOutputTypeDef#
# MetricStreamStatisticsConfigurationOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStreamStatisticsConfigurationOutputTypeDef
def get_value() -> MetricStreamStatisticsConfigurationOutputTypeDef:
return {
"IncludeMetrics": ...,
}
# MetricStreamStatisticsConfigurationOutputTypeDef definition
class MetricStreamStatisticsConfigurationOutputTypeDef(TypedDict):
IncludeMetrics: List[MetricStreamStatisticsMetricTypeDef], # (1)
AdditionalStatistics: List[str],
MetricStreamStatisticsConfigurationTypeDef#
# MetricStreamStatisticsConfigurationTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStreamStatisticsConfigurationTypeDef
def get_value() -> MetricStreamStatisticsConfigurationTypeDef:
return {
"IncludeMetrics": ...,
}
# MetricStreamStatisticsConfigurationTypeDef definition
class MetricStreamStatisticsConfigurationTypeDef(TypedDict):
IncludeMetrics: Sequence[MetricStreamStatisticsMetricTypeDef], # (1)
AdditionalStatistics: Sequence[str],
ListMetricsOutputTypeDef#
# ListMetricsOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListMetricsOutputTypeDef
def get_value() -> ListMetricsOutputTypeDef:
return {
"Metrics": ...,
}
# ListMetricsOutputTypeDef definition
class ListMetricsOutputTypeDef(TypedDict):
Metrics: List[MetricOutputTypeDef], # (1)
OwningAccounts: List[str],
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
MetricStatOutputTypeDef#
# MetricStatOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStatOutputTypeDef
def get_value() -> MetricStatOutputTypeDef:
return {
"Metric": ...,
}
# MetricStatOutputTypeDef definition
class MetricStatOutputTypeDef(TypedDict):
Metric: MetricOutputTypeDef, # (1)
Period: int,
Stat: str,
Unit: NotRequired[StandardUnitType], # (2)
- See MetricOutputTypeDef
- See StandardUnitType
CloudwatchEventMetricTypeDef#
# CloudwatchEventMetricTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CloudwatchEventMetricTypeDef
def get_value() -> CloudwatchEventMetricTypeDef:
return {
"id": ...,
}
# CloudwatchEventMetricTypeDef definition
class CloudwatchEventMetricTypeDef(TypedDict):
id: str,
returnData: bool,
metricStat: NotRequired[CloudwatchEventMetricStatsTypeDef], # (1)
expression: NotRequired[str],
label: NotRequired[str],
period: NotRequired[int],
AnomalyDetectorConfigurationTypeDef#
# AnomalyDetectorConfigurationTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import AnomalyDetectorConfigurationTypeDef
def get_value() -> AnomalyDetectorConfigurationTypeDef:
return {
"ExcludedTimeRanges": ...,
}
# AnomalyDetectorConfigurationTypeDef definition
class AnomalyDetectorConfigurationTypeDef(TypedDict):
ExcludedTimeRanges: NotRequired[Sequence[RangeTypeDef]], # (1)
MetricTimezone: NotRequired[str],
- See RangeTypeDef
GetMetricDataOutputTypeDef#
# GetMetricDataOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricDataOutputTypeDef
def get_value() -> GetMetricDataOutputTypeDef:
return {
"MetricDataResults": ...,
}
# GetMetricDataOutputTypeDef definition
class GetMetricDataOutputTypeDef(TypedDict):
MetricDataResults: List[MetricDataResultTypeDef], # (1)
Messages: List[MessageDataTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
NextToken: NotRequired[str],
GetInsightRuleReportOutputTypeDef#
# GetInsightRuleReportOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetInsightRuleReportOutputTypeDef
def get_value() -> GetInsightRuleReportOutputTypeDef:
return {
"KeyLabels": ...,
}
# 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)
PutManagedInsightRulesInputTypeDef#
# PutManagedInsightRulesInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutManagedInsightRulesInputTypeDef
def get_value() -> PutManagedInsightRulesInputTypeDef:
return {
"ManagedRules": ...,
}
# PutManagedInsightRulesInputTypeDef definition
class PutManagedInsightRulesInputTypeDef(TypedDict):
ManagedRules: Sequence[ManagedRuleTypeDef], # (1)
ListManagedInsightRulesOutputTypeDef#
# ListManagedInsightRulesOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import ListManagedInsightRulesOutputTypeDef
def get_value() -> ListManagedInsightRulesOutputTypeDef:
return {
"ManagedRules": ...,
}
# ListManagedInsightRulesOutputTypeDef definition
class ListManagedInsightRulesOutputTypeDef(TypedDict):
ManagedRules: List[ManagedRuleDescriptionTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
EntityMetricDataTypeDef#
# EntityMetricDataTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import EntityMetricDataTypeDef
def get_value() -> EntityMetricDataTypeDef:
return {
"Entity": ...,
}
# EntityMetricDataTypeDef definition
class EntityMetricDataTypeDef(TypedDict):
Entity: NotRequired[EntityTypeDef], # (1)
MetricData: NotRequired[Sequence[MetricDatumTypeDef]], # (2)
- See EntityTypeDef
- See MetricDatumTypeDef
GetMetricStreamOutputTypeDef#
# GetMetricStreamOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricStreamOutputTypeDef
def get_value() -> GetMetricStreamOutputTypeDef:
return {
"Arn": ...,
}
# 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)
- See MetricStreamFilterOutputTypeDef
- See MetricStreamFilterOutputTypeDef
- See MetricStreamOutputFormatType
- See MetricStreamStatisticsConfigurationOutputTypeDef
- See ResponseMetadataTypeDef
MetricDataQueryOutputTypeDef#
# MetricDataQueryOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricDataQueryOutputTypeDef
def get_value() -> MetricDataQueryOutputTypeDef:
return {
"Id": ...,
}
# 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],
MetricStatTypeDef#
# MetricStatTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStatTypeDef
def get_value() -> MetricStatTypeDef:
return {
"Metric": ...,
}
# MetricStatTypeDef definition
class MetricStatTypeDef(TypedDict):
Metric: MetricUnionTypeDef, # (1)
Period: int,
Stat: str,
Unit: NotRequired[StandardUnitType], # (2)
CloudwatchEventDetailConfigurationTypeDef#
# CloudwatchEventDetailConfigurationTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CloudwatchEventDetailConfigurationTypeDef
def get_value() -> CloudwatchEventDetailConfigurationTypeDef:
return {
"id": ...,
}
# 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]],
PutMetricDataInputMetricPutDataTypeDef#
# PutMetricDataInputMetricPutDataTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutMetricDataInputMetricPutDataTypeDef
def get_value() -> PutMetricDataInputMetricPutDataTypeDef:
return {
"EntityMetricData": ...,
}
# PutMetricDataInputMetricPutDataTypeDef definition
class PutMetricDataInputMetricPutDataTypeDef(TypedDict):
EntityMetricData: NotRequired[Sequence[EntityMetricDataTypeDef]], # (1)
StrictEntityValidation: NotRequired[bool],
PutMetricDataInputTypeDef#
# PutMetricDataInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutMetricDataInputTypeDef
def get_value() -> PutMetricDataInputTypeDef:
return {
"Namespace": ...,
}
# PutMetricDataInputTypeDef definition
class PutMetricDataInputTypeDef(TypedDict):
Namespace: str,
MetricData: NotRequired[Sequence[MetricDatumTypeDef]], # (1)
EntityMetricData: NotRequired[Sequence[EntityMetricDataTypeDef]], # (2)
StrictEntityValidation: NotRequired[bool],
PutMetricStreamInputTypeDef#
# PutMetricStreamInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutMetricStreamInputTypeDef
def get_value() -> PutMetricStreamInputTypeDef:
return {
"Name": ...,
}
# PutMetricStreamInputTypeDef definition
class PutMetricStreamInputTypeDef(TypedDict):
Name: str,
FirehoseArn: str,
RoleArn: str,
OutputFormat: MetricStreamOutputFormatType, # (1)
IncludeFilters: NotRequired[Sequence[MetricStreamFilterUnionTypeDef]], # (2)
ExcludeFilters: NotRequired[Sequence[MetricStreamFilterUnionTypeDef]], # (2)
Tags: NotRequired[Sequence[TagTypeDef]], # (4)
StatisticsConfigurations: NotRequired[Sequence[MetricStreamStatisticsConfigurationUnionTypeDef]], # (5)
IncludeLinkedAccountsMetrics: NotRequired[bool],
- See MetricStreamOutputFormatType
- See MetricStreamFilterTypeDef MetricStreamFilterOutputTypeDef
- See MetricStreamFilterTypeDef MetricStreamFilterOutputTypeDef
- See TagTypeDef
- See MetricStreamStatisticsConfigurationTypeDef MetricStreamStatisticsConfigurationOutputTypeDef
MetricAlarmTypeDef#
# MetricAlarmTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricAlarmTypeDef
def get_value() -> MetricAlarmTypeDef:
return {
"AlarmName": ...,
}
# 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],
- See StateValueType
- See StatisticType
- See DimensionTypeDef
- See StandardUnitType
- See ComparisonOperatorType
- See MetricDataQueryOutputTypeDef
- See EvaluationStateType
MetricMathAnomalyDetectorOutputTypeDef#
# MetricMathAnomalyDetectorOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricMathAnomalyDetectorOutputTypeDef
def get_value() -> MetricMathAnomalyDetectorOutputTypeDef:
return {
"MetricDataQueries": ...,
}
# MetricMathAnomalyDetectorOutputTypeDef definition
class MetricMathAnomalyDetectorOutputTypeDef(TypedDict):
MetricDataQueries: NotRequired[List[MetricDataQueryOutputTypeDef]], # (1)
CloudwatchEventDetailTypeDef#
# CloudwatchEventDetailTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CloudwatchEventDetailTypeDef
def get_value() -> CloudwatchEventDetailTypeDef:
return {
"alarmName": ...,
}
# 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)
- See CloudwatchEventDetailConfigurationTypeDef
- See CloudwatchEventDetailConfigurationTypeDef
- See CloudwatchEventStateTypeDef
- See CloudwatchEventStateTypeDef
DescribeAlarmsForMetricOutputTypeDef#
# DescribeAlarmsForMetricOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmsForMetricOutputTypeDef
def get_value() -> DescribeAlarmsForMetricOutputTypeDef:
return {
"MetricAlarms": ...,
}
# DescribeAlarmsForMetricOutputTypeDef definition
class DescribeAlarmsForMetricOutputTypeDef(TypedDict):
MetricAlarms: List[MetricAlarmTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeAlarmsOutputTypeDef#
# DescribeAlarmsOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAlarmsOutputTypeDef
def get_value() -> DescribeAlarmsOutputTypeDef:
return {
"CompositeAlarms": ...,
}
# DescribeAlarmsOutputTypeDef definition
class DescribeAlarmsOutputTypeDef(TypedDict):
CompositeAlarms: List[CompositeAlarmTypeDef], # (1)
MetricAlarms: List[MetricAlarmTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
NextToken: NotRequired[str],
MetricStatAlarmTypeDef#
# MetricStatAlarmTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricStatAlarmTypeDef
def get_value() -> MetricStatAlarmTypeDef:
return {
"Metric": ...,
}
# MetricStatAlarmTypeDef definition
class MetricStatAlarmTypeDef(TypedDict):
Metric: MetricAlarmTypeDef, # (1)
Period: int,
Stat: str,
Unit: NotRequired[StandardUnitType], # (2)
- See MetricAlarmTypeDef
- See StandardUnitType
AnomalyDetectorTypeDef#
# AnomalyDetectorTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import AnomalyDetectorTypeDef
def get_value() -> AnomalyDetectorTypeDef:
return {
"Namespace": ...,
}
# 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)
- See DimensionTypeDef
- See AnomalyDetectorConfigurationOutputTypeDef
- See AnomalyDetectorStateValueType
- See MetricCharacteristicsTypeDef
- See SingleMetricAnomalyDetectorOutputTypeDef
- See MetricMathAnomalyDetectorOutputTypeDef
MetricDataQueryTypeDef#
# MetricDataQueryTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricDataQueryTypeDef
def get_value() -> MetricDataQueryTypeDef:
return {
"Id": ...,
}
# MetricDataQueryTypeDef definition
class MetricDataQueryTypeDef(TypedDict):
Id: str,
MetricStat: NotRequired[MetricStatUnionTypeDef], # (1)
Expression: NotRequired[str],
Label: NotRequired[str],
ReturnData: NotRequired[bool],
Period: NotRequired[int],
AccountId: NotRequired[str],
CloudwatchEventTypeDef#
# CloudwatchEventTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import CloudwatchEventTypeDef
def get_value() -> CloudwatchEventTypeDef:
return {
"version": ...,
}
# 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)
MetricDataQueryAlarmTypeDef#
# MetricDataQueryAlarmTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricDataQueryAlarmTypeDef
def get_value() -> MetricDataQueryAlarmTypeDef:
return {
"Id": ...,
}
# 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],
DescribeAnomalyDetectorsOutputTypeDef#
# DescribeAnomalyDetectorsOutputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DescribeAnomalyDetectorsOutputTypeDef
def get_value() -> DescribeAnomalyDetectorsOutputTypeDef:
return {
"AnomalyDetectors": ...,
}
# DescribeAnomalyDetectorsOutputTypeDef definition
class DescribeAnomalyDetectorsOutputTypeDef(TypedDict):
AnomalyDetectors: List[AnomalyDetectorTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
MetricMathAnomalyDetectorTypeDef#
# MetricMathAnomalyDetectorTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import MetricMathAnomalyDetectorTypeDef
def get_value() -> MetricMathAnomalyDetectorTypeDef:
return {
"MetricDataQueries": ...,
}
# MetricMathAnomalyDetectorTypeDef definition
class MetricMathAnomalyDetectorTypeDef(TypedDict):
MetricDataQueries: NotRequired[Sequence[MetricDataQueryTypeDef]], # (1)
GetMetricDataInputPaginateTypeDef#
# GetMetricDataInputPaginateTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricDataInputPaginateTypeDef
def get_value() -> GetMetricDataInputPaginateTypeDef:
return {
"MetricDataQueries": ...,
}
# GetMetricDataInputPaginateTypeDef definition
class GetMetricDataInputPaginateTypeDef(TypedDict):
MetricDataQueries: Sequence[MetricDataQueryUnionTypeDef], # (1)
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
ScanBy: NotRequired[ScanByType], # (2)
LabelOptions: NotRequired[LabelOptionsTypeDef], # (3)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (4)
- See MetricDataQueryTypeDef MetricDataQueryOutputTypeDef
- See ScanByType
- See LabelOptionsTypeDef
- See PaginatorConfigTypeDef
GetMetricDataInputTypeDef#
# GetMetricDataInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import GetMetricDataInputTypeDef
def get_value() -> GetMetricDataInputTypeDef:
return {
"MetricDataQueries": ...,
}
# GetMetricDataInputTypeDef definition
class GetMetricDataInputTypeDef(TypedDict):
MetricDataQueries: Sequence[MetricDataQueryUnionTypeDef], # (1)
StartTime: TimestampTypeDef,
EndTime: TimestampTypeDef,
NextToken: NotRequired[str],
ScanBy: NotRequired[ScanByType], # (2)
MaxDatapoints: NotRequired[int],
LabelOptions: NotRequired[LabelOptionsTypeDef], # (3)
PutMetricAlarmInputMetricPutAlarmTypeDef#
# PutMetricAlarmInputMetricPutAlarmTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutMetricAlarmInputMetricPutAlarmTypeDef
def get_value() -> PutMetricAlarmInputMetricPutAlarmTypeDef:
return {
"AlarmName": ...,
}
# 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[MetricDataQueryUnionTypeDef]], # (5)
Tags: NotRequired[Sequence[TagTypeDef]], # (6)
ThresholdMetricId: NotRequired[str],
- See ComparisonOperatorType
- See StatisticType
- See DimensionTypeDef
- See StandardUnitType
- See MetricDataQueryTypeDef MetricDataQueryOutputTypeDef
- See TagTypeDef
PutMetricAlarmInputTypeDef#
# PutMetricAlarmInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutMetricAlarmInputTypeDef
def get_value() -> PutMetricAlarmInputTypeDef:
return {
"AlarmName": ...,
}
# PutMetricAlarmInputTypeDef definition
class PutMetricAlarmInputTypeDef(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[MetricDataQueryUnionTypeDef]], # (5)
Tags: NotRequired[Sequence[TagTypeDef]], # (6)
ThresholdMetricId: NotRequired[str],
- See ComparisonOperatorType
- See StatisticType
- See DimensionTypeDef
- See StandardUnitType
- See MetricDataQueryTypeDef MetricDataQueryOutputTypeDef
- See TagTypeDef
DeleteAnomalyDetectorInputTypeDef#
# DeleteAnomalyDetectorInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import DeleteAnomalyDetectorInputTypeDef
def get_value() -> DeleteAnomalyDetectorInputTypeDef:
return {
"Namespace": ...,
}
# DeleteAnomalyDetectorInputTypeDef definition
class DeleteAnomalyDetectorInputTypeDef(TypedDict):
Namespace: NotRequired[str],
MetricName: NotRequired[str],
Dimensions: NotRequired[Sequence[DimensionTypeDef]], # (1)
Stat: NotRequired[str],
SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorUnionTypeDef], # (2)
MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorUnionTypeDef], # (3)
- See DimensionTypeDef
- See SingleMetricAnomalyDetectorTypeDef SingleMetricAnomalyDetectorOutputTypeDef
- See MetricMathAnomalyDetectorTypeDef MetricMathAnomalyDetectorOutputTypeDef
PutAnomalyDetectorInputTypeDef#
# PutAnomalyDetectorInputTypeDef TypedDict usage example
from types_boto3_cloudwatch.type_defs import PutAnomalyDetectorInputTypeDef
def get_value() -> PutAnomalyDetectorInputTypeDef:
return {
"Namespace": ...,
}
# PutAnomalyDetectorInputTypeDef definition
class PutAnomalyDetectorInputTypeDef(TypedDict):
Namespace: NotRequired[str],
MetricName: NotRequired[str],
Dimensions: NotRequired[Sequence[DimensionTypeDef]], # (1)
Stat: NotRequired[str],
Configuration: NotRequired[AnomalyDetectorConfigurationUnionTypeDef], # (2)
MetricCharacteristics: NotRequired[MetricCharacteristicsTypeDef], # (3)
SingleMetricAnomalyDetector: NotRequired[SingleMetricAnomalyDetectorUnionTypeDef], # (4)
MetricMathAnomalyDetector: NotRequired[MetricMathAnomalyDetectorUnionTypeDef], # (5)