Skip to content

GetSimilarProfilesRequest

Source code in docs_src/capo_customer_profiles/types/get_similar_profiles_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class GetSimilarProfilesRequest(TypedDict, closed=True):
    next_token: NotRequired["capo_customer_profiles.types.token.token"]
    """<p>The pagination token from the previous <code>GetSimilarProfiles</code> API call.</p>"""
    max_results: NotRequired["capo_customer_profiles.types.max_size100.maxSize100"]
    """<p>The maximum number of objects returned per page.</p>"""
    domain_name: "capo_customer_profiles.types.name.name"
    """<p>The unique name of the domain.</p>"""
    match_type: "capo_customer_profiles.types.match_type.MatchType"
    """<p>Specify the type of matching to get similar profiles for.</p>"""
    search_key: "capo_customer_profiles.types.string1_to255.string1To255"
    """<p>The string indicating the search key to be used.</p>"""
    search_value: "capo_customer_profiles.types.string1_to255.string1To255"
    """<p>The string based on <code>SearchKey</code> to be searched for similar profiles.</p>"""

domain_name instance-attribute 

domain_name: name

The unique name of the domain.

match_type instance-attribute 

match_type: MatchType

Specify the type of matching to get similar profiles for.

max_results instance-attribute 

max_results: NotRequired[maxSize100]

The maximum number of objects returned per page.

next_token instance-attribute 

next_token: NotRequired[token]

The pagination token from the previous GetSimilarProfiles API call.

search_key instance-attribute 

search_key: string1To255

The string indicating the search key to be used.

search_value instance-attribute 

search_value: string1To255

The string based on SearchKey to be searched for similar profiles.