list_users

Connect.Client.list_users(**kwargs)

Provides summary information about the users for the specified Amazon Connect instance.

See also: AWS API Documentation

Request Syntax

response = client.list_users(
    InstanceId='string',
    NextToken='string',
    MaxResults=123
)

Parameters

• InstanceId (string) --

  [REQUIRED]

  The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

• NextToken (string) -- The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
• MaxResults (integer) -- The maximum number of results to return per page. The default MaxResult size is 100.

Return type

dict

Returns

Response Syntax

{
    'UserSummaryList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Username': 'string'
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • UserSummaryList (list) --

    Information about the users.

    • (dict) --

      Contains summary information about a user.

      • Id (string) --

        The identifier of the user account.

      • Arn (string) --

        The Amazon Resource Name (ARN) of the user account.

      • Username (string) --

        The Amazon Connect user name of the user account.

  • NextToken (string) --

    If there are additional results, this is the token for the next set of results.

Exceptions

• Connect.Client.exceptions.InvalidRequestException
• Connect.Client.exceptions.InvalidParameterException
• Connect.Client.exceptions.ResourceNotFoundException
• Connect.Client.exceptions.ThrottlingException
• Connect.Client.exceptions.InternalServiceException