Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . connect ]



Describes the specified user account. You can find the instance ID in the 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

See 'aws help' for descriptions of global parameters.


--user-id <value>
--instance-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]


--user-id (string)

The identifier of the user account.

--instance-id (string)

The identifier of the Amazon Connect instance. You can find the instanceId in the ARN of the instance.

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.



To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal's quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To display the details for a user

The following describe-user example displays the details for the specified Amazon Connect user.

aws connect describe-user \
    --user-id 0c245dc0-0cf5-4e37-800e-2a7481cc8a60
    --instance-id 40c83b68-ea62-414c-97bb-d018e39e158e


    "User": {
        "Id": "0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
        "Arn": "arn:aws:connect:us-west-2:123456789012:instance/40c83b68-ea62-414c-97bb-d018e39e158e/agent/0c245dc0-0cf5-4e37-800e-2a7481cc8a60",
        "Username": "Jane",
        "IdentityInfo": {
            "FirstName": "Jane",
            "LastName": "Doe",
            "Email": ""
        "PhoneConfig": {
            "PhoneType": "SOFT_PHONE",
            "AutoAccept": false,
            "AfterContactWorkTimeLimit": 0,
            "DeskPhoneNumber": ""
        "DirectoryUserId": "8b444cf6-b368-4f29-ba18-07af27405658",
        "SecurityProfileIds": [
        "RoutingProfileId": "0be36ee9-2b5f-4ef4-bcf7-87738e5be0e5",
        "Tags": {}

For more information, see Manage Users in the Amazon Connect Administrator Guide.


User -> (structure)

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 -> (structure)

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.

PhoneConfig -> (structure)

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.

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.


RoutingProfileId -> (string)

The identifier of the routing profile for the user.

HierarchyGroupId -> (string)

The identifier of the hierarchy group for the user.

Tags -> (map)

The tags.

key -> (string)

value -> (string)