cancel_deployment

GreengrassV2.Client.cancel_deployment(**kwargs)

Cancels a deployment. This operation cancels the deployment for devices that haven't yet received it. If a device already received the deployment, this operation doesn't change anything for that device.

See also: AWS API Documentation

Request Syntax

response = client.cancel_deployment(
    deploymentId='string'
)

Parameters

deploymentId (string) --

[REQUIRED]

The ID of the deployment.

Return type

dict

Returns

Response Syntax

{
    'message': 'string'
}

Response Structure

• (dict) --
  • message (string) --

    A message that communicates if the cancel was successful.

Exceptions

• GreengrassV2.Client.exceptions.ResourceNotFoundException
• GreengrassV2.Client.exceptions.ValidationException
• GreengrassV2.Client.exceptions.AccessDeniedException
• GreengrassV2.Client.exceptions.InternalServerException
• GreengrassV2.Client.exceptions.ConflictException
• GreengrassV2.Client.exceptions.ThrottlingException