{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/json-schema/user-pools-update-user-pool-request-schema.json",
  "title": "UpdateUserPoolRequest",
  "description": "Represents the request to update the user pool.",
  "type": "object",
  "properties": {
    "UserPoolId": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolIdType"
        },
        {
          "description": "The user pool ID for the user pool you want to update."
        }
      ]
    },
    "Policies": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolPolicyType"
        },
        {
          "description": "A container with the policies you want to update in a user pool."
        }
      ]
    },
    "DeletionProtection": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeletionProtectionType"
        },
        {
          "description": "<p>When active, <code>DeletionProtection</code> prevents accidental deletion of your user pool. Before you can delete a user pool that you have protected against deletion, you must deactivate this feature.</p> <p>When you try to delete a protected user pool in a <code>DeleteUserPool</code> API request, Amazon Cognito returns an <code>InvalidParameterException</code> error. To delete a protected user pool, send a new <code>DeleteUserPool</code> request after you deactivate deletion protection in an <code>UpdateUserPool</code> API request.</p>"
        }
      ]
    },
    "LambdaConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LambdaConfigType"
        },
        {
          "description": "The Lambda configuration information from the request to update the user pool."
        }
      ]
    },
    "AutoVerifiedAttributes": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VerifiedAttributesListType"
        },
        {
          "description": "The attributes that are automatically verified when Amazon Cognito requests to update user pools."
        }
      ]
    },
    "SmsVerificationMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SmsVerificationMessageType"
        },
        {
          "description": "This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>."
        }
      ]
    },
    "EmailVerificationMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailVerificationMessageType"
        },
        {
          "description": "This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>."
        }
      ]
    },
    "EmailVerificationSubject": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailVerificationSubjectType"
        },
        {
          "description": "This parameter is no longer used. See <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_VerificationMessageTemplateType.html\">VerificationMessageTemplateType</a>."
        }
      ]
    },
    "VerificationMessageTemplate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VerificationMessageTemplateType"
        },
        {
          "description": "The template for verification messages."
        }
      ]
    },
    "SmsAuthenticationMessage": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SmsVerificationMessageType"
        },
        {
          "description": "The contents of the SMS authentication message."
        }
      ]
    },
    "UserAttributeUpdateSettings": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserAttributeUpdateSettingsType"
        },
        {
          "description": "The settings for updates to user attributes. These settings include the property <code>AttributesRequireVerificationBeforeUpdate</code>, a user-pool setting that tells Amazon Cognito how to handle changes to the value of your users' email address and phone number attributes. For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html#user-pool-settings-verifications-verify-attribute-updates\"> Verifying updates to email addresses and phone numbers</a>."
        }
      ]
    },
    "MfaConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolMfaType"
        },
        {
          "description": "<p>Possible values include:</p> <ul> <li> <p> <code>OFF</code> - MFA tokens aren't required and can't be specified during user registration.</p> </li> <li> <p> <code>ON</code> - MFA tokens are required for all user registrations. You can only specify ON when you're initially creating a user pool. You can use the <a href=\"https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetUserPoolMfaConfig.html\">SetUserPoolMfaConfig</a> API operation to turn MFA \"ON\" for existing user pools. </p> </li> <li> <p> <code>OPTIONAL</code> - Users have the option when registering to create an MFA token.</p> </li> </ul>"
        }
      ]
    },
    "DeviceConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DeviceConfigurationType"
        },
        {
          "description": "<p>The device-remembering configuration for a user pool. A null value indicates that you have deactivated device remembering in your user pool.</p> <note> <p>When you provide a value for any <code>DeviceConfiguration</code> field, you activate the Amazon Cognito device-remembering feature.</p> </note>"
        }
      ]
    },
    "EmailConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EmailConfigurationType"
        },
        {
          "description": "The email configuration of your user pool. The email configuration type sets your preferred sending method, Amazon Web Services Region, and sender for email invitation and verification messages from your user pool."
        }
      ]
    },
    "SmsConfiguration": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SmsConfigurationType"
        },
        {
          "description": "The SMS configuration with the settings that your Amazon Cognito user pool must use to send an SMS message from your Amazon Web Services account through Amazon Simple Notification Service. To send SMS messages with Amazon SNS in the Amazon Web Services Region that you want, the Amazon Cognito user pool uses an Identity and Access Management (IAM) role in your Amazon Web Services account."
        }
      ]
    },
    "UserPoolTags": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolTagsType"
        },
        {
          "description": "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."
        }
      ]
    },
    "AdminCreateUserConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AdminCreateUserConfigType"
        },
        {
          "description": "The configuration for <code>AdminCreateUser</code> requests."
        }
      ]
    },
    "UserPoolAddOns": {
      "allOf": [
        {
          "$ref": "#/components/schemas/UserPoolAddOnsType"
        },
        {
          "description": "<p>User pool add-ons. Contains settings for activation of advanced security features. To log user security information but take no action, set to <code>AUDIT</code>. To configure automatic security responses to risky traffic to your user pool, set to <code>ENFORCED</code>.</p> <p>For more information, see <a href=\"https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-advanced-security.html\">Adding advanced security to a user pool</a>.</p>"
        }
      ]
    },
    "AccountRecoverySetting": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AccountRecoverySettingType"
        },
        {
          "description": "The available verified method a user can use to recover their password when they call <code>ForgotPassword</code>. You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email."
        }
      ]
    }
  },
  "required": [
    "UserPoolId"
  ]
}