Backup / Client / cancel_legal_hold

cancel_legal_hold

Backup.Client.cancel_legal_hold(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response = client.cancel_legal_hold(
    LegalHoldId='string',
    CancelDescription='string',
    RetainRecordInDays=123
)

Parameters:

• LegalHoldId (string) –

  [REQUIRED]

  Legal hold ID required to remove the specified legal hold on a recovery point.

• CancelDescription (string) –

  [REQUIRED]

  String describing the reason for removing the legal hold.

• RetainRecordInDays (integer) – The integer amount in days specifying amount of days after this API operation to remove legal hold.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

• (dict) –

Exceptions

• Backup.Client.exceptions.InvalidParameterValueException

• Backup.Client.exceptions.InvalidResourceStateException

• Backup.Client.exceptions.MissingParameterValueException

• Backup.Client.exceptions.ServiceUnavailableException

• Backup.Client.exceptions.ResourceNotFoundException