Greengrass / Client / stop_bulk_deployment

stop_bulk_deployment#

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

Request Syntax

response = client.stop_bulk_deployment(
    BulkDeploymentId='string'
)
Parameters:

BulkDeploymentId (string) – [REQUIRED] The ID of the bulk deployment.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) – Success. The bulk deployment is being stopped.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException