Skip to content

List Snapshot Blocks

ebs_list_snapshot_blocks R Documentation

Returns information about the blocks in an Amazon Elastic Block Store snapshot

Description

Returns information about the blocks in an Amazon Elastic Block Store snapshot.

You should always retry requests that receive server (⁠5xx⁠) error responses, and ThrottlingException and RequestThrottledException client error responses. For more information see Error retries in the Amazon Elastic Compute Cloud User Guide.

Usage

ebs_list_snapshot_blocks(SnapshotId, NextToken, MaxResults,
  StartingBlockIndex)

Arguments

SnapshotId

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

NextToken

The token to request the next page of results.

If you specify NextToken, then StartingBlockIndex is ignored.

MaxResults

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.

StartingBlockIndex

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.

Value

A list with the following syntax: 

list(
  Blocks = list(
    list(
      BlockIndex = 123,
      BlockToken = "string"
    )
  ),
  ExpiryTime = as.POSIXct(
    "2015-01-01"
  ),
  VolumeSize = 123,
  BlockSize = 123,
  NextToken = "string"
)

Request syntax

svc$list_snapshot_blocks(
  SnapshotId = "string",
  NextToken = "string",
  MaxResults = 123,
  StartingBlockIndex = 123
)