Amazon Cognito Identity Provider
  1. Root
Amazon Cognito Identity Provider
  • Root
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
    • /
      POST
  1. Root

/

POST
/
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.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/' \
--header 'X-Amz-Target;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "UserPoolId": "string",
    "Policies": {
        "PasswordPolicy": {
            "MinimumLength": 0,
            "RequireUppercase": true,
            "RequireLowercase": true,
            "RequireNumbers": true,
            "RequireSymbols": true,
            "TemporaryPasswordValidityDays": 0
        }
    },
    "DeletionProtection": "ACTIVE",
    "LambdaConfig": {
        "PreSignUp": "string",
        "CustomMessage": "string",
        "PostConfirmation": "string",
        "PreAuthentication": "string",
        "PostAuthentication": "string",
        "DefineAuthChallenge": "string",
        "CreateAuthChallenge": "string",
        "VerifyAuthChallengeResponse": "string",
        "PreTokenGeneration": "string",
        "UserMigration": "string",
        "CustomSMSSender": {
            "LambdaVersion": "V1_0",
            "LambdaArn": "string"
        },
        "CustomEmailSender": {
            "LambdaVersion": "V1_0",
            "LambdaArn": "string"
        },
        "KMSKeyID": "string"
    },
    "AutoVerifiedAttributes": [],
    "SmsVerificationMessage": "string",
    "EmailVerificationMessage": "string",
    "EmailVerificationSubject": "string",
    "VerificationMessageTemplate": {
        "SmsMessage": "string",
        "EmailMessage": "string",
        "EmailSubject": "string",
        "EmailMessageByLink": "string",
        "EmailSubjectByLink": "string",
        "DefaultEmailOption": "CONFIRM_WITH_LINK"
    },
    "SmsAuthenticationMessage": "string",
    "UserAttributeUpdateSettings": {},
    "MfaConfiguration": "OFF",
    "DeviceConfiguration": {},
    "EmailConfiguration": {},
    "SmsConfiguration": {
        "SnsCallerArn": "string",
        "ExternalId": "string",
        "SnsRegion": "string"
    },
    "UserPoolTags": {
        "property1": "string",
        "property2": "string"
    },
    "AdminCreateUserConfig": {
        "AllowAdminCreateUserOnly": true,
        "UnusedAccountValidityDays": 0,
        "InviteMessageTemplate": {
            "SMSMessage": "string",
            "EmailMessage": "string",
            "EmailSubject": "string"
        }
    },
    "UserPoolAddOns": {
        "AdvancedSecurityMode": "OFF"
    },
    "AccountRecoverySetting": {
        "RecoveryMechanisms": []
    }
}'
Response Response Example
200 - Example 1
{}

Request

Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠480ResourceNotFoundException
🟠481InvalidParameterException
🟠482ConcurrentModificationException
🟠483TooManyRequestsException
🟠484NotAuthorizedException
🟠485UserImportInProgressException
🟠486InternalErrorException
🟠487InvalidSmsRoleAccessPolicyException
🟠488InvalidSmsRoleTrustRelationshipException
🟠489UserPoolTaggingException
🟠490InvalidEmailRoleAccessPolicyException
Modified at 2023-08-15 07:11:07
Previous
/
Next
/
Built with