CancelLegalHold - AWS Backup

CancelLegalHold

Removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

Request Syntax

DELETE /legal-holds/legalHoldId?cancelDescription=CancelDescription&retainRecordInDays=RetainRecordInDays HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

CancelDescription

A string the describes the reason for removing the legal hold.

Required: Yes

legalHoldId

The ID of the legal hold.

Required: Yes

RetainRecordInDays

The integer amount, in days, after which to remove legal hold.

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 201

Response Elements

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

Errors

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

InvalidParameterValueException

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

HTTP Status Code: 400

InvalidResourceStateException

AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

HTTP Status Code: 400

MissingParameterValueException

Indicates that a required parameter is missing.

HTTP Status Code: 400

ResourceNotFoundException

A resource that is required for the action doesn't exist.

HTTP Status Code: 400

ServiceUnavailableException

The request failed due to a temporary failure of the server.

HTTP Status Code: 500

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: