:doc:`Snowball <../../snowball>` / Client / cancel_cluster

**************
cancel_cluster
**************



.. py:method:: Snowball.Client.cancel_cluster(**kwargs)

  

  Cancels a cluster job. You can only cancel a cluster job while it's in the ``AwaitingQuorum`` status. You'll have at least an hour after creating a cluster job to cancel it.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/snowball-2016-06-30/CancelCluster>`_  


  **Request Syntax**
  ::

    response = client.cancel_cluster(
        ClusterId='string'
    )
    
  :type ClusterId: string
  :param ClusterId: **[REQUIRED]** 

    The 39-character ID for the cluster that you want to cancel, for example ``CID123e4567-e89b-12d3-a456-426655440000``.

    

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`Snowball.Client.exceptions.KMSRequestFailedException`

  
  *   :py:class:`Snowball.Client.exceptions.InvalidJobStateException`

  
  *   :py:class:`Snowball.Client.exceptions.InvalidResourceException`

  

  **Examples**

  This operation cancels a cluster job. You can only cancel a cluster job while it's in the AwaitingQuorum status.
  ::

    response = client.cancel_cluster(
        ClusterId='CID123e4567-e89b-12d3-a456-426655440000',
    )
    
    print(response)

  
  Expected Output:
  ::

    {
        'ResponseMetadata': {
            '...': '...',
        },
    }

  