User ¶

class User(TypedDict, closed=True):
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId"
    """<p>The globally unique identifier for the identity store.</p>"""
    user_id: "capo_identitystore.types.resource_id.ResourceId"
    """<p>The identifier for a user in the identity store.</p>"""
    user_arn: "capo_identitystore.types.resource_arn.ResourceArn"
    """<p>The Amazon Resource Name (ARN) of the user in the identity store. For example, <code>arn:aws:identitystore:::user/a1b2c3d4-5678-90ab-cdef-EXAMPLE11111</code>.</p>"""
    revision: "capo_identitystore.types.resource_revision.ResourceRevision"
    """<p>The current revision of the user in the identity store. This value changes each time the user is modified. You can provide it as the <code>Revision</code> parameter of an <code>UpdateUser</code> or <code>DeleteUser</code> request to make the operation conditional on the user not having changed. Treat this value as an opaque token: don't parse it or rely on its format or ordering.</p>"""
    user_name: NotRequired["capo_identitystore.types.user_name.UserName"]
    """<p>A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.</p>"""
    external_ids: NotRequired["capo_identitystore.types.external_ids.ExternalIds"]
    """<p>A list of <code>ExternalId</code> objects that contains the identifiers issued to this resource by an external identity provider.</p>"""
    name: NotRequired["capo_identitystore.types.name.Name"]
    """<p>An object containing the name of the user.</p>"""
    display_name: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing the name of the user that is formatted for display when the user is referenced. For example, "John Doe."</p> <p>Prefix search supports a maximum of 1,000 characters for the string.</p>"""
    nick_name: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing an alternate name for the user.</p>"""
    profile_url: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing a URL that might be associated with the user.</p>"""
    emails: NotRequired["capo_identitystore.types.emails.Emails"]
    """<p>A list of <code>Email</code> objects containing email addresses associated with the user.</p>"""
    addresses: NotRequired["capo_identitystore.types.addresses.Addresses"]
    """<p>A list of <code>Address</code> objects containing addresses associated with the user.</p>"""
    phone_numbers: NotRequired["capo_identitystore.types.phone_numbers.PhoneNumbers"]
    """<p>A list of <code>PhoneNumber</code> objects containing phone numbers associated with the user.</p>"""
    user_type: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string indicating the type of user. Possible values are left unspecified. The value can vary based on your specific use case.</p>"""
    title: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing the title of the user. Possible values are left unspecified. The value can vary based on your specific use case.</p>"""
    preferred_language: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing the preferred language of the user. For example, "American English" or "en-us."</p>"""
    locale: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing the geographical region or location of the user.</p>"""
    timezone: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>A string containing the time zone of the user.</p>"""
    user_status: NotRequired["capo_identitystore.types.user_status.UserStatus"]
    """<p>The current status of the user account.</p>"""
    photos: NotRequired["capo_identitystore.types.photos.Photos"]
    """<p>A list of photos associated with the user. Users can have up to 3 photos with metadata including type, display name, and primary designation.</p>"""
    website: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The user's personal website or blog URL. This field stores website information for personal or professional use.</p>"""
    birthdate: NotRequired[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ]
    """<p>The user's birthdate in YYYY-MM-DD format. This field stores personal birthdate information for the user.</p>"""
    roles: NotRequired["capo_identitystore.types.roles.Roles"]
    """<p>A list of <code>Role</code> objects containing roles associated with the user.</p>"""
    created_at: NotRequired["capo_identitystore.types.date_type.DateType"]
    """<p>The date and time the user was created.</p>"""
    created_by: NotRequired["capo_identitystore.types.string_type.StringType"]
    """<p>The identifier of the user or system that created the user.</p>"""
    updated_at: NotRequired["capo_identitystore.types.date_type.DateType"]
    """<p>The date and time the user was last updated.</p>"""
    updated_by: NotRequired["capo_identitystore.types.string_type.StringType"]
    """<p>The identifier of the user or system that last updated the user.</p>"""
    extensions: NotRequired["capo_identitystore.types.extensions.Extensions"]
    """<p>A map of explicitly requested attribute extensions associated with the user. Not populated if the user has no requested extensions.</p>"""