Skip to content

CloudWatchLogs module#

Index > CloudWatchLogs

Auto-generated documentation for CloudWatchLogs type annotations stubs module mypy-boto3-logs.

How to install#

VSCode extension#

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

Click Modify and select boto3 common and CloudWatchLogs.

From PyPI with pip#

Install boto3-stubs for CloudWatchLogs service.

# install with boto3 type annotations
python -m pip install 'boto3-stubs[logs]'

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

# standalone installation
python -m pip install mypy-boto3-logs

How to uninstall#

python -m pip uninstall -y mypy-boto3-logs


Code samples can be found in Examples.


Type annotations and code completion for boto3.client("logs") as CloudWatchLogsClient boto3 documentation

# CloudWatchLogsClient usage example

from boto3.session import Session

from mypy_boto3_logs.client import CloudWatchLogsClient

def get_client() -> CloudWatchLogsClient:
    return Session().client("logs")


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

# DescribeDestinationsPaginator usage example

from boto3.session import Session

from mypy_boto3_logs.paginator import DescribeDestinationsPaginator

def get_describe_destinations_paginator() -> DescribeDestinationsPaginator:
    return Session().client("logs").get_paginator("describe_destinations"))


Type annotations for literals used in methods and schemas.

# DataProtectionStatusType usage example

from mypy_boto3_logs.literals import DataProtectionStatusType

def get_value() -> DataProtectionStatusType:
    return "ACTIVATED"

Typed dictionaries#

Type annotations for typed dictionaries used in methods and schema.

# AccountPolicyTypeDef usage example

from mypy_boto3_logs.type_defs import AccountPolicyTypeDef

def get_value() -> AccountPolicyTypeDef:
    return {
        "policyName": ...,