Greengrass / Client / reset_deployments

reset_deployments#

Greengrass.Client.reset_deployments(**kwargs)#

Resets a group’s deployments.

See also: AWS API Documentation

Request Syntax

response = client.reset_deployments(
    AmznClientToken='string',
    Force=True|False,
    GroupId='string'
)
Parameters:

  • AmznClientToken (string) – A client token used to correlate requests and responses.

  • Force (boolean) – If true, performs a best-effort only core reset.

  • GroupId (string) – [REQUIRED] The ID of the Greengrass group.

Return type:

dict

Returns:

Response Syntax

{
    'DeploymentArn': 'string',
    'DeploymentId': 'string'
}

Response Structure

  • (dict) – Success. The group’s deployments were reset.

    • DeploymentArn (string) – The ARN of the deployment.

    • DeploymentId (string) – The ID of the deployment.

Exceptions

  • Greengrass.Client.exceptions.BadRequestException