Chime / Client / list_users

list_users#

Chime.Client.list_users(**kwargs)#

Lists the users that belong to the specified Amazon Chime account. You can specify an email address to list only the user that the email address belongs to.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    AccountId='string',
    UserEmail='string',
    UserType='PrivateUser'|'SharedDevice',
    MaxResults=123,
    NextToken='string'
)
Parameters:

  • AccountId (string) –

    [REQUIRED]

    The Amazon Chime account ID.

  • UserEmail (string) – Optional. The user email address used to filter results. Maximum 1.

  • UserType (string) – The user type.

  • MaxResults (integer) – The maximum number of results to return in a single call. Defaults to 100.

  • NextToken (string) – The token to use to retrieve the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'Users': [
        {
            'UserId': 'string',
            'AccountId': 'string',
            'PrimaryEmail': 'string',
            'PrimaryProvisionedNumber': 'string',
            'DisplayName': 'string',
            'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
            'UserType': 'PrivateUser'|'SharedDevice',
            'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
            'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
            'RegisteredOn': datetime(2015, 1, 1),
            'InvitedOn': datetime(2015, 1, 1),
            'AlexaForBusinessMetadata': {
                'IsAlexaForBusinessEnabled': True|False,
                'AlexaForBusinessRoomArn': 'string'
            },
            'PersonalPIN': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

  • (dict) –

    • Users (list) –

      List of users and user details.

      • (dict) –

        The user on the Amazon Chime account.

        • UserId (string) –

          The user ID.

        • AccountId (string) –

          The Amazon Chime account ID.

        • PrimaryEmail (string) –

          The primary email address of the user.

        • PrimaryProvisionedNumber (string) –

          The primary phone number associated with the user.

        • DisplayName (string) –

          The display name of the user.

        • LicenseType (string) –

          The license type for the user.

        • UserType (string) –

          The user type.

        • UserRegistrationStatus (string) –

          The user registration status.

        • UserInvitationStatus (string) –

          The user invite status.

        • RegisteredOn (datetime) –

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

        • InvitedOn (datetime) –

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

        • AlexaForBusinessMetadata (dict) –

          The Alexa for Business metadata.

          • IsAlexaForBusinessEnabled (boolean) –

            Starts or stops Alexa for Business.

          • AlexaForBusinessRoomArn (string) –

            The ARN of the room resource.

        • PersonalPIN (string) –

          The user’s personal meeting PIN.

    • NextToken (string) –

      The token to use to retrieve the next page of results.

Exceptions