Amazon Chime

{'UserEmail': 'string'}

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

client.list_users(
    AccountId='string',
    UserEmail='string',
    MaxResults=123,
    NextToken='string'
)

type AccountId

string

param AccountId

[REQUIRED]

The Amazon Chime account ID.

type UserEmail

string

param UserEmail

Optional. The user email address used to filter results. Maximum 1.

type MaxResults

integer

param MaxResults

The maximum number of results to return in a single call. Defaults to 100.

type NextToken

string

param NextToken

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

rtype

dict

returns

Response Syntax

{
    'Users': [
        {
            'UserId': 'string',
            'AccountId': 'string',
            'PrimaryEmail': 'string',
            'DisplayName': 'string',
            'LicenseType': 'Basic'|'Plus'|'Pro'|'ProTrial',
            'UserRegistrationStatus': 'Unregistered'|'Registered'|'Suspended',
            'UserInvitationStatus': 'Pending'|'Accepted'|'Failed',
            'RegisteredOn': datetime(2015, 1, 1),
            'InvitedOn': datetime(2015, 1, 1),
            '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.

      • DisplayName (string) --

        The display name of the user.

      • LicenseType (string) --

        The license type for the user.

      • 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.

      • PersonalPIN (string) --

        The user's personal meeting PIN.

  • NextToken (string) --

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