Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . chime ]

get-user

Description

Retrieves details for the specified user ID, such as primary email address, license type, and personal meeting PIN.

To retrieve user details with an email address instead of a user ID, use the ListUsers action, and then filter by email address.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

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

Options

--account-id (string)

The Amazon Chime account ID.

--user-id (string)

The user ID.

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

Examples

To get details about a user

The following get-user example retrieves the details for the specified user.

aws chime get-user \
    --account-id a1b2c3d4-5678-90ab-cdef-11111EXAMPLE \
    --user-id a1b2c3d4-5678-90ab-cdef-22222EXAMPLE

Output:

{
    "User": {
        "UserId": "a1b2c3d4-5678-90ab-cdef-22222EXAMPLE",
        "AccountId": "a1b2c3d4-5678-90ab-cdef-11111EXAMPLE",
        "PrimaryEmail": "marthar@example.com",
        "DisplayName": "Martha Rivera",
        "LicenseType": "Pro",
        "UserRegistrationStatus": "Registered",
        "RegisteredOn": "2018-12-20T18:45:25.231Z",
        "PersonalPIN": "XXXXXXXXXX"
    }
}

For more information, see Managing Users in the Amazon Chime Administration Guide.

Output

User -> (structure)

The user details.

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.

UserRegistrationStatus -> (string)

The user registration status.

UserInvitationStatus -> (string)

The user invite status.

RegisteredOn -> (timestamp)

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

InvitedOn -> (timestamp)

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.