Amazon Cognito · Example Payload

User Pools Update User Pool Request Example

AuthenticationIdentityOAuthOIDCSAMLUser ManagementFederated Identity

User Pools Update User Pool Request Example is an example object payload from Amazon Cognito, with 19 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

UserPoolIdPoliciesDeletionProtectionLambdaConfigAutoVerifiedAttributesSmsVerificationMessageEmailVerificationMessageEmailVerificationSubjectVerificationMessageTemplateSmsAuthenticationMessageUserAttributeUpdateSettingsMfaConfigurationDeviceConfigurationEmailConfigurationSmsConfigurationUserPoolTagsAdminCreateUserConfigUserPoolAddOnsAccountRecoverySetting

Example Payload

Raw ↑ 
{
  "UserPoolId": "us-east-1_example",
  "Policies": "example-string",
  "DeletionProtection": "example-string",
  "LambdaConfig": "example-string",
  "AutoVerifiedAttributes": "example-string",
  "SmsVerificationMessage": "example-string",
  "EmailVerificationMessage": "user@example.com",
  "EmailVerificationSubject": "user@example.com",
  "VerificationMessageTemplate": "example-string",
  "SmsAuthenticationMessage": "example-string",
  "UserAttributeUpdateSettings": "example-string",
  "MfaConfiguration": "example-string",
  "DeviceConfiguration": "example-string",
  "EmailConfiguration": "user@example.com",
  "SmsConfiguration": "example-string",
  "UserPoolTags": "example-string",
  "AdminCreateUserConfig": "example-string",
  "UserPoolAddOns": "example-string",
  "AccountRecoverySetting": "example-string"
}