Amazon Cognito Identity Provider
API Reference (API Version 2016-04-18)

UserType

The user type.

Contents

Attributes

A container with information about the user type attributes.

Type: Array of AttributeType objects

Required: No

Enabled

Specifies whether the user is enabled.

Type: Boolean

Required: No

MFAOptions

The MFA options for the user.

Type: Array of MFAOptionType objects

Required: No

UserCreateDate

The creation date of the user.

Type: Timestamp

Required: No

UserLastModifiedDate

The last modified date of the user.

Type: Timestamp

Required: No

Username

The user name of the user you wish to describe.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Required: No

UserStatus

The user status. Can be one of the following:

  • UNCONFIRMED - User has been created but not confirmed.

  • CONFIRMED - User has been confirmed.

  • ARCHIVED - User is no longer active.

  • COMPROMISED - User is disabled due to a potential security threat.

  • UNKNOWN - User status is not known.

Type: String

Valid Values: UNCONFIRMED | CONFIRMED | ARCHIVED | COMPROMISED | UNKNOWN | RESET_REQUIRED | FORCE_CHANGE_PASSWORD

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: