Amazon Cognito #X Amz Target=AWSCognitoIdentityProviderService.CreateUserPool API

openapi: 3.2.0
info:
  version: '2016-04-18'
  x-release: v4
  title: 'Amazon Cognito Identity Provider #X Amz Target=AWSCognitoIdentityProviderService.CreateUserPool API'
  description: <p>With the Amazon Cognito user pools API, you can set up user pools and app clients, and authenticate users. To authenticate users from third-party identity providers (IdPs) in this API, you can <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pools-identity-federation-consolidate-users.html">link IdP users to native user profiles</a>. Learn more about the authentication and authorization of federated users in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-userpools-server-contract-reference.html">Using the Amazon Cognito user pools API and user pool endpoints</a>.</p> <p>This API reference provides detailed information about API operations and object types in Amazon Cognito. At the bottom of the page for each API operation and object, under <i>See Also</i>, you can learn how to use it in an Amazon Web Services SDK in the language of your choice.</p> <p>Along with resource management operations, the Amazon Cognito user pools API includes classes of operations and authorization models for client-side and server-side user operations. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito native and OIDC APIs</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <p>You can also start reading about the <code>CognitoIdentityProvider</code> client in the following SDK guides.</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/cli/latest/reference/cognito-idp/index.html#cli-aws-cognito-idp">Amazon Web Services Command Line Interface</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdkfornet/v3/apidocs/items/CognitoIdentityProvider/TCognitoIdentityProviderClient.html">Amazon Web Services SDK for .NET</a> </p> </li> <li> <p> <a href="https://sdk.amazonaws.com/cpp/api/LATEST/aws-cpp-sdk-cognito-idp/html/class_aws_1_1_cognito_identity_provider_1_1_cognito_identity_provider_client.html">Amazon Web Services SDK for C++</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-go/api/service/cognitoidentityprovider/#CognitoIdentityProvider">Amazon Web Services SDK for Go</a> </p> </li> <li> <p> <a href="https://sdk.amazonaws.com/java/api/latest/software/amazon/awssdk/services/cognitoidentityprovider/CognitoIdentityProviderClient.html">Amazon Web Services SDK for Java V2</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CognitoIdentityServiceProvider.html">Amazon Web Services SDK for JavaScript</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/aws-sdk-php/v3/api/api-cognito-idp-2016-04-18.html">Amazon Web Services SDK for PHP V3</a> </p> </li> <li> <p> <a href="https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/cognito-idp.html">Amazon Web Services SDK for Python</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/CognitoIdentityProvider/Client.html">Amazon Web Services SDK for Ruby V3</a> </p> </li> </ul> <p>To get started with an Amazon Web Services SDK, see <a href="http://aws.amazon.com/developer/tools/">Tools to Build on Amazon Web Services</a>. For example actions and scenarios, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/service_code_examples_cognito-identity-provider.html">Code examples for Amazon Cognito Identity Provider using Amazon Web Services SDKs</a>.</p>
  x-logo:
    url: https://twitter.com/awscloud/profile_image?size=original
    backgroundColor: '#FFFFFF'
  termsOfService: https://aws.amazon.com/service-terms/
  contact:
    name: Mike Ralphson
    email: mike.ralphson@gmail.com
    url: https://github.com/mermade/aws2openapi
    x-twitter: PermittedSoc
  license:
    name: Apache 2.0 License
    url: http://www.apache.org/licenses/
  x-providerName: amazonaws.com
  x-serviceName: cognito-idp
  x-origin:
  - contentType: application/json
    url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/cognito-idp-2016-04-18.normal.json
    converter:
      url: https://github.com/mermade/aws2openapi
      version: 1.0.0
    x-apisguru-driver: external
  x-apiClientRegistration:
    url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
  x-apisguru-categories:
  - cloud
  x-preferred: true
servers:
- url: http://cognito-idp.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity Provider multi-region endpoint
- url: https://cognito-idp.{region}.amazonaws.com
  variables:
    region:
      description: The AWS region
      enum:
      - us-east-1
      - us-east-2
      - us-west-1
      - us-west-2
      - us-gov-west-1
      - us-gov-east-1
      - ca-central-1
      - eu-north-1
      - eu-west-1
      - eu-west-2
      - eu-west-3
      - eu-central-1
      - eu-south-1
      - af-south-1
      - ap-northeast-1
      - ap-northeast-2
      - ap-northeast-3
      - ap-southeast-1
      - ap-southeast-2
      - ap-east-1
      - ap-south-1
      - sa-east-1
      - me-south-1
      default: us-east-1
  description: The Amazon Cognito Identity Provider multi-region endpoint
- url: http://cognito-idp.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity Provider endpoint for China (Beijing) and China (Ningxia)
- url: https://cognito-idp.{region}.amazonaws.com.cn
  variables:
    region:
      description: The AWS region
      enum:
      - cn-north-1
      - cn-northwest-1
      default: cn-north-1
  description: The Amazon Cognito Identity Provider endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=AWSCognitoIdentityProviderService.CreateUserPool'
paths:
  /#X-Amz-Target=AWSCognitoIdentityProviderService.CreateUserPool:
    parameters:
    - $ref: '#/components/parameters/X-Amz-Content-Sha256'
    - $ref: '#/components/parameters/X-Amz-Date'
    - $ref: '#/components/parameters/X-Amz-Algorithm'
    - $ref: '#/components/parameters/X-Amz-Credential'
    - $ref: '#/components/parameters/X-Amz-Security-Token'
    - $ref: '#/components/parameters/X-Amz-Signature'
    - $ref: '#/components/parameters/X-Amz-SignedHeaders'
    post:
      operationId: CreateUserPool
      description: <note> <p>This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with <a href="https://console.aws.amazon.com/pinpoint/home/">Amazon Pinpoint</a>. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.</p> <p>If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In <i> <a href="https://docs.aws.amazon.com/sns/latest/dg/sns-sms-sandbox.html">sandbox mode</a> </i>, you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html"> SMS message settings for Amazon Cognito user pools</a> in the <i>Amazon Cognito Developer Guide</i>.</p> </note> <p>Creates a new Amazon Cognito user pool and sets the password policy for the pool.</p> <important> <p>If you don't provide a value for an attribute, Amazon Cognito sets it to its default value.</p> </important> <note> <p>Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.</p> <p class="title"> <b>Learn more</b> </p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_aws-signing.html">Signing Amazon Web Services API Requests</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pools-API-operations.html">Using the Amazon Cognito user pools API and user pool endpoints</a> </p> </li> </ul> </note>
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateUserPoolResponse'
              examples:
                CreateUserPool200Example:
                  summary: Default CreateUserPool 200 response
                  x-microcks-default: true
                  value:
                    UserPool: example
        '480':
          description: InvalidParameterException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidParameterException'
              examples:
                CreateUserPool480Example:
                  summary: Default CreateUserPool 480 response
                  x-microcks-default: true
                  value: example
        '481':
          description: TooManyRequestsException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TooManyRequestsException'
              examples:
                CreateUserPool481Example:
                  summary: Default CreateUserPool 481 response
                  x-microcks-default: true
                  value: example
        '482':
          description: LimitExceededException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LimitExceededException'
              examples:
                CreateUserPool482Example:
                  summary: Default CreateUserPool 482 response
                  x-microcks-default: true
                  value: example
        '483':
          description: InvalidSmsRoleAccessPolicyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidSmsRoleAccessPolicyException'
              examples:
                CreateUserPool483Example:
                  summary: Default CreateUserPool 483 response
                  x-microcks-default: true
                  value: example
        '484':
          description: InvalidSmsRoleTrustRelationshipException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidSmsRoleTrustRelationshipException'
              examples:
                CreateUserPool484Example:
                  summary: Default CreateUserPool 484 response
                  x-microcks-default: true
                  value: example
        '485':
          description: InvalidEmailRoleAccessPolicyException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InvalidEmailRoleAccessPolicyException'
              examples:
                CreateUserPool485Example:
                  summary: Default CreateUserPool 485 response
                  x-microcks-default: true
                  value: example
        '486':
          description: NotAuthorizedException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotAuthorizedException'
              examples:
                CreateUserPool486Example:
                  summary: Default CreateUserPool 486 response
                  x-microcks-default: true
                  value: example
        '487':
          description: UserPoolTaggingException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserPoolTaggingException'
              examples:
                CreateUserPool487Example:
                  summary: Default CreateUserPool 487 response
                  x-microcks-default: true
                  value: example
        '488':
          description: InternalErrorException
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalErrorException'
              examples:
                CreateUserPool488Example:
                  summary: Default CreateUserPool 488 response
                  x-microcks-default: true
                  value: example
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateUserPoolRequest'
      parameters:
      - name: X-Amz-Target
        in: header
        required: true
        schema:
          type: string
          enum:
          - AWSCognitoIdentityProviderService.CreateUserPool
      summary: Amazon Cognito Create User Pool
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      tags:
      - '#X Amz Target=AWSCognitoIdentityProviderService.CreateUserPool'
components:
  schemas:
    UserPoolMfaType:
      type: string
      enum:
      - 'OFF'
      - 'ON'
      - OPTIONAL
    UserPoolPolicyType:
      type: object
      properties:
        PasswordPolicy:
          allOf:
          - $ref: '#/components/schemas/PasswordPolicyType'
          - description: The password policy.
      description: The policy associated with a user pool.
    RegionCodeType:
      type: string
      minLength: 5
      maxLength: 32
    IntegerType:
      type: integer
    RecoveryOptionNameType:
      type: string
      enum:
      - verified_email
      - verified_phone_number
      - admin_only
    UserPoolIdType:
      type: string
      pattern: '[\w-]+_[0-9a-zA-Z]+'
      minLength: 1
      maxLength: 55
    AttributeDataType:
      type: string
      enum:
      - String
      - Number
      - DateTime
      - Boolean
    EmailVerificationSubjectType:
      type: string
      pattern: '[\p{L}\p{M}\p{S}\p{N}\p{P}\s]+'
      minLength: 1
      maxLength: 140
    AdminCreateUserConfigType:
      type: object
      properties:
        AllowAdminCreateUserOnly:
          allOf:
          - $ref: '#/components/schemas/BooleanType'
          - description: Set to <code>True</code> if only the administrator is allowed to create user profiles. Set to <code>False</code> if users can sign themselves up via an app.
        UnusedAccountValidityDays:
          allOf:
          - $ref: '#/components/schemas/AdminCreateUserUnusedAccountValidityDaysType'
          - description: <p>The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable. To reset the account after that time limit, you must call <code>AdminCreateUser</code> again, specifying <code>"RESEND"</code> for the <code>MessageAction</code> parameter. The default value for this parameter is 7. </p> <note> <p>If you set a value for <code>TemporaryPasswordValidityDays</code> in <code>PasswordPolicy</code>, that value will be used, and <code>UnusedAccountValidityDays</code> will be no longer be an available parameter for that user pool.</p> </note>
        InviteMessageTemplate:
          allOf:
          - $ref: '#/components/schemas/MessageTemplateType'
          - description: <p>The message template to be used for the welcome message to new users.</p> <p>See also <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-pool-settings-message-customizations.html#cognito-user-pool-settings-user-invitation-message-customization">Customizing User Invitation Messages</a>.</p>
      description: The configuration for creating a new user profile.
    MessageTemplateType:
      type: object
      properties:
        SMSMessage:
          allOf:
          - $ref: '#/components/schemas/SmsVerificationMessageType'
          - description: The message template for SMS messages.
        EmailMessage:
          allOf:
          - $ref: '#/components/schemas/EmailVerificationMessageType'
          - description: 'The message template for email messages. EmailMessage is allowed only if <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is DEVELOPER. '
        EmailSubject:
          allOf:
          - $ref: '#/components/schemas/EmailVerificationSubjectType'
          - description: 'The subject line for email messages. EmailSubject is allowed only if <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is DEVELOPER. '
      description: The message template structure.
    VerificationMessageTemplateType:
      type: object
      properties:
        SmsMessage:
          allOf:
          - $ref: '#/components/schemas/SmsVerificationMessageType'
          - description: The template for SMS messages that Amazon Cognito sends to your users.
        EmailMessage:
          allOf:
          - $ref: '#/components/schemas/EmailVerificationMessageType'
          - description: The template for email messages that Amazon Cognito sends to your users. You can set an <code>EmailMessage</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
        EmailSubject:
          allOf:
          - $ref: '#/components/schemas/EmailVerificationSubjectType'
          - description: The subject line for the email message template. You can set an <code>EmailSubject</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
        EmailMessageByLink:
          allOf:
          - $ref: '#/components/schemas/EmailVerificationMessageByLinkType'
          - description: The email message template for sending a confirmation link to the user. You can set an <code>EmailMessageByLink</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
        EmailSubjectByLink:
          allOf:
          - $ref: '#/components/schemas/EmailVerificationSubjectByLinkType'
          - description: The subject line for the email message template for sending a confirmation link to the user. You can set an <code>EmailSubjectByLink</code> template only if the value of <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount"> EmailSendingAccount</a> is <code>DEVELOPER</code>. When your <a href="https://docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_EmailConfigurationType.html#CognitoUserPools-Type-EmailConfigurationType-EmailSendingAccount">EmailSendingAccount</a> is <code>DEVELOPER</code>, your user pool sends email messages with your own Amazon SES configuration.
        DefaultEmailOption:
          allOf:
          - $ref: '#/components/schemas/DefaultEmailOptionType'
          - description: The default email option.
      description: The template for verification messages.
    UserPoolAddOnsType:
      type: object
      required:
      - AdvancedSecurityMode
      properties:
        AdvancedSecurityMode:
          allOf:
          - $ref: '#/components/schemas/AdvancedSecurityModeType'
          - description: The operating mode of advanced security features in your user pool.
      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>
    CustomSMSLambdaVersionConfigType:
      type: object
      required:
      - LambdaVersion
      - LambdaArn
      properties:
        LambdaVersion:
          allOf:
          - $ref: '#/components/schemas/CustomSMSSenderLambdaVersionType'
          - description: Signature of the "request" attribute in the "event" information that Amazon Cognito passes to your custom SMS Lambda function. The only supported value is <code>V1_0</code>.
        LambdaArn:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send SMS notifications to users.
      description: A custom SMS sender Lambda configuration type.
    LambdaConfigType:
      type: object
      properties:
        PreSignUp:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: A pre-registration Lambda trigger.
        CustomMessage:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: A custom Message Lambda trigger.
        PostConfirmation:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: A post-confirmation Lambda trigger.
        PreAuthentication:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: A pre-authentication Lambda trigger.
        PostAuthentication:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: A post-authentication Lambda trigger.
        DefineAuthChallenge:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: Defines the authentication challenge.
        CreateAuthChallenge:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: Creates an authentication challenge.
        VerifyAuthChallengeResponse:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: Verifies the authentication challenge response.
        PreTokenGeneration:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: A Lambda trigger that is invoked before token generation.
        UserMigration:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: The user migration Lambda config type.
        CustomSMSSender:
          allOf:
          - $ref: '#/components/schemas/CustomSMSLambdaVersionConfigType'
          - description: A custom SMS sender Lambda trigger.
        CustomEmailSender:
          allOf:
          - $ref: '#/components/schemas/CustomEmailLambdaVersionConfigType'
          - description: A custom email sender Lambda trigger.
        KMSKeyID:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: The Amazon Resource Name (ARN) of an <a href="/kms/latest/developerguide/concepts.html#master_keys">KMS key</a>. Amazon Cognito uses the key to encrypt codes and temporary passwords sent to <code>CustomEmailSender</code> and <code>CustomSMSSender</code>.
      description: Specifies the configuration for Lambda triggers.
    PriorityType:
      type: integer
      minimum: 1
      maximum: 2
    UsernameConfigurationType:
      type: object
      required:
      - CaseSensitive
      properties:
        CaseSensitive:
          allOf:
          - $ref: '#/components/schemas/WrappedBooleanType'
          - description: <p>Specifies whether user name case sensitivity will be applied for all users in the user pool through Amazon Cognito APIs. For most use cases, set case sensitivity to <code>False</code> (case insensitive) as a best practice. When usernames and email addresses are case insensitive, users can sign in as the same user when they enter a different capitalization of their user name.</p> <p>Valid values include:</p> <dl> <dt>True</dt> <dd> <p>Enables case sensitivity for all username input. When this option is set to <code>True</code>, users must sign in using the exact capitalization of their given username, such as “UserName”. This is the default value.</p> </dd> <dt>False</dt> <dd> <p>Enables case insensitivity for all username input. For example, when this option is set to <code>False</code>, users can sign in using <code>username</code>, <code>USERNAME</code>, or <code>UserName</code>. This option also enables both <code>preferred_username</code> and <code>email</code> alias to be case insensitive, in addition to the <code>username</code> attribute.</p> </dd> </dl>
      description: 'The username configuration type. '
    InvalidEmailRoleAccessPolicyException: {}
    AccountRecoverySettingType:
      type: object
      properties:
        RecoveryMechanisms:
          allOf:
          - $ref: '#/components/schemas/RecoveryMechanismsType'
          - description: The list of <code>RecoveryOptionTypes</code>.
      description: The data type for <code>AccountRecoverySetting</code>.
    StringAttributeConstraintsType:
      type: object
      properties:
        MinLength:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The minimum length.
        MaxLength:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The maximum length.
      description: The constraints associated with a string attribute.
    InternalErrorException: {}
    CustomEmailLambdaVersionConfigType:
      type: object
      required:
      - LambdaVersion
      - LambdaArn
      properties:
        LambdaVersion:
          allOf:
          - $ref: '#/components/schemas/CustomEmailSenderLambdaVersionType'
          - description: Signature of the "request" attribute in the "event" information Amazon Cognito passes to your custom email Lambda function. The only supported value is <code>V1_0</code>.
        LambdaArn:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: The Amazon Resource Name (ARN) of the Lambda function that Amazon Cognito activates to send email notifications to users.
      description: A custom email sender Lambda configuration type.
    CreateUserPoolResponse:
      type: object
      properties:
        UserPool:
          allOf:
          - $ref: '#/components/schemas/UserPoolType'
          - description: A container for the user pool details.
      description: Represents the response from the server for the request to create a user pool.
    TagValueType:
      type: string
      minLength: 0
      maxLength: 256
    PasswordPolicyMinLengthType:
      type: integer
      minimum: 6
      maximum: 99
    NumberAttributeConstraintsType:
      type: object
      properties:
        MinValue:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The minimum value of an attribute that is of the number data type.
        MaxValue:
          allOf:
          - $ref: '#/components/schemas/StringType'
          - description: The maximum value of an attribute that is of the number data type.
      description: The minimum and maximum values of an attribute that is of the number data type.
    InvalidSmsRoleAccessPolicyException: {}
    VerifiedAttributeType:
      type: string
      enum:
      - phone_number
      - email
    EmailSendingAccountType:
      type: string
      enum:
      - COGNITO_DEFAULT
      - DEVELOPER
    EmailConfigurationType:
      type: object
      properties:
        SourceArn:
          allOf:
          - $ref: '#/components/schemas/ArnType'
          - description: <p>The ARN of a verified email address or an address from a verified domain in Amazon SES. You can set a <code>SourceArn</code> email from a verified domain only with an API request. You can set a verified email address, but not an address in a verified domain, in the Amazon Cognito console. Amazon Cognito uses the email address that you provide in one of the following ways, depending on the value that you specify for the <code>EmailSendingAccount</code> parameter:</p> <ul> <li> <p>If you specify <code>COGNITO_DEFAULT</code>, Amazon Cognito uses this address as the custom FROM address when it emails your users using its built-in email account.</p> </li> <li> <p>If you specify <code>DEVELOPER</code>, Amazon Cognito emails your users with this address by calling Amazon SES on your behalf.</p> </li> </ul> <p>The Region value of the <code>SourceArn</code> parameter must indicate a supported Amazon Web Services Region of your user pool. Typically, the Region in the <code>SourceArn</code> and the user pool Region are the same. For more information, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-email.html#user-pool-email-developer-region-mapping">Amazon SES email configuration regions</a> in the <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/cognito-user-identity-pools.html">Amazon Cognito Developer Guide</a>.</p>
        ReplyToEmailAddress:
          allOf:
          - $ref: '#/components/schemas/EmailAddressType'
          - description: The destination to which the receiver of the email should reply.
        EmailSendingAccount:
          allOf:
          - $ref: '#/components/schemas/EmailSendingAccountType'
          - description: <p>Specifies whether Amazon Cognito uses its built-in functionality to send your users email messages, or uses your Amazon Simple Email Service email configuration. Specify one of the following values:</p> <dl> <dt>COGNITO_DEFAULT</dt> <dd> <p>When Amazon Cognito emails your users, it uses its built-in email functionality. When you use the default option, Amazon Cognito allows only a limited number of emails each day for your user pool. For typical production environments, the default email limit is less than the required delivery volume. To achieve a higher delivery volume, specify DEVELOPER to use your Amazon SES email configuration.</p> <p>To look up the email delivery limit for the default option, see <a href="https://docs.aws.amazon.com/cognito/latest/developerguide/limits.html">Limits</a> in the <i>Amazon Cognito Developer Guide</i>.</p> <p>The default FROM address is <code>no-reply@verificationemail.com</code>. To customize the FROM address, provide the Amazon Resource Name (ARN) of an Amazon SES verified email 

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/amazon-cognito/refs/heads/main/openapi/amazon-cognito-x-amz-target-awscognitoidentityproviderservice-createuserpool-api-openapi.yml