DescribeLedgerCommand

Suggest an Edit

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

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { QLDBClient, DescribeLedgerCommand } from "@aws-sdk/client-qldb"; // ES Modules import
// const { QLDBClient, DescribeLedgerCommand } = require("@aws-sdk/client-qldb"); // CommonJS import
const client = new QLDBClient(config);
const input = { // DescribeLedgerRequest
  Name: "STRING_VALUE", // required
};
const command = new DescribeLedgerCommand(input);
const response = await client.send(command);
// { // DescribeLedgerResponse
//   Name: "STRING_VALUE",
//   Arn: "STRING_VALUE",
//   State: "CREATING" || "ACTIVE" || "DELETING" || "DELETED",
//   CreationDateTime: new Date("TIMESTAMP"),
//   PermissionsMode: "ALLOW_ALL" || "STANDARD",
//   DeletionProtection: true || false,
//   EncryptionDescription: { // LedgerEncryptionDescription
//     KmsKeyArn: "STRING_VALUE", // required
//     EncryptionStatus: "ENABLED" || "UPDATING" || "KMS_KEY_INACCESSIBLE", // required
//     InaccessibleKmsKeyDateTime: new Date("TIMESTAMP"),
//   },
// };

DescribeLedgerCommand Input

See DescribeLedgerCommandInput for more details

Parameter
Type
Description
Name
Required
string | undefined

The name of the ledger that you want to describe.

DescribeLedgerCommand Output

See DescribeLedgerCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The Amazon Resource Name (ARN) for the ledger.

CreationDateTime
Date | undefined

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.)

DeletionProtection
boolean | undefined

Specifies whether the ledger is protected from being deleted by any user. If not defined during ledger creation, this feature is enabled (true) by default.

If deletion protection is enabled, you must first disable it before you can delete the ledger. You can disable it by calling the UpdateLedger operation to set this parameter to false.

EncryptionDescription
LedgerEncryptionDescription | undefined

Information about the encryption of data at rest in the ledger. This includes the current status, the KMS key, and when the key became inaccessible (in the case of an error). If this parameter is undefined, the ledger uses an Amazon Web Services owned KMS key for encryption.

Name
string | undefined

The name of the ledger.

PermissionsMode
PermissionsMode | undefined

The permissions mode of the ledger.

State
LedgerState | undefined

The current status of the ledger.

Throws

Name
Fault
Details
InvalidParameterException
client

One or more parameters in the request aren't valid.

ResourceNotFoundException
client

The specified resource doesn't exist.

QLDBServiceException
Base exception class for all service exceptions from QLDB service.