Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ListSnapshotBlocksRequest

Hierarchy

Index

Properties

Optional MaxResults

MaxResults: undefined | number

The maximum number of blocks to be returned by the request.

Even if additional blocks can be retrieved from the snapshot, the request can return less blocks than MaxResults or an empty array of blocks.

To retrieve the next set of blocks from the snapshot, make another request with the returned NextToken value. The value of NextToken is null when there are no more blocks to return.

Optional NextToken

NextToken: undefined | string

The token to request the next page of results.

If you specify NextToken, then StartingBlockIndex is ignored.

SnapshotId

SnapshotId: string | undefined

The ID of the snapshot from which to get block indexes and block tokens.

Optional StartingBlockIndex

StartingBlockIndex: undefined | number

The block index from which the list should start. The list in the response will start from this block index or the next valid block index in the snapshot.

If you specify NextToken, then StartingBlockIndex is ignored.