Class AdminGetUserResponse
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<AdminGetUserResponse.Builder,
AdminGetUserResponse>
Represents the response from the server from the request to get the specified user as an administrator.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic AdminGetUserResponse.Builder
builder()
final Boolean
enabled()
Indicates that the status isenabled
.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkResponse
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MFAOptions property.final boolean
For responses, this returns true if the service returned a value for the UserAttributes property.final boolean
For responses, this returns true if the service returned a value for the UserMFASettingList property.final List
<MFAOptionType> This response parameter is no longer supported. It provides information only about SMS MFA configurations.final String
The user's preferred MFA setting.static Class
<? extends AdminGetUserResponse.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.final List
<AttributeType> An array of name-value pairs representing user attributes.final Instant
The date the user was created.final Instant
The date and time, in ISO 8601 format, when the item was modified.The MFA options that are activated for the user.final String
username()
The username of the user that you requested.final UserStatusType
The user status.final String
The user status.Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse
responseMetadata
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
username
The username of the user that you requested.
- Returns:
- The username of the user that you requested.
-
hasUserAttributes
public final boolean hasUserAttributes()For responses, this returns true if the service returned a value for the UserAttributes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
userAttributes
An array of name-value pairs representing user attributes.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUserAttributes()
method.- Returns:
- An array of name-value pairs representing user attributes.
-
userCreateDate
The date the user was created.
- Returns:
- The date the user was created.
-
userLastModifiedDate
The date and time, in ISO 8601 format, when the item was modified.
- Returns:
- The date and time, in ISO 8601 format, when the item was modified.
-
enabled
Indicates that the status is
enabled
.- Returns:
- Indicates that the status is
enabled
.
-
userStatus
The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
If the service returns an enum value that is not available in the current SDK version,
userStatus
will returnUserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserStatusAsString()
.- Returns:
- The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
-
- See Also:
-
-
userStatusAsString
The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
If the service returns an enum value that is not available in the current SDK version,
userStatus
will returnUserStatusType.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromuserStatusAsString()
.- Returns:
- The user status. Can be one of the following:
-
UNCONFIRMED - User has been created but not confirmed.
-
CONFIRMED - User has been confirmed.
-
UNKNOWN - User status isn't known.
-
RESET_REQUIRED - User is confirmed, but the user must request a code and reset their password before they can sign in.
-
FORCE_CHANGE_PASSWORD - The user is confirmed and the user can sign in using a temporary password, but on first sign-in, the user must change their password to a new value before doing anything else.
-
- See Also:
-
-
hasMfaOptions
public final boolean hasMfaOptions()For responses, this returns true if the service returned a value for the MFAOptions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
mfaOptions
This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasMfaOptions()
method.- Returns:
- This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about time-based one-time password (TOTP) software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.
-
preferredMfaSetting
The user's preferred MFA setting.
- Returns:
- The user's preferred MFA setting.
-
hasUserMFASettingList
public final boolean hasUserMFASettingList()For responses, this returns true if the service returned a value for the UserMFASettingList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
userMFASettingList
The MFA options that are activated for the user. The possible values in this list are
SMS_MFA
andSOFTWARE_TOKEN_MFA
.Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasUserMFASettingList()
method.- Returns:
- The MFA options that are activated for the user. The possible values in this list are
SMS_MFA
andSOFTWARE_TOKEN_MFA
.
-
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<AdminGetUserResponse.Builder,
AdminGetUserResponse> - Specified by:
toBuilder
in classAwsResponse
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsResponse
-
equals
- Overrides:
equals
in classAwsResponse
-
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
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value. -
getValueForField
Description copied from class:SdkResponse
Used to retrieve the value of a field from any class that extendsSdkResponse
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkResponse.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkResponse
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-