mypy-boto3-cloudwatch 1.13.20.0

Type annotations for boto3.CloudWatch 1.13.20 service, generated by mypy-boto3-buider 1.0.9

mypy-boto3-cloudwatch

Type annotations for boto3.CloudWatch 1.13.20 service compatible with mypy, VSCode, PyCharm and other tools.

Generated by mypy-boto3-buider 1.0.9.

More information can be found on boto3-stubs page.

• mypy-boto3-cloudwatch
  • How to use
    • Type checking
  • How it works

How to use

Type checking

Make sure you have mypy installed and activated in your IDE.

Install boto3-stubs for CloudWatch service.

python -m pip install boto3-stubs[cloudwatch]

# update installed packages index
mypy_boto3

Use boto3 with mypy_boto3 in your project and enjoy type checking and auto-complete.

import boto3

from mypy_boto3 import cloudwatch
# alternative import if you do not want to install mypy_boto3 package
# import mypy_boto3_cloudwatch as cloudwatch

# Use this client as usual, now mypy can check if your code is valid.
# Check if your IDE supports function overloads,
# you probably do not need explicit type annotations
# client = boto3.client("cloudwatch")
client: cloudwatch.CloudWatchClient = boto3.client("cloudwatch")

# works for session as well
session = boto3.session.Session(region="us-west-1")
session_client: cloudwatch.CloudWatchClient = session.client("cloudwatch")

# Do you prefer resource approach? We've got you covered!
resource: cloudwatch.CloudWatchServiceResource = boto3.resource("cloudwatch")

# Waiters need type annotation on creation
alarm_exists_waiter: cloudwatch.AlarmExistsWaiter = client.get_waiter("alarm_exists")
composite_alarm_exists_waiter: cloudwatch.CompositeAlarmExistsWaiter = client.get_waiter("composite_alarm_exists")

# Paginators need type annotation on creation
describe_alarm_history_paginator: cloudwatch.DescribeAlarmHistoryPaginator = client.get_paginator("describe_alarm_history")
describe_alarms_paginator: cloudwatch.DescribeAlarmsPaginator = client.get_paginator("describe_alarms")
get_metric_data_paginator: cloudwatch.GetMetricDataPaginator = client.get_paginator("get_metric_data")
list_dashboards_paginator: cloudwatch.ListDashboardsPaginator = client.get_paginator("list_dashboards")
list_metrics_paginator: cloudwatch.ListMetricsPaginator = client.get_paginator("list_metrics")

How it works

Fully automated builder carefully generates type annotations for each service, patiently waiting for boto3 updates. It delivers a drop-in type annotations for you and makes sure that:

• All available boto3 services are covered.
• Each public class and method of every boto3 service gets valid type annotations extracted from the documentation (blame botocore docs if types are incorrect).
• Type annotations include up-to-date documentation.
• Link to documentation is provided for every method.
• Code is processed by black for readability.