Skip to content

CloudWatch module#

Index > CloudWatch

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

How to install#

You can generate type annotations for boto3 package locally with mypy-boto3-builder. Use uv for build isolation.

  1. Run mypy-boto3-builder in your package root directory: uvx --with 'boto3==1.36.26' mypy-boto3-builder
  2. Select boto3 AWS SDK.
  3. Add CloudWatch service.
  4. Use provided commands to install generated packages.

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CloudWatch.

From PyPI with pip#

Install types-boto3 for CloudWatch service.

# install with boto3 type annotations
python -m pip install 'types-boto3[cloudwatch]'

# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[cloudwatch]'

# standalone installation
python -m pip install types-boto3-cloudwatch

How to uninstall#

python -m pip uninstall -y types-boto3-cloudwatch

Usage#

Code samples can be found in Examples.

CloudWatchClient#

Type annotations and code completion for boto3.client("cloudwatch") as CloudWatchClient boto3 documentation

# CloudWatchClient usage example

from boto3.session import Session

from types_boto3_cloudwatch.client import CloudWatchClient

def get_client() -> CloudWatchClient:
    return Session().client("cloudwatch")

Paginators#

Type annotations and code completion for paginators from boto3.client("cloudwatch").get_paginator("...").

# DescribeAlarmHistoryPaginator usage example

from boto3.session import Session

from types_boto3_cloudwatch.paginator import DescribeAlarmHistoryPaginator

def get_describe_alarm_history_paginator() -> DescribeAlarmHistoryPaginator:
    return Session().client("cloudwatch").get_paginator("describe_alarm_history"))

Waiters#

Type annotations and code completion for waiters from boto3.client("cloudwatch").get_waiter("...").

# AlarmExistsWaiter usage example

from boto3.session import Session

from types_boto3_cloudwatch.waiter import AlarmExistsWaiter

def get_alarm_exists_waiter() -> AlarmExistsWaiter:
    return Session().client("cloudwatch").get_waiter("alarm_exists")

CloudWatchServiceResource#

Type annotations and code completion for boto3.resource("cloudwatch") as CloudWatchServiceResource boto3 documentation

# CloudWatchServiceResource usage example

from boto3.session import Session

from types_boto3_cloudwatch.service_resource import CloudWatchServiceResource

def get_cloudwatch_resource() -> CloudWatchServiceResource:
    return Session().resource("cloudwatch")

Collections#

Type annotations and code completion for collections from boto3.resource("cloudwatch").*.

# ServiceResourceAlarmsCollection usage example

from boto3.session import Session

from types_boto3_cloudwatch.service_resource import ServiceResourceAlarmsCollection

def get_collection() -> ServiceResourceAlarmsCollection:
    return Session().resource("cloudwatch").alarms

Resources#

Type annotations and code completion for additional resources from session.resource("cloudwatch").*.

# Alarm usage example

from types_boto3_cloudwatch.service_resource import Alarm

def get_resource() -> Alarm:
    return resource.Alarm(...)

Literals#

Type annotations for literals used in methods and schema.

# ActionsSuppressedByType usage example

from types_boto3_cloudwatch.literals import ActionsSuppressedByType

def get_value() -> ActionsSuppressedByType:
    return "Alarm"

Type definitions#

Type annotations for type definitions used in methods and schema.