CognitoIdentityProvider / Client / delete_user_pool_domain
delete_user_pool_domain#
- CognitoIdentityProvider.Client.delete_user_pool_domain(**kwargs)#
Deletes a domain for a user pool.
See also: AWS API Documentation
Request Syntax
response = client.delete_user_pool_domain( Domain='string', UserPoolId='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 asauth
.UserPoolId (string) –
[REQUIRED]
The user pool ID.
- 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