Examples

Index > CloudWatchRUM > Examples

Auto-generated documentation for CloudWatchRUM type annotations stubs module types-aiobotocore-rum.

Client

Implicit type annotations

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

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

# CloudWatchRUMClient usage example

from aioboto3.session import Session


session = Session()

async with session.client("rum") as client:  # (1)
    result = await client.batch_create_rum_metric_definitions()  # (2)

1. client: CloudWatchRUMClient
2. result: BatchCreateRumMetricDefinitionsResponseTypeDef

# BatchGetRumMetricDefinitionsPaginator usage example

from aioboto3.session import Session


session = Session()

async with session.client("rum") as client:  # (1)
    paginator = client.get_paginator("batch_get_rum_metric_definitions")  # (2)
    async for item in paginator.paginate(...):
        print(item)  # (3)

1. client: CloudWatchRUMClient
2. paginator: BatchGetRumMetricDefinitionsPaginator
3. item: BatchGetRumMetricDefinitionsResponseTypeDef

Explicit type annotations

With types-aioboto3-lite[rum] or a standalone types_aiobotocore_rum package, you have to explicitly specify client: CloudWatchRUMClient 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.

# CloudWatchRUMClient usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_rum.client import CloudWatchRUMClient
from types_aiobotocore_rum.type_defs import BatchCreateRumMetricDefinitionsResponseTypeDef
from types_aiobotocore_rum.type_defs import BatchCreateRumMetricDefinitionsRequestRequestTypeDef


session = Session()

client: CloudWatchRUMClient
async with session.client("rum") as client:  # (1)
    kwargs: BatchCreateRumMetricDefinitionsRequestRequestTypeDef = {...}  # (2)
    result: BatchCreateRumMetricDefinitionsResponseTypeDef = await client.batch_create_rum_metric_definitions(**kwargs)  # (3)

1. client: CloudWatchRUMClient
2. kwargs: BatchCreateRumMetricDefinitionsRequestRequestTypeDef
3. result: BatchCreateRumMetricDefinitionsResponseTypeDef

# BatchGetRumMetricDefinitionsPaginator usage example with type annotations

from aioboto3.session import Session

from types_aiobotocore_rum.client import CloudWatchRUMClient
from types_aiobotocore_rum.paginator import BatchGetRumMetricDefinitionsPaginator
from types_aiobotocore_rum.type_defs import BatchGetRumMetricDefinitionsResponseTypeDef


session = Session()

client: CloudWatchRUMClient
async with session.client("rum") as client:  # (1)
    paginator: BatchGetRumMetricDefinitionsPaginator = client.get_paginator("batch_get_rum_metric_definitions")  # (2)
    async for item in paginator.paginate(...):
        item: BatchGetRumMetricDefinitionsResponseTypeDef
        print(item)  # (3)

1. client: CloudWatchRUMClient
2. paginator: BatchGetRumMetricDefinitionsPaginator
3. item: BatchGetRumMetricDefinitionsResponseTypeDef