UpdateUserPoolRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidp.model.UpdateUserPoolRequest

All Implemented Interfaces:

ReadLimitInfo, Serializable, Cloneable
```
public class UpdateUserPoolRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable
```
Represents the request to update the user pool.

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.amazonaws.AmazonWebServiceRequest
  NOOP

Constructor Summary

Constructors
Constructor and Description

UpdateUserPoolRequest()

Constructors
Constructor and Description
`UpdateUserPoolRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateUserPoolRequest`	`clone()` Creates a shallow clone of this request.
`boolean`	`equals(Object obj)`
`List<String>`	`getAutoVerifiedAttributes()` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`DeviceConfigurationType`	`getDeviceConfiguration()` Device configuration.
`EmailConfigurationType`	`getEmailConfiguration()` Email configuration.
`String`	`getEmailVerificationMessage()` The contents of the email verification message.
`String`	`getEmailVerificationSubject()` The subject of the email verfication message
`LambdaConfigType`	`getLambdaConfig()` The AWS Lambda configuration information from the request to update the user pool.
`String`	`getMfaConfiguration()` Can be one of the following values:
`UserPoolPolicyType`	`getPolicies()` A container with the policies you wish to update in a user pool.
`String`	`getSmsAuthenticationMessage()` The contents of the SMS authentication message.
`SmsConfigurationType`	`getSmsConfiguration()` SMS configuration.
`String`	`getSmsVerificationMessage()` A container with information about the SMS verification message.
`String`	`getUserPoolId()` The user pool ID for the user pool you want to update.
`int`	`hashCode()`
`void`	`setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`void`	`setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` Device configuration.
`void`	`setEmailConfiguration(EmailConfigurationType emailConfiguration)` Email configuration.
`void`	`setEmailVerificationMessage(String emailVerificationMessage)` The contents of the email verification message.
`void`	`setEmailVerificationSubject(String emailVerificationSubject)` The subject of the email verfication message
`void`	`setLambdaConfig(LambdaConfigType lambdaConfig)` The AWS Lambda configuration information from the request to update the user pool.
`void`	`setMfaConfiguration(String mfaConfiguration)` Can be one of the following values:
`void`	`setMfaConfiguration(UserPoolMfaType mfaConfiguration)` Can be one of the following values:
`void`	`setPolicies(UserPoolPolicyType policies)` A container with the policies you wish to update in a user pool.
`void`	`setSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`void`	`setSmsConfiguration(SmsConfigurationType smsConfiguration)` SMS configuration.
`void`	`setSmsVerificationMessage(String smsVerificationMessage)` A container with information about the SMS verification message.
`void`	`setUserPoolId(String userPoolId)` The user pool ID for the user pool you want to update.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateUserPoolRequest`	`withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`UpdateUserPoolRequest`	`withAutoVerifiedAttributes(String... autoVerifiedAttributes)` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`UpdateUserPoolRequest`	`withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)` The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
`UpdateUserPoolRequest`	`withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)` Device configuration.
`UpdateUserPoolRequest`	`withEmailConfiguration(EmailConfigurationType emailConfiguration)` Email configuration.
`UpdateUserPoolRequest`	`withEmailVerificationMessage(String emailVerificationMessage)` The contents of the email verification message.
`UpdateUserPoolRequest`	`withEmailVerificationSubject(String emailVerificationSubject)` The subject of the email verfication message
`UpdateUserPoolRequest`	`withLambdaConfig(LambdaConfigType lambdaConfig)` The AWS Lambda configuration information from the request to update the user pool.
`UpdateUserPoolRequest`	`withMfaConfiguration(String mfaConfiguration)` Can be one of the following values:
`UpdateUserPoolRequest`	`withMfaConfiguration(UserPoolMfaType mfaConfiguration)` Can be one of the following values:
`UpdateUserPoolRequest`	`withPolicies(UserPoolPolicyType policies)` A container with the policies you wish to update in a user pool.
`UpdateUserPoolRequest`	`withSmsAuthenticationMessage(String smsAuthenticationMessage)` The contents of the SMS authentication message.
`UpdateUserPoolRequest`	`withSmsConfiguration(SmsConfigurationType smsConfiguration)` SMS configuration.
`UpdateUserPoolRequest`	`withSmsVerificationMessage(String smsVerificationMessage)` A container with information about the SMS verification message.
`UpdateUserPoolRequest`	`withUserPoolId(String userPoolId)` The user pool ID for the user pool you want to update.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - UpdateUserPoolRequest
```
public UpdateUserPoolRequest()
```
- Method Detail
  - setUserPoolId
```
public void setUserPoolId(String userPoolId)
```
    The user pool ID for the user pool you want to update.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool you want to update.
  - getUserPoolId
```
public String getUserPoolId()
```
    The user pool ID for the user pool you want to update.
    
    Returns:
    
    The user pool ID for the user pool you want to update.
  - withUserPoolId
```
public UpdateUserPoolRequest withUserPoolId(String userPoolId)
```
    The user pool ID for the user pool you want to update.
    
    Parameters:
    
    userPoolId - The user pool ID for the user pool you want to update.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setPolicies
```
public void setPolicies(UserPoolPolicyType policies)
```
    A container with the policies you wish to update in a user pool.
    
    Parameters:
    
    policies - A container with the policies you wish to update in a user pool.
  - getPolicies
```
public UserPoolPolicyType getPolicies()
```
    A container with the policies you wish to update in a user pool.
    
    Returns:
    
    A container with the policies you wish to update in a user pool.
  - withPolicies
```
public UpdateUserPoolRequest withPolicies(UserPoolPolicyType policies)
```
    A container with the policies you wish to update in a user pool.
    
    Parameters:
    
    policies - A container with the policies you wish to update in a user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLambdaConfig
```
public void setLambdaConfig(LambdaConfigType lambdaConfig)
```
    The AWS Lambda configuration information from the request to update the user pool.
    
    Parameters:
    
    lambdaConfig - The AWS Lambda configuration information from the request to update the user pool.
  - getLambdaConfig
```
public LambdaConfigType getLambdaConfig()
```
    The AWS Lambda configuration information from the request to update the user pool.
    
    Returns:
    
    The AWS Lambda configuration information from the request to update the user pool.
  - withLambdaConfig
```
public UpdateUserPoolRequest withLambdaConfig(LambdaConfigType lambdaConfig)
```
    The AWS Lambda configuration information from the request to update the user pool.
    
    Parameters:
    
    lambdaConfig - The AWS Lambda configuration information from the request to update the user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAutoVerifiedAttributes
```
public List<String> getAutoVerifiedAttributes()
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns:
    
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    See Also:
    
    VerifiedAttributeType
  - setAutoVerifiedAttributes
```
public void setAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(String... autoVerifiedAttributes)
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    NOTE: This method appends the values to the existing list (if any). Use setAutoVerifiedAttributes(java.util.Collection) or withAutoVerifiedAttributes(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(Collection<String> autoVerifiedAttributes)
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - withAutoVerifiedAttributes
```
public UpdateUserPoolRequest withAutoVerifiedAttributes(VerifiedAttributeType... autoVerifiedAttributes)
```
    The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Parameters:
    
    autoVerifiedAttributes - The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    VerifiedAttributeType
  - setSmsVerificationMessage
```
public void setSmsVerificationMessage(String smsVerificationMessage)
```
    A container with information about the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - A container with information about the SMS verification message.
  - getSmsVerificationMessage
```
public String getSmsVerificationMessage()
```
    A container with information about the SMS verification message.
    
    Returns:
    
    A container with information about the SMS verification message.
  - withSmsVerificationMessage
```
public UpdateUserPoolRequest withSmsVerificationMessage(String smsVerificationMessage)
```
    A container with information about the SMS verification message.
    
    Parameters:
    
    smsVerificationMessage - A container with information about the SMS verification message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailVerificationMessage
```
public void setEmailVerificationMessage(String emailVerificationMessage)
```
    The contents of the email verification message.
    
    Parameters:
    
    emailVerificationMessage - The contents of the email verification message.
  - getEmailVerificationMessage
```
public String getEmailVerificationMessage()
```
    The contents of the email verification message.
    
    Returns:
    
    The contents of the email verification message.
  - withEmailVerificationMessage
```
public UpdateUserPoolRequest withEmailVerificationMessage(String emailVerificationMessage)
```
    The contents of the email verification message.
    
    Parameters:
    
    emailVerificationMessage - The contents of the email verification message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailVerificationSubject
```
public void setEmailVerificationSubject(String emailVerificationSubject)
```
    The subject of the email verfication message
    
    Parameters:
    
    emailVerificationSubject - The subject of the email verfication message
  - getEmailVerificationSubject
```
public String getEmailVerificationSubject()
```
    The subject of the email verfication message
    
    Returns:
    
    The subject of the email verfication message
  - withEmailVerificationSubject
```
public UpdateUserPoolRequest withEmailVerificationSubject(String emailVerificationSubject)
```
    The subject of the email verfication message
    
    Parameters:
    
    emailVerificationSubject - The subject of the email verfication message
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsAuthenticationMessage
```
public void setSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - The contents of the SMS authentication message.
  - getSmsAuthenticationMessage
```
public String getSmsAuthenticationMessage()
```
    The contents of the SMS authentication message.
    
    Returns:
    
    The contents of the SMS authentication message.
  - withSmsAuthenticationMessage
```
public UpdateUserPoolRequest withSmsAuthenticationMessage(String smsAuthenticationMessage)
```
    The contents of the SMS authentication message.
    
    Parameters:
    
    smsAuthenticationMessage - The contents of the SMS authentication message.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMfaConfiguration
```
public void setMfaConfiguration(String mfaConfiguration)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - getMfaConfiguration
```
public String getMfaConfiguration()
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Returns:
    Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public UpdateUserPoolRequest withMfaConfiguration(String mfaConfiguration)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public UpdateUserPoolRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    Can be one of the following values:
    - OFF - MFA tokens are not required and cannot be specified during user registration.
    - ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    - OPTIONAL - Users have the option when registering to create an MFA token.
    Parameters:
    mfaConfiguration - Can be one of the following values:
    
    OFF - MFA tokens are not required and cannot be specified during user registration.
    
    ON - MFA tokens are required for all user registrations. You can only specify required when you are initially creating a user pool.
    
    OPTIONAL - Users have the option when registering to create an MFA token.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setDeviceConfiguration
```
public void setDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    Device configuration.
    
    Parameters:
    
    deviceConfiguration - Device configuration.
  - getDeviceConfiguration
```
public DeviceConfigurationType getDeviceConfiguration()
```
    Device configuration.
    
    Returns:
    
    Device configuration.
  - withDeviceConfiguration
```
public UpdateUserPoolRequest withDeviceConfiguration(DeviceConfigurationType deviceConfiguration)
```
    Device configuration.
    
    Parameters:
    
    deviceConfiguration - Device configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setEmailConfiguration
```
public void setEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    Email configuration.
    
    Parameters:
    
    emailConfiguration - Email configuration.
  - getEmailConfiguration
```
public EmailConfigurationType getEmailConfiguration()
```
    Email configuration.
    
    Returns:
    
    Email configuration.
  - withEmailConfiguration
```
public UpdateUserPoolRequest withEmailConfiguration(EmailConfigurationType emailConfiguration)
```
    Email configuration.
    
    Parameters:
    
    emailConfiguration - Email configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSmsConfiguration
```
public void setSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    SMS configuration.
    
    Parameters:
    
    smsConfiguration - SMS configuration.
  - getSmsConfiguration
```
public SmsConfigurationType getSmsConfiguration()
```
    SMS configuration.
    
    Returns:
    
    SMS configuration.
  - withSmsConfiguration
```
public UpdateUserPoolRequest withSmsConfiguration(SmsConfigurationType smsConfiguration)
```
    SMS configuration.
    
    Parameters:
    
    smsConfiguration - SMS configuration.
    
    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; useful for testing and debugging.
    
    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 UpdateUserPoolRequest 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 class AmazonWebServiceRequest
    
    See Also:
    
    Object.clone()

Did this page help you?

Class UpdateUserPoolRequest

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateUserPoolRequest

Method Detail

setUserPoolId

getUserPoolId

withUserPoolId

setPolicies

getPolicies

withPolicies

setLambdaConfig

getLambdaConfig

withLambdaConfig

getAutoVerifiedAttributes

setAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

withAutoVerifiedAttributes

setSmsVerificationMessage

getSmsVerificationMessage

withSmsVerificationMessage

setEmailVerificationMessage

getEmailVerificationMessage

withEmailVerificationMessage

setEmailVerificationSubject

getEmailVerificationSubject

withEmailVerificationSubject

setSmsAuthenticationMessage

getSmsAuthenticationMessage

withSmsAuthenticationMessage

setMfaConfiguration

getMfaConfiguration

withMfaConfiguration

setMfaConfiguration

withMfaConfiguration

setDeviceConfiguration

getDeviceConfiguration

withDeviceConfiguration

setEmailConfiguration

getEmailConfiguration

withEmailConfiguration

setSmsConfiguration

getSmsConfiguration

withSmsConfiguration

toString

equals

hashCode

clone