Skip to content

User

Source code in docs_src/capo_chime/types/user.py 
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
class User(TypedDict, closed=True):
    user_id: "capo_chime.types.string.String"
    """<p>The user ID.</p>"""
    account_id: NotRequired["capo_chime.types.string.String"]
    """<p>The Amazon Chime account ID.</p>"""
    primary_email: NotRequired["capo_chime.types.email_address.EmailAddress"]
    """<p>The primary email address of the user.</p>"""
    primary_provisioned_number: NotRequired[
        "capo_chime.types.sensitive_string.SensitiveString"
    ]
    """<p>The primary phone number associated with the user.</p>"""
    display_name: NotRequired["capo_chime.types.sensitive_string.SensitiveString"]
    """<p>The display name of the user.</p>"""
    license_type: NotRequired["capo_chime.types.license.License"]
    """<p>The license type for the user.</p>"""
    user_type: NotRequired["capo_chime.types.user_type.UserType"]
    """<p>The user type.</p>"""
    user_registration_status: NotRequired[
        "capo_chime.types.registration_status.RegistrationStatus"
    ]
    """<p>The user registration status.</p>"""
    user_invitation_status: NotRequired["capo_chime.types.invite_status.InviteStatus"]
    """<p>The user invite status.</p>"""
    registered_on: NotRequired["capo_chime.types.iso8601_timestamp.Iso8601Timestamp"]
    """<p>Date and time when the user is registered, in ISO 8601 format.</p>"""
    invited_on: NotRequired["capo_chime.types.iso8601_timestamp.Iso8601Timestamp"]
    """<p>Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.</p>"""
    alexa_for_business_metadata: NotRequired[
        "capo_chime.types.alexa_for_business_metadata.AlexaForBusinessMetadata"
    ]
    """<p>The Alexa for Business metadata.</p>"""
    personal_pin: NotRequired["capo_chime.types.string.String"]
    """<p>The user's personal meeting PIN.</p>"""

account_id instance-attribute 

account_id: NotRequired[String]

The Amazon Chime account ID.

alexa_for_business_metadata instance-attribute 

alexa_for_business_metadata: NotRequired[AlexaForBusinessMetadata]

The Alexa for Business metadata.

display_name instance-attribute 

display_name: NotRequired[SensitiveString]

The display name of the user.

invited_on instance-attribute 

invited_on: NotRequired[Iso8601Timestamp]

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

license_type instance-attribute 

license_type: NotRequired[License]

The license type for the user.

personal_pin instance-attribute 

personal_pin: NotRequired[String]

The user's personal meeting PIN.

primary_email instance-attribute 

primary_email: NotRequired[EmailAddress]

The primary email address of the user.

primary_provisioned_number instance-attribute 

primary_provisioned_number: NotRequired[SensitiveString]

The primary phone number associated with the user.

registered_on instance-attribute 

registered_on: NotRequired[Iso8601Timestamp]

Date and time when the user is registered, in ISO 8601 format.

user_id instance-attribute 

user_id: String

The user ID.

user_invitation_status instance-attribute 

user_invitation_status: NotRequired[InviteStatus]

The user invite status.

user_registration_status instance-attribute 

user_registration_status: NotRequired[RegistrationStatus]

The user registration status.

user_type instance-attribute 

user_type: NotRequired[UserType]

The user type.