Amazon IoT Greengrass Version 1 entered the extended life phase on June 30, 2023. For more information, see the Amazon IoT Greengrass V1 maintenance policy. After this date, Amazon IoT Greengrass V1 won't release updates that provide features, enhancements, bug fixes, or security patches. Devices that run on Amazon IoT Greengrass V1 won't be disrupted and will continue to operate and to connect to the cloud. We strongly recommend that you migrate to Amazon IoT Greengrass Version 2, which adds significant new features and support for additional platforms.
/greengrass/groups/GroupId/deployments/$reset
POST
POST
/greengrass/groups/
GroupId
/deployments/$reset
Operation ID: ResetDeployments
Resets a group's deployments.
Produces: application/json
Body Parameters
- ResetDeploymentsRequestBody
-
Information required to reset deployments.
where used: body; required: true
{ "Force": true }
- ResetDeploymentsRequest
-
Information about a group reset request.
type: object
- Force
-
If true, performs a best-effort only core reset.
type: boolean
Header Parameters
- X-Amzn-Client-Token
-
A client token used to correlate requests and responses.
where used: header; required: false
type: string
Path Parameters
- GroupId
-
The ID of the Greengrass group.
where used: path; required: true
type: string
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" }
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