Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

DeleteDeployment

Deletes a deployment. To delete an active deployment, you must first cancel it. For more information, see CancelDeployment.

Deleting a deployment doesn't affect core devices that run that deployment, because core devices store the deployment's configuration on the device. Additionally, core devices can roll back to a previous deployment that has been deleted.

Deleting the AWS IoT job associated with a deployment may take time. While the job is being deleted, the status of the job will be shown as "DELETION_IN_PROGRESS". Only 10 jobs may have status "DELETION_IN_PROGRESS" at the same time. If Greengrass is unable to delete a job because of this limit, the DeleteDeployment operation will return ThrottlingException.

Request Syntax


DELETE /greengrass/v2/deployments/deploymentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

deploymentId

The ID of the deployment.

Length Constraints: Minimum length of 1.

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 204

Response Elements

If the action is successful, the service sends back an HTTP 204 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have permission to perform the action.

HTTP Status Code: 403

ConflictException

Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.

resourceId: The ID of the resource that conflicts with the request.
resourceType: The type of the resource that conflicts with the request.

HTTP Status Code: 409

InternalServerException

AWS IoT Greengrass can't process your request right now. Try again later.

retryAfterSeconds: The amount of time to wait before you retry the request.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource can't be found.

resourceId: The ID of the resource that isn't found.
resourceType: The type of the resource that isn't found.

HTTP Status Code: 404

ThrottlingException

Your request exceeded a request rate quota. For example, you might have exceeded the amount of times that you can retrieve device or deployment status per second.

quotaCode: The code for the quota in Service Quotas.
retryAfterSeconds: The amount of time to wait before you retry the request.
serviceCode: The code for the service in Service Quotas.

HTTP Status Code: 429

ValidationException

The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters.

fields: The list of fields that failed to validate.
reason: The reason for the validation exception.

HTTP Status Code: 400