:doc:`Greengrass <../../greengrass>` / Client / stop_bulk_deployment

********************
stop_bulk_deployment
********************



.. py:method:: Greengrass.Client.stop_bulk_deployment(**kwargs)

  Stops the execution of a bulk deployment. This action returns a status of ''Stopping'' until the deployment is stopped. You cannot start a new bulk deployment while a previous deployment is in the ''Stopping'' state. This action doesn't rollback completed deployments or cancel pending deployments.

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/greengrass-2017-06-07/StopBulkDeployment>`_  


  **Request Syntax**
  ::

    response = client.stop_bulk_deployment(
        BulkDeploymentId='string'
    )
    
  :type BulkDeploymentId: string
  :param BulkDeploymentId: **[REQUIRED]** The ID of the bulk deployment.

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

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* Success. The bulk deployment is being stopped.
  
  **Exceptions**
  
  *   :py:class:`Greengrass.Client.exceptions.BadRequestException`

  