Skip to content

CleanRoomsService module#

Index > CleanRoomsService

Auto-generated documentation for CleanRoomsService type annotations stubs module mypy-boto3-cleanrooms.

How to install#

VSCode extension#

Add AWS Boto3 extension to your VSCode and run AWS boto3: Quick Start command.

Click Modify and select boto3 common and CleanRoomsService.

From PyPI with pip#

Install boto3-stubs for CleanRoomsService service.

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


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


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

How to uninstall#

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

Usage#

Code samples can be found in Examples.

CleanRoomsServiceClient#

Type annotations and code completion for boto3.client("cleanrooms") as CleanRoomsServiceClient boto3 documentation

# CleanRoomsServiceClient usage example

from boto3.session import Session

from mypy_boto3_cleanrooms.client import CleanRoomsServiceClient

def get_client() -> CleanRoomsServiceClient:
    return Session().client("cleanrooms")

Paginators#

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

# ListAnalysisTemplatesPaginator usage example

from boto3.session import Session

from mypy_boto3_cleanrooms.paginator import ListAnalysisTemplatesPaginator

def get_list_analysis_templates_paginator() -> ListAnalysisTemplatesPaginator:
    return Session().client("cleanrooms").get_paginator("list_analysis_templates"))

Literals#

Type annotations for literals used in methods and schema.

# AggregateFunctionNameType usage example

from mypy_boto3_cleanrooms.literals import AggregateFunctionNameType

def get_value() -> AggregateFunctionNameType:
    return "AVG"

Type definitions#

Type annotations for type definitions used in methods and schema.