End of support notice: On October 7th, 2026, Amazon will discontinue support for Amazon IoT Greengrass Version 1. After October 7th, 2026, you will no longer be able to access the Amazon IoT Greengrass V1 resources. For more information, please visit Migrate from Amazon IoT Greengrass Version 1.
ResetDeployments
Resets a group's deployments.
URI: POST
/greengrass/groups/GroupId/deployments/$reset
Produces: application/json
CLI:
aws greengrass reset-deployments \ --group-id <value> \ [--force | --no-force] \ [--amzn-client-token <value>] \ [--cli-input-json <value>] \ [--generate-cli-skeleton]
cli-input-json format:
{ "GroupId": "string", "Force": "boolean", "AmznClientToken": "string" }
Parameters:
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: string
- ResetDeploymentsRequestBody
-
Information required to reset deployments.
where used: body; required: true
{ "Force": true }schema:
- ResetDeploymentsRequest
-
Information about a group reset request.
type: object
- Force
-
If true, performs a best-effort only core reset.
type: boolean
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Responses:
- 200
-
Success. The group's deployments were reset.
{ "DeploymentArn": "string", "DeploymentId": "string" }- ResetDeploymentsResponse
-
type: object
- DeploymentArn
-
The ARN of the deployment.
type: string
- DeploymentId
-
The ID of the deployment.
type: string
- 400
-
Invalid request.
{ "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