DescribeLedger - Amazon Quantum Ledger Database (Amazon QLDB)

DescribeLedger

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

Request Syntax

GET /ledgers/name HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

name

The name of the ledger that you want to describe.

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "Arn": "string", "CreationDateTime": number, "DeletionProtection": boolean, "EncryptionDescription": { "EncryptionStatus": "string", "InaccessibleKmsKeyDateTime": number, "KmsKeyArn": "string" }, "Name": "string", "PermissionsMode": "string", "State": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Arn

The Amazon Resource Name (ARN) for the ledger.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 1600.

CreationDateTime

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

Type: Timestamp

DeletionProtection

The flag that prevents a ledger from being deleted by any user. If not provided on 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 the flag to false.

Type: Boolean

EncryptionDescription

Information about the encryption of data at rest in the ledger. This includes the current status, the AWS KMS key, and when the key became inaccessible (in the case of an error).

Type: LedgerEncryptionDescription object

Name

The name of the ledger.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 32.

Pattern: (?!^.*--)(?!^[0-9]+$)(?!^-)(?!.*-$)^[A-Za-z0-9-]+$

PermissionsMode

The permissions mode of the ledger.

Type: String

Valid Values: ALLOW_ALL | STANDARD

State

The current status of the ledger.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | DELETED

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

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

HTTP Status Code: 400

ResourceNotFoundException

The specified resource doesn't exist.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: