Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472262334.5 KB

This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

post/legal-holds/

Request body

Titlestring required

This is the string title of the legal hold.

Descriptionstring required

This is the string description of the legal hold.

IdempotencyTokenstring

This is a user-chosen string used to distinguish between otherwise identical calls. Retrying a successful request with the same idempotency token results in a success message with no action taken.

Tagsobject

Optional tags to include. A tag is a key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Response

Success

Titlestring

This is the string title of the legal hold returned after creating the legal hold.

Status'CREATING' | 'ACTIVE' | 'CANCELING' | 'CANCELED'

This displays the status of the legal hold returned after creating the legal hold. Statuses can be <code>ACTIVE</code>, <code>PENDING</code>, <code>CANCELED</code>, <code>CANCELING</code>, or <code>FAILED</code>.

Descriptionstring

This is the returned string description of the legal hold.

LegalHoldIdstring

Legal hold ID returned for the specified legal hold on a recovery point.

LegalHoldArnstring

This is the ARN (Amazon Resource Number) of the created legal hold.

CreationDatestring date-time

Time in number format when legal hold was created.