CognitoIdentityProvider / Client / delete_user_pool_domain

delete_user_pool_domain#

CognitoIdentityProvider.Client.delete_user_pool_domain(**kwargs)#

Given a user pool ID and domain identifier, deletes a user pool domain. After you delete a user pool domain, your managed login pages and authorization server are no longer available.

See also: AWS API Documentation

Request Syntax

response = client.delete_user_pool_domain(
    Domain='string',
    UserPoolId='string'
)
Parameters:

  • Domain (string) –

    [REQUIRED]

    The domain that you want to delete. 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 ID of the user pool where you want to delete the domain.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions

  • CognitoIdentityProvider.Client.exceptions.NotAuthorizedException

  • CognitoIdentityProvider.Client.exceptions.InvalidParameterException

  • CognitoIdentityProvider.Client.exceptions.ResourceNotFoundException

  • CognitoIdentityProvider.Client.exceptions.InternalErrorException