:doc:`GreengrassV2 <../../greengrassv2>` / Client / cancel_deployment

*****************
cancel_deployment
*****************



.. py:method:: GreengrassV2.Client.cancel_deployment(**kwargs)

  

  Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/greengrassv2-2020-11-30/CancelDeployment>`_  


  **Request Syntax**
  ::

    response = client.cancel_deployment(
        deploymentId='string'
    )
    
  :type deploymentId: string
  :param deploymentId: **[REQUIRED]** 

    The ID of the deployment.

    

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

    
    ::

      {
          'message': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **message** *(string) --* 

        A message that communicates if the cancel was successful.

        
  
  **Exceptions**
  
  *   :py:class:`GreengrassV2.Client.exceptions.ResourceNotFoundException`

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

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

  
  *   :py:class:`GreengrassV2.Client.exceptions.InternalServerException`

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

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

  