AWS Greengrass
API Reference

/greengrass/bulk/deployments/BulkDeploymentId/$stop

PUT

PUT /greengrass/bulk/deployments/BulkDeploymentId/$stop

Operation ID: StopBulkDeployment

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.

Produces: application/json

Path Parameters

BulkDeploymentId

The ID of the bulk deployment.

where used: path; required: true

type: string

CLI

aws greengrass stop-bulk-deployment \ --bulk-deployment-id <value> \ [--cli-input-json <value>] \ [--generate-cli-skeleton]

cli-input-json format:

{ "BulkDeploymentId": "string" }

Responses

200

Success. The bulk deployment is being stopped.

400

invalid request

GeneralError

{ "Message": "string", "ErrorDetails": [ { "DetailedErrorCode": "string", "DetailedErrorMessage": "string" } ] }
GeneralError

General error information.

type: object

required: ["Message"]

Message

A message containing information about the error.

type: string

ErrorDetails

A list of error details.

type: array

items: ErrorDetail

ErrorDetail

Details about the error.

type: object

DetailedErrorCode

A detailed error code.

type: string

DetailedErrorMessage

A detailed error message.

type: string

On this page: