com.amazonaws.services.cognitoidentityprovider.model

Class SetUserSettingsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.SetUserSettingsRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class SetUserSettingsRequest
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 SetUserMFAPreference instead.

Amazon Cognito doesn't evaluate Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you can't use IAM credentials to authorize requests, and you can't grant IAM permissions in policies. For more information about authorization models in Amazon Cognito, see Using the Amazon Cognito native and OIDC APIs.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetUserSettingsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
java.lang.String	getAccessToken() A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
java.util.List<MFAOptionType>	getMFAOptions() You can use this parameter only to set an SMS configuration that uses SMS for delivery.
int	hashCode()
void	setAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
void	setMFAOptions(java.util.Collection<MFAOptionType> mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
SetUserSettingsRequest	withAccessToken(java.lang.String accessToken) A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.
SetUserSettingsRequest	withMFAOptions(java.util.Collection<MFAOptionType> mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.
SetUserSettingsRequest	withMFAOptions(MFAOptionType... mFAOptions) You can use this parameter only to set an SMS configuration that uses SMS for delivery.

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

SetUserSettingsRequest

public SetUserSettingsRequest()

Method Detail

getAccessToken

public java.lang.String getAccessToken()

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Returns:

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

setAccessToken

public void setAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

withAccessToken

public SetUserSettingsRequest withAccessToken(java.lang.String accessToken)

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

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

Constraints:
Pattern: [A-Za-z0-9-_=.]+

Parameters:

accessToken -

A valid access token that Amazon Cognito issued to the user whose user settings you want to configure.

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 SetUserSettingsRequest 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 SetUserSettingsRequest 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