com.amazonaws.services.cognitoidp.model

Class GetUserResult

java.lang.Object

com.amazonaws.AmazonWebServiceResult<ResponseMetadata>

com.amazonaws.services.cognitoidp.model.GetUserResult

All Implemented Interfaces:

Serializable, Cloneable

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

Represents the response from the server from the request to get information about the user.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetUserResult()

Method Summary

Modifier and Type	Method and Description
GetUserResult	clone()
boolean	equals(Object obj)
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.
List<String>	getUserMFASettingList() The MFA options that are enabled for the user.
String	getUsername() The user name of the user you wish to retrieve from the get user request.
int	hashCode()
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	setUserMFASettingList(Collection<String> userMFASettingList) The MFA options that are enabled for the user.
void	setUsername(String username) The user name of the user you wish to retrieve from the get user request.
String	toString() Returns a string representation of this object.
GetUserResult	withMFAOptions(Collection<MFAOptionType> mFAOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
GetUserResult	withMFAOptions(MFAOptionType... mFAOptions) This response parameter is no longer supported. It provides information only about SMS MFA configurations.
GetUserResult	withPreferredMfaSetting(String preferredMfaSetting) The user's preferred MFA setting.
GetUserResult	withUserAttributes(AttributeType... userAttributes) An array of name-value pairs representing user attributes.
GetUserResult	withUserAttributes(Collection<AttributeType> userAttributes) An array of name-value pairs representing user attributes.
GetUserResult	withUserMFASettingList(Collection<String> userMFASettingList) The MFA options that are enabled for the user.
GetUserResult	withUserMFASettingList(String... userMFASettingList) The MFA options that are enabled for the user.
GetUserResult	withUsername(String username) The user name of the user you wish to retrieve from the get user request.

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

GetUserResult

public GetUserResult()

Method Detail

setUsername

public void setUsername(String username)

The user name of the user you wish to retrieve from the get user request.

Parameters:

username - The user name of the user you wish to retrieve from the get user request.

getUsername

public String getUsername()

The user name of the user you wish to retrieve from the get user request.

Returns:

The user name of the user you wish to retrieve from the get user request.

withUsername

public GetUserResult withUsername(String username)

The user name of the user you wish to retrieve from the get user request.

Parameters:

username - The user name of the user you wish to retrieve from the get user request.

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.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

setUserAttributes

public void setUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

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

For custom attributes, you must prepend the custom: prefix to the attribute name.

withUserAttributes

public GetUserResult withUserAttributes(AttributeType... userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

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.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

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

withUserAttributes

public GetUserResult withUserAttributes(Collection<AttributeType> userAttributes)

An array of name-value pairs representing user attributes.

For custom attributes, you must prepend the custom: prefix to the attribute name.

Parameters:

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

For custom attributes, you must prepend the custom: prefix to the attribute name.

Returns:

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

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 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 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 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 TOTP software token MFA configurations. To look up information about either type of MFA configuration, use UserMFASettingList instead.

withMFAOptions

public GetUserResult withMFAOptions(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 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 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 GetUserResult 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 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 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 GetUserResult 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 enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Returns:

The MFA options that are enabled 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 enabled for the user. The possible values in this list are SMS_MFA and SOFTWARE_TOKEN_MFA.

Parameters:

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

withUserMFASettingList

public GetUserResult withUserMFASettingList(String... userMFASettingList)

The MFA options that are enabled 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 enabled 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 GetUserResult withUserMFASettingList(Collection<String> userMFASettingList)

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

Parameters:

userMFASettingList - The MFA options that are enabled 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 GetUserResult clone()

Overrides:

clone in class Object