com.amazonaws.services.cognitoidentityprovider.model

Class AdminSetUserSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserSettingsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class AdminSetUserSettingsRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable

This action is no longer supported. You can use it to configure only SMS MFA. You can't use it to configure time-based one-time password (TOTP) software token MFA. To configure either type of MFA, use AdminSetUserMFAPreference instead.

Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more

• Signing Amazon Web Services API Requests

• Using the Amazon Cognito user pools API and user pool endpoints

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminSetUserSettingsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.util.List<MFAOptionType>	getMFAOptions() You can use this parameter only to set an SMS configuration that uses SMS for delivery.
java.lang.String	getUsername() The user name of the user whose options you're setting.
java.lang.String	getUserPoolId() The ID of the user pool that contains the user whose options you're setting.
int	hashCode()
void	setMFAOptions(java.util.Collection<MFAOptionType> mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
void	setUsername(java.lang.String username) The user name of the user whose options you're setting.
void	setUserPoolId(java.lang.String userPoolId) The ID of the user pool that contains the user whose options you're setting.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminSetUserSettingsRequest	withMFAOptions(java.util.Collection<MFAOptionType> mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
AdminSetUserSettingsRequest	withMFAOptions(MFAOptionType... mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
AdminSetUserSettingsRequest	withUsername(java.lang.String username) The user name of the user whose options you're setting.
AdminSetUserSettingsRequest	withUserPoolId(java.lang.String userPoolId) The ID of the user pool that contains the user whose options you're setting.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

AdminSetUserSettingsRequest

public AdminSetUserSettingsRequest()

Method Detail

getUserPoolId

public java.lang.String getUserPoolId()

The ID of the user pool that contains the user whose options you're setting.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Returns:

The ID of the user pool that contains the user whose options you're setting.

setUserPoolId

public void setUserPoolId(java.lang.String userPoolId)

The ID of the user pool that contains the user whose options you're setting.

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The ID of the user pool that contains the user whose options you're setting.

withUserPoolId

public AdminSetUserSettingsRequest withUserPoolId(java.lang.String userPoolId)

The ID of the user pool that contains the user whose options you're setting.

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

Constraints:
Length: 1 - 55
Pattern: [\w-]+_[0-9a-zA-Z]+

Parameters:

userPoolId -

The ID of the user pool that contains the user whose options you're setting.

Returns:

A reference to this updated object so that method calls can be chained together.

getUsername

public java.lang.String getUsername()

The user name of the user whose options you're setting.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Returns:

The user name of the user whose options you're setting.

setUsername

public void setUsername(java.lang.String username)

The user name of the user whose options you're setting.

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user whose options you're setting.

withUsername

public AdminSetUserSettingsRequest withUsername(java.lang.String username)

The user name of the user whose options you're setting.

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

Constraints:
Length: 1 - 128
Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+

Parameters:

username -

The user name of the user whose options you're setting.

Returns:

A reference to this updated object so that method calls can be chained together.

getMFAOptions

public java.util.List<MFAOptionType> getMFAOptions()

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

setMFAOptions

public void setMFAOptions(java.util.Collection<MFAOptionType> mFAOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Parameters:

mFAOptions -

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

withMFAOptions

public AdminSetUserSettingsRequest withMFAOptions(MFAOptionType... mFAOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

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

Parameters:

mFAOptions -

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

A reference to this updated object so that method calls can be chained together.

withMFAOptions

public AdminSetUserSettingsRequest withMFAOptions(java.util.Collection<MFAOptionType> mFAOptions)

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

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

Parameters:

mFAOptions -

You can use this parameter only to set an SMS configuration that uses SMS for delivery.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object