CognitoIdentityProvider / Client / create_user_pool_domain

create_user_pool_domain#

CognitoIdentityProvider.Client.create_user_pool_domain(**kwargs)#

Creates a new domain for a user pool.

See also: AWS API Documentation

Request Syntax

response = client.create_user_pool_domain(
    Domain='string',
    UserPoolId='string',
    CustomDomainConfig={
        'CertificateArn': 'string'
    }
)
Parameters:

  • Domain (string) –

    [REQUIRED]

    The domain string. For custom domains, this is the fully-qualified domain name, such as auth.example.com . For Amazon Cognito prefix domains, this is the prefix alone, such as auth .

  • UserPoolId (string) –

    [REQUIRED]

    The user pool ID.

  • CustomDomainConfig (dict) –

    The configuration for a custom domain that hosts the sign-up and sign-in webpages for your application.

    Provide this parameter only if you want to use a custom domain for your user pool. Otherwise, you can exclude this parameter and use the Amazon Cognito hosted domain instead.

    For more information about the hosted domain and custom domains, see Configuring a User Pool Domain.

    • CertificateArn (string) – [REQUIRED]

      The Amazon Resource Name (ARN) of an Certificate Manager SSL certificate. You use this certificate for the subdomain of your custom domain.

Return type:

dict

Returns:

Response Syntax

{
    'CloudFrontDomain': 'string'
}

Response Structure

  • (dict) –

    • CloudFrontDomain (string) –

      The Amazon CloudFront endpoint that you use as the target of the alias that you set up with your Domain Name Service (DNS) provider.

Exceptions

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.LimitExceededException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException