PUT
/greengrass/bulk/deployments/{BulkDeploymentId}/$stop
http://greengrass.{region}.amazonaws.com/greengrass/bulk/deployments/{BulkDeploymentId}/$stopStops 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.
Access Token Required: API Key
Path Parameters
BulkDeploymentIdstringrequired
The ID of the bulk deployment.
Responses
{
"success": true,
"data": {
"id": "abc123",
"created_at": "2025-01-01T00:00:00Z"
}
}{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Invalid request parameters"
}
}Language
CredentialsAPI KEY
API Key
Enter token below to save for later
cURL Request
1curl --request PUT \2 --url 'http://greengrass.{region}.amazonaws.com/greengrass/bulk/deployments/{BulkDeploymentId}/$stop' \3 --header 'accept: application/json' \4 --header 'content-type: application/json'Response
1{2 "success": true,3 "data": {4 "id": "abc123",5 "created_at": "2025-01-01T00:00:00Z"6 }7}