Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14208295.3 KB

Returns information about a ledger, including its state, permissions mode, encryption at rest settings, and when it was created.

get/ledgers/{name}

Path parameters

namestring required

The name of the ledger that you want to describe.

Response

Success

Namestring

The name of the ledger.

Arnstring

The Amazon Resource Name (ARN) for the ledger.

State'CREATING' | 'ACTIVE' | 'DELETING' | 'DELETED'

The current status of the ledger.

CreationDateTimestring date-time

The date and time, in epoch time format, when the ledger was created. (Epoch time format is the number of seconds elapsed since 12:00:00 AM January 1, 1970 UTC.)

PermissionsMode'ALLOW_ALL' | 'STANDARD'

The permissions mode of the ledger.

DeletionProtectionboolean
<p>The flag that prevents a ledger from being deleted by any user. If not provided on ledger creation, this feature is enabled (<code>true</code>) by default.</p> <p>If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the <code>UpdateLedger</code> operation to set the flag to <code>false</code>.</p>