Skip to content

Examples#

Index > CloudWatchLogs > Examples

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

Client#

Implicit type annotations#

Can be used with types-aioboto3[logs] package installed.

Write your CloudWatchLogs code as usual, type checking and code completion should work out of the box.

# CloudWatchLogsClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("logs") as client:  # (1)
    result = await client.associate_kms_key()  # (2)
  1. client: CloudWatchLogsClient
  2. result: EmptyResponseMetadataTypeDef
# DescribeDeliveriesPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("logs") as client:  # (1)
    paginator = client.get_paginator("describe_deliveries")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeDeliveriesPaginator
  3. item: DescribeDeliveriesResponseTypeDef

Explicit type annotations#

With types-aioboto3-lite[logs] or a standalone types_aiobotocore_logs package, you have to explicitly specify client: CloudWatchLogsClient type annotation.

All other type annotations are optional, as types should be discovered automatically. However, these type annotations can be helpful in your functions and methods.

# CloudWatchLogsClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_logs.client import CloudWatchLogsClient
from types_aiobotocore_logs.type_defs import EmptyResponseMetadataTypeDef
from types_aiobotocore_logs.type_defs import AssociateKmsKeyRequestRequestTypeDef


session = Session()

client: CloudWatchLogsClient
async with session.client("logs") as client:  # (1)
    kwargs: AssociateKmsKeyRequestRequestTypeDef = {...}  # (2)
    result: EmptyResponseMetadataTypeDef = await client.associate_kms_key(**kwargs)  # (3)
  1. client: CloudWatchLogsClient
  2. kwargs: AssociateKmsKeyRequestRequestTypeDef
  3. result: EmptyResponseMetadataTypeDef
# DescribeDeliveriesPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_logs.client import CloudWatchLogsClient
from types_aiobotocore_logs.paginator import DescribeDeliveriesPaginator
from types_aiobotocore_logs.type_defs import DescribeDeliveriesResponseTypeDef


session = Session()

client: CloudWatchLogsClient
async with session.client("logs") as client:  # (1)
    paginator: DescribeDeliveriesPaginator = client.get_paginator("describe_deliveries")  # (2)
    async for item in paginator.paginate(...):
        item: DescribeDeliveriesResponseTypeDef
        print(item)  # (3)
  1. client: CloudWatchLogsClient
  2. paginator: DescribeDeliveriesPaginator
  3. item: DescribeDeliveriesResponseTypeDef