Connect / Client / describe_user

describe_user

Connect.Client.describe_user(**kwargs)

Describes the specified user account. You can find the instance ID in the Amazon Connect console (it’s the final part of the ARN). The console does not display the user IDs. Instead, list the users and note the IDs provided in the output.

See also: AWS API Documentation

Request Syntax

response = client.describe_user(
    UserId='string',
    InstanceId='string'
)

Parameters:

• UserId (string) –

  [REQUIRED]

  The identifier of the user account.

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

Return type:

dict

Returns:

Response Syntax

{
    'User': {
        'Id': 'string',
        'Arn': 'string',
        'Username': 'string',
        'IdentityInfo': {
            'FirstName': 'string',
            'LastName': 'string',
            'Email': 'string',
            'SecondaryEmail': 'string',
            'Mobile': 'string'
        },
        'PhoneConfig': {
            'PhoneType': 'SOFT_PHONE'|'DESK_PHONE',
            'AutoAccept': True|False,
            'AfterContactWorkTimeLimit': 123,
            'DeskPhoneNumber': 'string'
        },
        'DirectoryUserId': 'string',
        'SecurityProfileIds': [
            'string',
        ],
        'RoutingProfileId': 'string',
        'HierarchyGroupId': 'string',
        'Tags': {
            'string': 'string'
        }
    }
}

Response Structure

• (dict) –

  • User (dict) –

    Information about the user account and configuration settings.

    • Id (string) –

      The identifier of the user account.

    • Arn (string) –

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

    • Username (string) –

      The user name assigned to the user account.

    • IdentityInfo (dict) –

      Information about the user identity.

      • FirstName (string) –

        The first name. This is required if you are using Amazon Connect or SAML for identity management.

      • LastName (string) –

        The last name. This is required if you are using Amazon Connect or SAML for identity management.

      • Email (string) –

        The email address. If you are using SAML for identity management and include this parameter, an error is returned.

      • SecondaryEmail (string) –

        The user’s secondary email address. If you provide a secondary email, the user receives email notifications - other than password reset notifications - to this email address instead of to their primary email address.

        Pattern: (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}

      • Mobile (string) –

        The user’s mobile number.

    • PhoneConfig (dict) –

      Information about the phone configuration for the user.

      • PhoneType (string) –

        The phone type.

      • AutoAccept (boolean) –

        The Auto accept setting.

      • AfterContactWorkTimeLimit (integer) –

        The After Call Work (ACW) timeout setting, in seconds.

        Note

        When returned by a SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.

      • DeskPhoneNumber (string) –

        The phone number for the user’s desk phone.

    • DirectoryUserId (string) –

      The identifier of the user account in the directory used for identity management.

    • SecurityProfileIds (list) –

      The identifiers of the security profiles for the user.

      • (string) –

    • RoutingProfileId (string) –

      The identifier of the routing profile for the user.

    • HierarchyGroupId (string) –

      The identifier of the hierarchy group for the user.

    • Tags (dict) –

      The tags.

      • (string) –

        • (string) –

Exceptions

• Connect.Client.exceptions.InvalidRequestException

• Connect.Client.exceptions.InvalidParameterException

• Connect.Client.exceptions.ResourceNotFoundException

• Connect.Client.exceptions.ThrottlingException

• Connect.Client.exceptions.InternalServiceException