Skip to content

CloudWatchRUM module#

Index > CloudWatchRUM

Auto-generated documentation for CloudWatchRUM type annotations stubs module mypy-boto3-rum.

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.35.86' mypy_boto3_builder
  2. Select boto3-stubs AWS SDK.
  3. Add CloudWatchRUM 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 CloudWatchRUM.

From PyPI with pip#

Install boto3-stubs for CloudWatchRUM service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CloudWatchRUMClient#

Type annotations and code completion for boto3.client("rum") as CloudWatchRUMClient boto3 documentation

# CloudWatchRUMClient usage example

from boto3.session import Session

from mypy_boto3_rum.client import CloudWatchRUMClient

def get_client() -> CloudWatchRUMClient:
    return Session().client("rum")

Paginators#

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

# BatchGetRumMetricDefinitionsPaginator usage example

from boto3.session import Session

from mypy_boto3_rum.paginator import BatchGetRumMetricDefinitionsPaginator

def get_batch_get_rum_metric_definitions_paginator() -> BatchGetRumMetricDefinitionsPaginator:
    return Session().client("rum").get_paginator("batch_get_rum_metric_definitions"))

Literals#

Type annotations for literals used in methods and schema.

# BatchGetRumMetricDefinitionsPaginatorName usage example

from mypy_boto3_rum.literals import BatchGetRumMetricDefinitionsPaginatorName

def get_value() -> BatchGetRumMetricDefinitionsPaginatorName:
    return "batch_get_rum_metric_definitions"

Type definitions#

Type annotations for type definitions used in methods and schema.