Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1472262334.5 KB

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to metadata.

get/legal-holds/{legalHoldId}/

Path parameters

legalHoldIdstring required

This is the ID required to use <code>GetLegalHold</code>. This unique ID is associated with a specific legal hold.

Response

Success

Titlestring

This is the string title of the legal hold.

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

This is the status of the legal hold. Statuses can be <code>ACTIVE</code>, <code>CREATING</code>, <code>CANCELED</code>, and <code>CANCELING</code>.

Descriptionstring

This is the returned string description of the legal hold.

CancelDescriptionstring

String describing the reason for removing the legal hold.

LegalHoldIdstring

This is the returned ID associated with a specified legal hold.

LegalHoldArnstring

This is the returned framework ARN for the specified legal hold. An Amazon Resource Name (ARN) uniquely identifies a resource. The format of the ARN depends on the resource type.

CreationDatestring date-time

Time in number format when legal hold was created.

CancellationDatestring date-time

Time in number when legal hold was cancelled.

RetainRecordUntilstring date-time

This is the date and time until which the legal hold record will be retained.