Get Block

qldb_get_block

R Documentation

Returns a block object at a specified address in a journal¶

Description¶

Returns a block object at a specified address in a journal. Also returns a proof of the specified block for verification if DigestTipAddress is provided.

For information about the data contents in a block, see Journal contents in the Amazon QLDB Developer Guide.

If the specified ledger doesn't exist or is in DELETING status, then throws ResourceNotFoundException.

If the specified ledger is in CREATING status, then throws ResourcePreconditionNotMetException.

If no block exists with the specified address, then throws InvalidParameterException.

Usage¶

qldb_get_block(Name, BlockAddress, DigestTipAddress)

Arguments¶

Name

[required] The name of the ledger.

BlockAddress

[required] The location of the block that you want to request. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

For example: ⁠{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:14}⁠.

DigestTipAddress

The latest block location covered by the digest for which to request a proof. An address is an Amazon Ion structure that has two fields: strandId and sequenceNo.

For example: ⁠{strandId:"BlFTjlSXze9BIh1KOszcE3",sequenceNo:49}⁠.

Value¶

A list with the following syntax:

list(
  Block = list(
    IonText = "string"
  ),
  Proof = list(
    IonText = "string"
  )
)

Request syntax¶

svc$get_block(
  Name = "string",
  BlockAddress = list(
    IonText = "string"
  ),
  DigestTipAddress = list(
    IonText = "string"
  )
)