Skip to content

CustomerProfiles module#

Index > CustomerProfiles

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

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.37.36' mypy-boto3-builder
  2. Select boto3-stubs AWS SDK.
  3. Add CustomerProfiles 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 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("...").

# GetSimilarProfilesPaginator usage example

from boto3.session import Session

from mypy_boto3_customer_profiles.paginator import GetSimilarProfilesPaginator

def get_get_similar_profiles_paginator() -> GetSimilarProfilesPaginator:
    return Session().client("customer-profiles").get_paginator("get_similar_profiles"))

Literals#

Type annotations for literals used in methods and schema.

# AttributeDimensionTypeType usage example

from mypy_boto3_customer_profiles.literals import AttributeDimensionTypeType

def get_value() -> AttributeDimensionTypeType:
    return "AFTER"

Type definitions#

Type annotations for type definitions used in methods and schema.