Menu
AWS Greengrass
API Reference

ResetDeployments

GGC v1.0.0GGC v1.1.0
GGC v1.0.0

Not available.

GGC v1.1.0

Resets a group's deployments.

URI: /greengrass/groups/GroupId/deployments/$reset

Operation: POST

Produces: application/json

Parameters:

  • GroupId

    The unique id of the AWS Greengrass group.

    where used: path

    required: true

    type: string

  • ResetDeploymentsRequestBody

    Information needed to perform a reset of a group's deployments.

    where used: body

    required: true

    schema:

    ResetDeploymentsRequest

    type: object

    Information needed to perform a reset of the group's deployments.

    properties:

    • Force:

      When set to true, perform a best-effort only core reset.

      type: boolean

    Example:

    Copy
    { "Force": true }
  • X-Amzn-Client-Token

    A client token used to correlate requests and responses.

    where used: header

    required: false

    type: string

Responses: