delete_user_pool_domain `async` ¶

delete_user_pool_domain(
    domain: DomainType,
    user_pool_id: UserPoolIdType,
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> DeleteUserPoolDomainResponse

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.

Parameters:

domain (DomainType) –

The domain that you want to delete. For custom domains, this is the fully-qualified domain name like auth.example.com. For Amazon Cognito prefix domains, this is the prefix alone, like myprefix.
user_pool_id (UserPoolIdType) –

The ID of the user pool where you want to delete the domain.

Raises:

ConcurrentModificationException –

This exception is thrown if two or more modifications are happening concurrently.
InternalErrorException –

This exception is thrown when Amazon Cognito encounters an internal error.
InvalidParameterException –

This exception is thrown when the Amazon Cognito service encounters an invalid parameter.
NotAuthorizedException –

This exception is thrown when a user isn't authorized.
OperationNotEnabledException –

This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.
ResourceNotFoundException –

This exception is thrown when the Amazon Cognito service can't find the requested resource.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_cognito_identity_provider/_services/async_cognito_identity_provider.py

async def delete_user_pool_domain(
    self,
    domain: "capo_cognito_identity_provider.types.domain_type.DomainType",
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    *,
    config_overrides: Optional[AsyncCognitoIdentityProviderClientConfig] = None,
) -> "capo_cognito_identity_provider.types.delete_user_pool_domain_response.DeleteUserPoolDomainResponse":
    """<p>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.</p>

    Args:
        domain: <p>The domain that you want to delete. For custom domains, this is the fully-qualified domain name like <code>auth.example.com</code>. For Amazon Cognito prefix domains, this is the prefix alone, like <code>myprefix</code>.</p>
        user_pool_id: <p>The ID of the user pool where you want to delete the domain.</p>

    Raises:
        capo_cognito_identity_provider.errors.concurrent_modification_exception.ConcurrentModificationException: <p>This exception is thrown if two or more modifications are happening concurrently.</p>
        capo_cognito_identity_provider.errors.internal_error_exception.InternalErrorException: <p>This exception is thrown when Amazon Cognito encounters an internal error.</p>
        capo_cognito_identity_provider.errors.invalid_parameter_exception.InvalidParameterException: <p>This exception is thrown when the Amazon Cognito service encounters an invalid parameter.</p>
        capo_cognito_identity_provider.errors.not_authorized_exception.NotAuthorizedException: <p>This exception is thrown when a user isn't authorized.</p>
        capo_cognito_identity_provider.errors.operation_not_enabled_exception.OperationNotEnabledException: <p>This exception is thrown when an operation is not available in the current region or for the current user pool configuration. This can occur when attempting to perform operations that are not supported in secondary replica regions.</p>
        capo_cognito_identity_provider.errors.resource_not_found_exception.ResourceNotFoundException: <p>This exception is thrown when the Amazon Cognito service can't find the requested resource.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cognito_identity_provider.types.delete_user_pool_domain_request.DeleteUserPoolDomainRequest]",
    ) -> AsyncOperationResponse[
        "capo_cognito_identity_provider.types.delete_user_pool_domain_response.DeleteUserPoolDomainResponse"
    ]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.delete_user_pool_domain

        (
            output,
            http_response,
        ) = await capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.delete_user_pool_domain.async_delete_user_pool_domain(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteUserPoolDomain")
    )
    input_: capo_cognito_identity_provider.types.delete_user_pool_domain_request.DeleteUserPoolDomainRequest = {
        "domain": domain,
        "user_pool_id": user_pool_id,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

delete_user_pool_domain async ¶

delete_user_pool_domain `async` ¶