Amazon Chime
API Reference (API Version 2018-05-01)

The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

User

The user on the Amazon Chime account.

Contents

AccountId

The Amazon Chime account ID.

Type: String

Required: No

DisplayName

The display name of the user.

Type: String

Required: No

InvitedOn

Date and time when the user is invited to the Amazon Chime account, in ISO 8601 format.

Type: Timestamp

Required: No

LicenseType

The license type for the user.

Type: String

Valid Values: Basic | Plus | Pro | ProTrial

Required: No

PersonalPIN

The user's personal meeting PIN.

Type: String

Required: No

PrimaryEmail

The primary email address of the user.

Type: String

Pattern: .+@.+\..+

Required: No

PrimaryProvisionedNumber

The primary phone number associated with the user.

Type: String

Required: No

RegisteredOn

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

Type: Timestamp

Required: No

UserId

The user ID.

Type: String

Required: Yes

UserInvitationStatus

The user invite status.

Type: String

Valid Values: Pending | Accepted | Failed

Required: No

UserRegistrationStatus

The user registration status.

Type: String

Valid Values: Unregistered | Registered | Suspended

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: