:doc:`finspace <../../finspace>` / Client / delete_kx_cluster

*****************
delete_kx_cluster
*****************



.. py:method:: finspace.Client.delete_kx_cluster(**kwargs)

  

  Deletes a kdb cluster.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/finspace-2021-03-12/DeleteKxCluster>`_  


  **Request Syntax**
  ::

    response = client.delete_kx_cluster(
        environmentId='string',
        clusterName='string',
        clientToken='string'
    )
    
  :type environmentId: string
  :param environmentId: **[REQUIRED]** 

    A unique identifier for the kdb environment.

    

  
  :type clusterName: string
  :param clusterName: **[REQUIRED]** 

    The name of the cluster that you want to delete.

    

  
  :type clientToken: string
  :param clientToken: 

    A token that ensures idempotency. This token expires in 10 minutes.

    This field is autopopulated if not provided.

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`finspace.Client.exceptions.InternalServerException`

  
  *   :py:class:`finspace.Client.exceptions.ValidationException`

  
  *   :py:class:`finspace.Client.exceptions.ThrottlingException`

  
  *   :py:class:`finspace.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`finspace.Client.exceptions.LimitExceededException`

  
  *   :py:class:`finspace.Client.exceptions.ConflictException`

  
  *   :py:class:`finspace.Client.exceptions.ResourceNotFoundException`

  