AdminGetUserResponse (AWS Java SDK :: Services :: Amazon Cognito Identity Provider Service 2.11.10 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse
    - - software.amazon.awssdk.services.cognitoidentityprovider.model.AdminGetUserResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class AdminGetUserResponse
extends CognitoIdentityProviderResponse
implements ToCopyableBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>

Represents the response from the server from the request to get the specified user as an administrator.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface AdminGetUserResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`AdminGetUserResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static AdminGetUserResponse.Builder`	`builder()`
`Boolean`	`enabled()` Indicates that the status is enabled.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMfaOptions()` Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserAttributes()` Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasUserMFASettingList()` Returns true if the UserMFASettingList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<MFAOptionType>`	`mfaOptions()` This response parameter is no longer supported. It provides information only about SMS MFA configurations.
`String`	`preferredMfaSetting()` The user's preferred MFA setting.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AdminGetUserResponse.Builder>`	`serializableBuilderClass()`
`AdminGetUserResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<AttributeType>`	`userAttributes()` An array of name-value pairs representing user attributes.
`Instant`	`userCreateDate()` The date the user was created.
`Instant`	`userLastModifiedDate()` The date the user was last modified.
`List<String>`	`userMFASettingList()` The MFA options that are enabled for the user.
`String`	`username()` The user name of the user about whom you are receiving information.
`UserStatusType`	`userStatus()` The user status.
`String`	`userStatusAsString()` 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 class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - username
```
public String username()
```
    The user name of the user about whom you are receiving information.
    
    Returns:
    
    The user name of the user about whom you are receiving information.
  - hasUserAttributes
```
public boolean hasUserAttributes()
```
    Returns true if the UserAttributes property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userAttributes
```
public List<AttributeType> userAttributes()
```
    An array of name-value pairs representing user attributes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserAttributes() to see if a value was sent in this field.
    
    Returns:
    
    An array of name-value pairs representing user attributes.
  - userCreateDate
```
public Instant userCreateDate()
```
    The date the user was created.
    
    Returns:
    
    The date the user was created.
  - userLastModifiedDate
```
public Instant userLastModifiedDate()
```
    The date the user was last modified.
    
    Returns:
    
    The date the user was last modified.
  - enabled
```
public Boolean enabled()
```
    Indicates that the status is enabled.
    
    Returns:
    
    Indicates that the status is enabled.
  - userStatus
```
public UserStatusType 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.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her 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 return UserStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().
    Returns:
    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.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.
    See Also:
    
    UserStatusType
  - userStatusAsString
```
public String userStatusAsString()
```
    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.
    - RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her 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 return UserStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userStatusAsString().
    Returns:
    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.
    
    RESET_REQUIRED - User is confirmed, but the user must request a code and reset his or her password before he or she 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 his or her password to a new value before doing anything else.
    See Also:
    
    UserStatusType
  - hasMfaOptions
```
public boolean hasMfaOptions()
```
    Returns true if the MFAOptions property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - mfaOptions
```
public List<MFAOptionType> mfaOptions()
```
    This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList response instead.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasMfaOptions() to see if a value was sent in this field.
    
    Returns:
    
    This response parameter is no longer supported. It provides information only about SMS MFA configurations. It doesn't provide information about TOTP software token MFA configurations. To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList response instead.
  - preferredMfaSetting
```
public String preferredMfaSetting()
```
    The user's preferred MFA setting.
    
    Returns:
    
    The user's preferred MFA setting.
  - hasUserMFASettingList
```
public boolean hasUserMFASettingList()
```
    Returns true if the UserMFASettingList property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - userMFASettingList
```
public List<String> userMFASettingList()
```
    The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasUserMFASettingList() to see if a value was sent in this field.
    
    Returns:
    
    The MFA options that are enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.
  - toBuilder
```
public AdminGetUserResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AdminGetUserResponse.Builder,AdminGetUserResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static AdminGetUserResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AdminGetUserResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String 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.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class AdminGetUserResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

username

hasUserAttributes

userAttributes

userCreateDate

userLastModifiedDate

enabled

userStatus

userStatusAsString

hasMfaOptions

mfaOptions

preferredMfaSetting

hasUserMFASettingList

userMFASettingList

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields