ResetDeployments - Amazon IoT Greengrass
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

You are viewing the documentation for Amazon IoT Greengrass Version 1. Amazon IoT Greengrass Version 2 is the latest major version of Amazon IoT Greengrass. For more information about the Amazon IoT Greengrass V2 API, see the Amazon IoT Greengrass Version 2 API Reference.

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.

ResetDeploymentsResponse

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

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