UserIdentityInfo - Amazon Connect

UserIdentityInfo

Contains information about the identity of a user.

Note

For Amazon Connect instances that are created with the EXISTING_DIRECTORY identity management type, FirstName, LastName, and Email cannot be updated from within Amazon Connect because they are managed by the directory.

Important

The FirstName and LastName length constraints below apply only to instances using SAML for identity management. If you are using Amazon Connect for identity management, the length constraints are 1-255 for FirstName, and 1-256 for LastName.

Contents

Email

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

Type: String

Required: No

FirstName

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 255.

Required: No

LastName

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

Type: String

Length Constraints: Minimum length of 0. Maximum length of 300.

Required: No

Mobile

The user's mobile number.

Type: String

Pattern: \\+[1-9]\\d{1,14}$

Required: No

SecondaryEmail

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}

Type: String

Required: No

See Also

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