com.amazonaws.services.cognitoidp.model

Class AdminGetUserResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.cognitoidp.model.AdminGetUserResult

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminGetUserResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

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

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminGetUserResult()

Method Summary

Modifier and Type	Method and Description
AdminGetUserResult	clone()
boolean	equals(Object obj)
Boolean	getEnabled() Indicates that the status is enabled.
List<MFAOptionType>	getMFAOptions() This response parameter is no longer supported. It provides information only about SMS MFA configurations.
String	getPreferredMfaSetting() The user's preferred MFA setting.
List<AttributeType>	getUserAttributes() An array of name-value pairs representing user attributes.
Date	getUserCreateDate() The date the user was created.
Date	getUserLastModifiedDate() The date and time when the item was modified.
List<String>	getUserMFASettingList() The MFA options that are activated for the user.
String	getUsername() The username of the user that you requested.
String	getUserStatus() The user status.
int	hashCode()
Boolean	isEnabled() Indicates that the status is enabled.
void	setEnabled(Boolean enabled) Indicates that the status is enabled.
void	setMFAOptions(Collection<MFAOptionType> mFAOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
void	setPreferredMfaSetting(String preferredMfaSetting) The user's preferred MFA setting.
void	setUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
void	setUserCreateDate(Date userCreateDate) The date the user was created.
void	setUserLastModifiedDate(Date userLastModifiedDate) The date and time when the item was modified.
void	setUserMFASettingList(Collection<String> userMFASettingList) The MFA options that are activated for the user.
void	setUsername(String username) The username of the user that you requested.
void	setUserStatus(String userStatus) The user status.
void	setUserStatus(UserStatusType userStatus) The user status.
String	toString() Returns a string representation of this object.
AdminGetUserResult	withEnabled(Boolean enabled) Indicates that the status is enabled.
AdminGetUserResult	withMFAOptions(Collection<MFAOptionType> mFAOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
AdminGetUserResult	withMFAOptions(MFAOptionType... mFAOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
AdminGetUserResult	withPreferredMfaSetting(String preferredMfaSetting) The user's preferred MFA setting.
AdminGetUserResult	withUserAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
AdminGetUserResult	withUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
AdminGetUserResult	withUserCreateDate(Date userCreateDate) The date the user was created.
AdminGetUserResult	withUserLastModifiedDate(Date userLastModifiedDate) The date and time when the item was modified.
AdminGetUserResult	withUserMFASettingList(Collection<String> userMFASettingList) The MFA options that are activated for the user.
AdminGetUserResult	withUserMFASettingList(String... userMFASettingList) The MFA options that are activated for the user.
AdminGetUserResult	withUsername(String username) The username of the user that you requested.
AdminGetUserResult	withUserStatus(String userStatus) The user status.
AdminGetUserResult	withUserStatus(UserStatusType userStatus) The user status.

Methods inherited from class com.amazonaws.AmazonWebServiceResult

getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminGetUserResult

public AdminGetUserResult()

Method Detail

setUsername

public void setUsername(String username)

The username of the user that you requested.

Parameters:

username - The username of the user that you requested.

getUsername

public String getUsername()

The username of the user that you requested.

Returns:

The username of the user that you requested.

withUsername

public AdminGetUserResult withUsername(String username)

The username of the user that you requested.

Parameters:

username - The username of the user that you requested.

Returns:

Returns a reference to this object so that method calls can be chained together.

getUserAttributes

public List<AttributeType> getUserAttributes()

An array of name-value pairs representing user attributes.

Returns:

An array of name-value pairs representing user attributes.

setUserAttributes

public void setUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

withUserAttributes

public AdminGetUserResult withUserAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

NOTE: This method appends the values to the existing list (if any). Use setUserAttributes(java.util.Collection) or withUserAttributes(java.util.Collection) if you want to override the existing values.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

withUserAttributes

public AdminGetUserResult withUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

Parameters:

userAttributes - An array of name-value pairs representing user attributes.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserCreateDate

public void setUserCreateDate(Date userCreateDate)

The date the user was created.

Parameters:

userCreateDate - The date the user was created.

getUserCreateDate

public Date getUserCreateDate()

The date the user was created.

Returns:

The date the user was created.

withUserCreateDate

public AdminGetUserResult withUserCreateDate(Date userCreateDate)

The date the user was created.

Parameters:

userCreateDate - The date the user was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

setUserLastModifiedDate

public void setUserLastModifiedDate(Date userLastModifiedDate)

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Parameters:

userLastModifiedDate - The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

getUserLastModifiedDate

public Date getUserLastModifiedDate()

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

withUserLastModifiedDate

public AdminGetUserResult withUserLastModifiedDate(Date userLastModifiedDate)

The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Parameters:

userLastModifiedDate - The date and time when the item was modified. Amazon Cognito returns this timestamp in UNIX epoch time format. Your SDK might render the output in a human-readable format like ISO 8601 or a Java Date object.

Returns:

Returns a reference to this object so that method calls can be chained together.

setEnabled

public void setEnabled(Boolean enabled)

Indicates that the status is enabled.

Parameters:

enabled - Indicates that the status is enabled.

getEnabled

public Boolean getEnabled()

Indicates that the status is enabled.

Returns:

Indicates that the status is enabled.

withEnabled

public AdminGetUserResult withEnabled(Boolean enabled)

Indicates that the status is enabled.

Parameters:

enabled - Indicates that the status is enabled.

Returns:

Returns a reference to this object so that method calls can be chained together.

isEnabled

public Boolean isEnabled()

Indicates that the status is enabled.

Returns:

Indicates that the status is enabled.

setUserStatus

public void setUserStatus(String 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.

Parameters:

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.

See Also:

UserStatusType

getUserStatus

public String getUserStatus()

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.

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:

UserStatusType

withUserStatus

public AdminGetUserResult withUserStatus(String 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserStatusType

setUserStatus

public void setUserStatus(UserStatusType 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.

Parameters:

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.

See Also:

UserStatusType

withUserStatus

public AdminGetUserResult withUserStatus(UserStatusType 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

UserStatusType

getMFAOptions

public List<MFAOptionType> getMFAOptions()

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.

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.

setMFAOptions

public void setMFAOptions(Collection<MFAOptionType> 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.

Parameters:

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.

withMFAOptions

public AdminGetUserResult withMFAOptions(MFAOptionType... 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.

NOTE: This method appends the values to the existing list (if any). Use setMFAOptions(java.util.Collection) or withMFAOptions(java.util.Collection) if you want to override the existing values.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

withMFAOptions

public AdminGetUserResult withMFAOptions(Collection<MFAOptionType> 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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPreferredMfaSetting

public void setPreferredMfaSetting(String preferredMfaSetting)

The user's preferred MFA setting.

Parameters:

preferredMfaSetting - The user's preferred MFA setting.

getPreferredMfaSetting

public String getPreferredMfaSetting()

The user's preferred MFA setting.

Returns:

The user's preferred MFA setting.

withPreferredMfaSetting

public AdminGetUserResult withPreferredMfaSetting(String preferredMfaSetting)

The user's preferred MFA setting.

Parameters:

preferredMfaSetting - The user's preferred MFA setting.

Returns:

Returns a reference to this object so that method calls can be chained together.

getUserMFASettingList

public List<String> getUserMFASettingList()

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

setUserMFASettingList

public void setUserMFASettingList(Collection<String> userMFASettingList)

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Parameters:

userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

withUserMFASettingList

public AdminGetUserResult withUserMFASettingList(String... userMFASettingList)

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

NOTE: This method appends the values to the existing list (if any). Use setUserMFASettingList(java.util.Collection) or withUserMFASettingList(java.util.Collection) if you want to override the existing values.

Parameters:

userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

Returns a reference to this object so that method calls can be chained together.

withUserMFASettingList

public AdminGetUserResult withUserMFASettingList(Collection<String> userMFASettingList)

The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Parameters:

userMFASettingList - The MFA options that are activated for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

Returns a reference to this object so that method calls can be chained together.

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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public AdminGetUserResult clone()

Overrides:

clone in class Object