aws cognito-idp update-user-pool
Updates the specified user pool with the specified attributes. You can get a list of the current user pool settings using DescribeUserPool. If you don't provide a value for an attribute, it will be set to the default value
Options
| Name | Description |
|---|---|
--user-pool-id <string> | The user pool ID for the user pool you want to update |
--policies <structure> | A container with the policies you wish to update in a user pool |
--lambda-config <structure> | The AWS Lambda configuration information from the request to update the user pool |
--auto-verified-attributes <list> | The attributes that are automatically verified when the Amazon Cognito service makes a request to update user pools |
--sms-verification-message <string> | A container with information about the SMS verification message |
--email-verification-message <string> | The contents of the email verification message |
--email-verification-subject <string> | The subject of the email verification message |
--verification-message-template <structure> | The template for verification messages |
--sms-authentication-message <string> | The contents of the SMS authentication message |
--mfa-configuration <string> | 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 ON when you are initially creating a user pool. You can use the SetUserPoolMfaConfig API operation to turn MFA "ON" for existing user pools. OPTIONAL - Users have the option when registering to create an MFA token |
--device-configuration <structure> | Device configuration |
--email-configuration <structure> | Email configuration |
--sms-configuration <structure> | SMS configuration |
--user-pool-tags <map> | The tag keys and values to assign to the user pool. A tag is a label that you can use to categorize and manage user pools in different ways, such as by purpose, owner, environment, or other criteria |
--admin-create-user-config <structure> | The configuration for AdminCreateUser requests |
--user-pool-add-ons <structure> | Used to enable advanced security risk detection. Set the key AdvancedSecurityMode to the value "AUDIT" |
--account-recovery-setting <structure> | Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email |
--cli-input-json <string> | Performs service operation based on the JSON string provided. The JSON string follows the format provided by ``--generate-cli-skeleton``. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally |
--generate-cli-skeleton <string> | Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value ``input``, prints a sample input JSON that can be used as an argument for ``--cli-input-json``. If provided with the value ``output``, it validates the command inputs and returns a sample output JSON for that command |