Skip to content

User

Source code in docs_src/capo_appstream/types/user.py
class User(TypedDict, closed=True):
    arn: NotRequired["capo_appstream.types.arn.Arn"]
    """<p>The ARN of the user.</p>"""
    user_name: NotRequired["capo_appstream.types.username.Username"]
    """<p>The email address of the user.</p> <note> <p>Users' email addresses are case-sensitive.</p> </note>"""
    enabled: NotRequired["capo_appstream.types.boolean.Boolean"]
    """<p>Specifies whether the user in the user pool is enabled.</p>"""
    status: NotRequired["capo_appstream.types.string.String"]
    """<p>The status of the user in the user pool. The status can be one of the following:</p> <ul> <li> <p>UNCONFIRMED – The user is created but not confirmed.</p> </li> <li> <p>CONFIRMED – The user is confirmed.</p> </li> <li> <p>ARCHIVED – The user is no longer active.</p> </li> <li> <p>COMPROMISED – The user is disabled because of a potential security threat.</p> </li> <li> <p>UNKNOWN – The user status is not known.</p> </li> </ul>"""
    first_name: NotRequired[
        "capo_appstream.types.user_attribute_value.UserAttributeValue"
    ]
    """<p>The first name, or given name, of the user.</p>"""
    last_name: NotRequired[
        "capo_appstream.types.user_attribute_value.UserAttributeValue"
    ]
    """<p>The last name, or surname, of the user.</p>"""
    created_time: NotRequired["capo_appstream.types.timestamp.Timestamp"]
    """<p>The date and time the user was created in the user pool.</p>"""
    authentication_type: NotRequired[
        "capo_appstream.types.authentication_type.AuthenticationType"
    ]
    """<p>The authentication type for the user.</p>"""

arn instance-attribute

arn: NotRequired[Arn]

The ARN of the user.

authentication_type instance-attribute

authentication_type: NotRequired[AuthenticationType]

The authentication type for the user.

created_time instance-attribute

created_time: NotRequired[Timestamp]

The date and time the user was created in the user pool.

enabled instance-attribute

enabled: NotRequired[Boolean]

Specifies whether the user in the user pool is enabled.

first_name instance-attribute

first_name: NotRequired[UserAttributeValue]

The first name, or given name, of the user.

last_name instance-attribute

last_name: NotRequired[UserAttributeValue]

The last name, or surname, of the user.

status instance-attribute

status: NotRequired[String]

The status of the user in the user pool. The status can be one of the following:

  • UNCONFIRMED – The user is created but not confirmed.

  • CONFIRMED – The user is confirmed.

  • ARCHIVED – The user is no longer active.

  • COMPROMISED – The user is disabled because of a potential security threat.

  • UNKNOWN – The user status is not known.

user_name instance-attribute

user_name: NotRequired[Username]

The email address of the user.

Users' email addresses are case-sensitive.