Skip to content

delete_user_pool_client

delete_user_pool_client(
    user_pool_id: UserPoolIdType,
    client_id: ClientIdType,
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
) -> None

Deletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.

Parameters:

  • user_pool_id (UserPoolIdType) –

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

  • client_id (ClientIdType) –

    The ID of the user pool app client that you want to delete.

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.

  • TooManyRequestsException –

    This exception is thrown when the user has made too many requests for a given operation.

  • UnknownServiceError –

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

Source code in docs_src/capo_cognito_identity_provider/_services/cognito_identity_provider.py
def delete_user_pool_client(
    self,
    user_pool_id: "capo_cognito_identity_provider.types.user_pool_id_type.UserPoolIdType",
    client_id: "capo_cognito_identity_provider.types.client_id_type.ClientIdType",
    *,
    config_overrides: Optional[CognitoIdentityProviderClientConfig] = None,
) -> None:
    """<p>Deletes a user pool app client. After you delete an app client, users can no longer sign in to the associated application.</p>

    Args:
        user_pool_id: <p>The ID of the user pool where you want to delete the client.</p>
        client_id: <p>The ID of the user pool app client that you want to delete.</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.too_many_requests_exception.TooManyRequestsException: <p>This exception is thrown when the user has made too many requests for a given operation.</p>
        capo_cognito_identity_provider.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_cognito_identity_provider.types.delete_user_pool_client_request.DeleteUserPoolClientRequest]",
    ) -> OperationResponse[None]:
        import capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.delete_user_pool_client

        output, http_response = (
            capo_cognito_identity_provider._operations.aws_cognito_identity_provider_service.delete_user_pool_client.delete_user_pool_client(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_cognito_identity_provider.types.delete_user_pool_client_request.DeleteUserPoolClientRequest",
    ) -> dict[str, Any]:
        import capo_cognito_identity_provider.types.delete_user_pool_client_request

        return capo_cognito_identity_provider.types.delete_user_pool_client_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("DeleteUserPoolClient", redact_input=_redact_input),
    )
    input_: capo_cognito_identity_provider.types.delete_user_pool_client_request.DeleteUserPoolClientRequest = {
        "user_pool_id": user_pool_id,
        "client_id": client_id,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output