Class AdminSetUserSettingsRequest
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
Represents the request to set user settings as an administrator.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
Specifies the options for MFA (e.g., email or phone number).The user name of the user for whom you wish to set user settings.The user pool ID for the user pool where you want to set the user's settings, such as MFA options.int
hashCode()
void
setMFAOptions
(Collection<MFAOptionType> mFAOptions) Specifies the options for MFA (e.g., email or phone number).void
setUsername
(String username) The user name of the user for whom you wish to set user settings.void
setUserPoolId
(String userPoolId) The user pool ID for the user pool where you want to set the user's settings, such as MFA options.toString()
Returns a string representation of this object; useful for testing and debugging.withMFAOptions
(MFAOptionType... mFAOptions) Specifies the options for MFA (e.g., email or phone number).withMFAOptions
(Collection<MFAOptionType> mFAOptions) Specifies the options for MFA (e.g., email or phone number).withUsername
(String username) The user name of the user for whom you wish to set user settings.withUserPoolId
(String userPoolId) The user pool ID for the user pool where you want to set the user's settings, such as MFA options.Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
Constructor Details
-
AdminSetUserSettingsRequest
public AdminSetUserSettingsRequest()
-
-
Method Details
-
setUserPoolId
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
-
getUserPoolId
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
- Returns:
- The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
-
withUserPoolId
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to set the user's settings, such as MFA options.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setUsername
The user name of the user for whom you wish to set user settings.
- Parameters:
username
- The user name of the user for whom you wish to set user settings.
-
getUsername
The user name of the user for whom you wish to set user settings.
- Returns:
- The user name of the user for whom you wish to set user settings.
-
withUsername
The user name of the user for whom you wish to set user settings.
- Parameters:
username
- The user name of the user for whom you wish to set user settings.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getMFAOptions
Specifies the options for MFA (e.g., email or phone number).
- Returns:
- Specifies the options for MFA (e.g., email or phone number).
-
setMFAOptions
Specifies the options for MFA (e.g., email or phone number).
- Parameters:
mFAOptions
- Specifies the options for MFA (e.g., email or phone number).
-
withMFAOptions
Specifies the options for MFA (e.g., email or phone number).
NOTE: This method appends the values to the existing list (if any). Use
setMFAOptions(java.util.Collection)
orwithMFAOptions(java.util.Collection)
if you want to override the existing values.- Parameters:
mFAOptions
- Specifies the options for MFA (e.g., email or phone number).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withMFAOptions
Specifies the options for MFA (e.g., email or phone number).
- Parameters:
mFAOptions
- Specifies the options for MFA (e.g., email or phone number).- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
toString
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
clone
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
-