LISTSNAPSHOTBLOCKS()`¶

About ListSnapshotBlocks¶

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.

Method Signature¶

METHODS /AWS1/IF_EBS~LISTSNAPSHOTBLOCKS
  IMPORTING
    !IV_SNAPSHOTID TYPE /AWS1/EBSSNAPSHOTID OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/EBSPAGETOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/EBSMAXRESULTS OPTIONAL
    !IV_STARTINGBLOCKINDEX TYPE /AWS1/EBSBLOCKINDEX OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ebslistsnapblocksrsp
  RAISING
    /AWS1/CX_EBSACCESSDENIEDEX
    /AWS1/CX_EBSINTERNALSERVEREX
    /AWS1/CX_EBSREQUESTTHROTTLEDEX
    /AWS1/CX_EBSRESOURCENOTFOUNDEX
    /AWS1/CX_EBSSERVICEQUOTAEXCDEX
    /AWS1/CX_EBSVALIDATIONEX
    /AWS1/CX_EBSCLIENTEXC
    /AWS1/CX_EBSSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_snapshotid` `TYPE /AWS1/EBSSNAPSHOTID` `/AWS1/EBSSNAPSHOTID`¶

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

Optional arguments:¶

`iv_nexttoken` `TYPE /AWS1/EBSPAGETOKEN` `/AWS1/EBSPAGETOKEN`¶

The token to request the next page of results.

If you specify NextToken, then StartingBlockIndex is ignored.

`iv_maxresults` `TYPE /AWS1/EBSMAXRESULTS` `/AWS1/EBSMAXRESULTS`¶

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.

`iv_startingblockindex` `TYPE /AWS1/EBSBLOCKINDEX` `/AWS1/EBSBLOCKINDEX`¶

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.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ebslistsnapblocksrsp` `/AWS1/CL_EBSLISTSNAPBLOCKSRSP`¶

Examples¶

Syntax Example¶

This is an example of the syntax for calling the method. It includes every possible argument and initializes every possible value. The data provided is not necessarily semantically accurate (for example the value "string" may be provided for something that is intended to be an instance ID, or in some cases two arguments may be mutually exclusive). The syntax shows the ABAP syntax for creating the various data structures.

DATA(lo_result) = lo_client->listsnapshotblocks(
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_snapshotid = |string|
  iv_startingblockindex = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  LOOP AT lo_result->get_blocks( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_blockindex = lo_row_1->get_blockindex( ).
      lv_blocktoken = lo_row_1->get_blocktoken( ).
    ENDIF.
  ENDLOOP.
  lv_timestamp = lo_result->get_expirytime( ).
  lv_volumesize = lo_result->get_volumesize( ).
  lv_blocksize = lo_result->get_blocksize( ).
  lv_pagetoken = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_EBS=>LISTSNAPSHOTBLOCKS()¶