Skip to content

CleanRoomsML module#

Index > CleanRoomsML

Auto-generated documentation for CleanRoomsML type annotations stubs module mypy-boto3-cleanroomsml.

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

From PyPI with pip#

Install boto3-stubs for CleanRoomsML service.

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

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

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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CleanRoomsMLClient#

Type annotations and code completion for boto3.client("cleanroomsml") as CleanRoomsMLClient boto3 documentation

# CleanRoomsMLClient usage example

from boto3.session import Session

from mypy_boto3_cleanroomsml.client import CleanRoomsMLClient

def get_client() -> CleanRoomsMLClient:
    return Session().client("cleanroomsml")

Paginators#

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

# ListAudienceExportJobsPaginator usage example

from boto3.session import Session

from mypy_boto3_cleanroomsml.paginator import ListAudienceExportJobsPaginator

def get_list_audience_export_jobs_paginator() -> ListAudienceExportJobsPaginator:
    return Session().client("cleanroomsml").get_paginator("list_audience_export_jobs"))

Literals#

Type annotations for literals used in methods and schema.

# AudienceExportJobStatusType usage example

from mypy_boto3_cleanroomsml.literals import AudienceExportJobStatusType

def get_value() -> AudienceExportJobStatusType:
    return "ACTIVE"

Type definitions#

Type annotations for type definitions used in methods and schema.