StopBulkDeployment - AWS IoT Greengrass
CLI: Parameters: Responses:

End of support notice: On October 7th, 2026, AWS will discontinue support for AWS IoT Greengrass Version 1. After October 7th, 2026, you will no longer be able to access the AWS IoT Greengrass V1 resources. For more information, please visit Migrate from AWS IoT Greengrass Version 1.

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 roll back completed deployments or cancel pending deployments.

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

Produces: application/json

CLI:

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

cli-input-json format:

{
"BulkDeploymentId": "string"
}

Parameters:

BulkDeploymentId

The ID of the bulk deployment.

where used: path; required: true

type: 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 that contains 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