Class UserIdentityInfo
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<UserIdentityInfo.Builder,
UserIdentityInfo>
Contains information about the identity of a user.
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.
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
.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic UserIdentityInfo.Builder
builder()
final String
email()
The email address.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final String
The first name.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final String
lastName()
The last name.final String
mobile()
The user's mobile number.final String
The user's secondary email address.static Class
<? extends UserIdentityInfo.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
firstName
The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
- Returns:
- The first name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
-
lastName
The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
- Returns:
- The last name. This is required if you are using Amazon Connect or SAML for identity management. Inputs must be in Unicode Normalization Form C (NFC). Text containing characters in a non-NFC form (for example, decomposed characters or combining marks) are not accepted.
-
email
The email address. If you are using SAML for identity management and include this parameter, an error is returned.
- Returns:
- The email address. If you are using SAML for identity management and include this parameter, an error is returned.
-
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}
- Returns:
- 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}
-
mobile
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UserIdentityInfo.Builder,
UserIdentityInfo> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
- Returns:
- The mapping between the field name and its corresponding field.
-