Skip to content

CustomerProfiles module#

Index > CustomerProfiles

Auto-generated documentation for CustomerProfiles type annotations stubs module mypy-boto3-customer-profiles.

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

From PyPI with pip#

Install boto3-stubs for CustomerProfiles service.

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


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


# standalone installation
python -m pip install mypy-boto3-customer-profiles

How to uninstall#

python -m pip uninstall -y mypy-boto3-customer-profiles

Usage#

Code samples can be found in Examples.

CustomerProfilesClient#

Type annotations and code completion for boto3.client("customer-profiles") as CustomerProfilesClient boto3 documentation

# CustomerProfilesClient usage example

from boto3.session import Session

from mypy_boto3_customer_profiles.client import CustomerProfilesClient

def get_client() -> CustomerProfilesClient:
    return Session().client("customer-profiles")

Paginators#

Type annotations and code completion for paginators from boto3.client("customer-profiles").get_paginator("...").

# ListEventStreamsPaginator usage example

from boto3.session import Session

from mypy_boto3_customer_profiles.paginator import ListEventStreamsPaginator

def get_list_event_streams_paginator() -> ListEventStreamsPaginator:
    return Session().client("customer-profiles").get_paginator("list_event_streams"))

Literals#

Type annotations for literals used in methods and schema.

# AttributeMatchingModelType usage example

from mypy_boto3_customer_profiles.literals import AttributeMatchingModelType

def get_value() -> AttributeMatchingModelType:
    return "MANY_TO_MANY"

Type definitions#

Type annotations for type definitions used in methods and schema.