get_digest

QLDB.Client.get_digest(**kwargs)

Returns the digest of a ledger at the latest committed block in the journal. The response includes a 256-bit hash value and a block address.

See also: AWS API Documentation

Request Syntax

response = client.get_digest(
    Name='string'
)

Parameters

Name (string) --

[REQUIRED]

The name of the ledger.

Return type

dict

Returns

Response Syntax

{
    'Digest': b'bytes',
    'DigestTipAddress': {
        'IonText': 'string'
    }
}

Response Structure

• (dict) --
  • Digest (bytes) --

    The 256-bit hash value representing the digest returned by a GetDigest request.

  • DigestTipAddress (dict) --

    The latest block location covered by the digest that you requested. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo .

    • IonText (string) --

      An Amazon Ion plaintext value contained in a ValueHolder structure.

Exceptions

• QLDB.Client.exceptions.InvalidParameterException
• QLDB.Client.exceptions.ResourceNotFoundException
• QLDB.Client.exceptions.ResourcePreconditionNotMetException