Skip to content

CloudWatchLogs module#

Index > CloudWatchLogs

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

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 CloudWatchLogs 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 CloudWatchLogs.

From PyPI with pip#

Install types-boto3 for CloudWatchLogs service.

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

# 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[logs]'

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CloudWatchLogsClient#

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

# CloudWatchLogsClient usage example

from boto3.session import Session

from types_boto3_logs.client import CloudWatchLogsClient

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

Paginators#

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

# DescribeConfigurationTemplatesPaginator usage example

from boto3.session import Session

from types_boto3_logs.paginator import DescribeConfigurationTemplatesPaginator

def get_describe_configuration_templates_paginator() -> DescribeConfigurationTemplatesPaginator:
    return Session().client("logs").get_paginator("describe_configuration_templates"))

Literals#

Type annotations for literals used in methods and schema.

# AnomalyDetectorStatusType usage example

from types_boto3_logs.literals import AnomalyDetectorStatusType

def get_value() -> AnomalyDetectorStatusType:
    return "ANALYZING"

Type definitions#

Type annotations for type definitions used in methods and schema.