Paginators

Index > CustomerProfiles > Paginators

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

GetSimilarProfilesPaginator

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

# 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")

# GetSimilarProfilesPaginator usage example with type annotations

from boto3.session import Session

from mypy_boto3_customer_profiles.paginator import GetSimilarProfilesPaginator

session = Session()

client = Session().client("customer-profiles")  # (1)
paginator: GetSimilarProfilesPaginator = client.get_paginator("get_similar_profiles")  # (2)
for item in paginator.paginate(...):
    print(item)  # (3)

1. client: CustomerProfilesClient
2. paginator: GetSimilarProfilesPaginator
3. item: GetSimilarProfilesResponseTypeDef

paginate

Type annotations and code completion for GetSimilarProfilesPaginator.paginate method.

# paginate method definition

def paginate(
    self,
    *,
    DomainName: str,
    MatchType: MatchTypeType,  # (1)
    SearchKey: str,
    SearchValue: str,
    PaginationConfig: PaginatorConfigTypeDef = ...,  # (2)
) -> _PageIterator[GetSimilarProfilesResponseTypeDef]:  # (3)
    ...

1. See MatchTypeType
2. See PaginatorConfigTypeDef
3. See GetSimilarProfilesResponseTypeDef

# paginate method usage example with argument unpacking

kwargs: GetSimilarProfilesRequestGetSimilarProfilesPaginateTypeDef = {  # (1)
    "DomainName": ...,
    "MatchType": ...,
    "SearchKey": ...,
    "SearchValue": ...,
}

parent.paginate(**kwargs)

1. See