Menu
AWS Greengrass
API Reference

/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 needed to reset deployments.

where used: body; required: true

Copy
{ "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 AWS Greengrass group.

where used: path; required: true

type: string

CLI

Copy
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:

Copy
{ "GroupId": "string", "Force": "boolean", "AmznClientToken": "string" }

Responses

200

Success. The group's deployments were reset.

ResetDeploymentsResponse

Copy
{ "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

GeneralError

Copy
{ "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: