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("...").

# ListCollaborationsPaginator usage example

from boto3.session import Session

from mypy_boto3_cleanrooms.paginator import ListCollaborationsPaginator

def get_list_collaborations_paginator() -> ListCollaborationsPaginator:
    return Session().client("cleanrooms").get_paginator("list_collaborations"))

Literals

Type annotations for literals used in methods and schemas.

# AggregateFunctionNameType usage example

from mypy_boto3_cleanrooms.literals import AggregateFunctionNameType

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

Typed dictionaries

Type annotations for typed dictionaries used in methods and schema.

# AggregateColumnTypeDef usage example

from mypy_boto3_cleanrooms.type_defs import AggregateColumnTypeDef

def get_value() -> AggregateColumnTypeDef:
    return {
        "columnNames": ...,
        "function": ...,
    }