Profile ¶

class Profile(TypedDict, closed=True):
    profile_id: NotRequired["capo_customer_profiles.types.uuid.uuid"]
    """<p>The unique identifier of a customer profile.</p>"""
    account_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>An account number that you have assigned to the customer.</p>"""
    additional_information: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to1000.sensitiveString1To1000"
    ]
    """<p>Any additional information relevant to the customer’s profile.</p>"""
    party_type: NotRequired["capo_customer_profiles.types.party_type.PartyType"]
    """<p>The type of profile used to describe the customer.</p>"""
    business_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The name of the customer’s business.</p>"""
    first_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s first name.</p>"""
    middle_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s middle name.</p>"""
    last_name: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s last name.</p>"""
    birth_date: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s birth date. </p>"""
    gender: NotRequired["capo_customer_profiles.types.gender.Gender"]
    """<p>The gender with which the customer identifies. </p>"""
    phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer's phone number, which has not been specified as a mobile, home, or business number.</p>"""
    mobile_phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s mobile phone number.</p>"""
    home_phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s home phone number.</p>"""
    business_phone_number: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s home phone number.</p>"""
    email_address: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s email address, which has not been specified as a personal or business address. </p>"""
    personal_email_address: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s personal email address.</p>"""
    business_email_address: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>The customer’s business email address.</p>"""
    address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>A generic address associated with the customer that is not mailing, shipping, or billing.</p>"""
    shipping_address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>The customer’s shipping address.</p>"""
    mailing_address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>The customer’s mailing address.</p>"""
    billing_address: NotRequired["capo_customer_profiles.types.address.Address"]
    """<p>The customer’s billing address.</p>"""
    attributes: NotRequired["capo_customer_profiles.types.attributes.Attributes"]
    """<p>A key value pair of attributes of a customer profile.</p>"""
    found_by_items: NotRequired[
        "capo_customer_profiles.types.found_by_list.foundByList"
    ]
    """<p>A list of items used to find a profile returned in a <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> response. An item is a key-value(s) pair that matches an attribute in the profile.</p> <p>If the optional <code>AdditionalSearchKeys</code> parameter was included in the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request, the <code>FoundByItems</code> list should be interpreted based on the <code>LogicalOperator</code> used in the request:</p> <ul> <li> <p> <code>AND</code> - The profile included in the response matched all of the search keys specified in the request. The <code>FoundByItems</code> will include all of the key-value(s) pairs that were specified in the request (as this is a requirement of <code>AND</code> search logic).</p> </li> <li> <p> <code>OR</code> - The profile included in the response matched at least one of the search keys specified in the request. The <code>FoundByItems</code> will include each of the key-value(s) pairs that the profile was found by.</p> </li> </ul> <p>The <code>OR</code> relationship is the default behavior if the <code>LogicalOperator</code> parameter is not included in the <a href="https://docs.aws.amazon.com/customerprofiles/latest/APIReference/API_SearchProfiles.html">SearchProfiles</a> request.</p>"""
    party_type_string: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>An alternative to PartyType which accepts any string as input.</p>"""
    gender_string: NotRequired[
        "capo_customer_profiles.types.sensitive_string1_to255.sensitiveString1To255"
    ]
    """<p>An alternative to Gender which accepts any string as input.</p>"""
    profile_type: NotRequired["capo_customer_profiles.types.profile_type.ProfileType"]
    """<p>The type of the profile.</p>"""
    engagement_preferences: NotRequired[
        "capo_customer_profiles.types.engagement_preferences.EngagementPreferences"
    ]
    """<p>The customer or account’s engagement preferences.</p>"""