COMPLETESNAPSHOT()`¶

About CompleteSnapshot¶

Seals and completes the snapshot after all of the required blocks of data have been written to it. Completing the snapshot changes the status to completed. You cannot write new blocks to a snapshot after it has been completed.

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~COMPLETESNAPSHOT
  IMPORTING
    !IV_SNAPSHOTID TYPE /AWS1/EBSSNAPSHOTID OPTIONAL
    !IV_CHANGEDBLOCKSCOUNT TYPE /AWS1/EBSCHANGEDBLOCKSCOUNT OPTIONAL
    !IV_CHECKSUM TYPE /AWS1/EBSCHECKSUM OPTIONAL
    !IV_CHECKSUMALGORITHM TYPE /AWS1/EBSCHECKSUMALGORITHM OPTIONAL
    !IV_CHECKSUMAGGREGATIONMETHOD TYPE /AWS1/EBSCHECKSUMAGGRMETHOD OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ebscomplsnapresponse
  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.

`iv_changedblockscount` `TYPE /AWS1/EBSCHANGEDBLOCKSCOUNT` `/AWS1/EBSCHANGEDBLOCKSCOUNT`¶

The number of blocks that were written to the snapshot.

Optional arguments:¶

`iv_checksum` `TYPE /AWS1/EBSCHECKSUM` `/AWS1/EBSCHECKSUM`¶

An aggregated Base-64 SHA256 checksum based on the checksums of each written block.

To generate the aggregated checksum using the linear aggregation method, arrange the checksums for each written block in ascending order of their block index, concatenate them to form a single string, and then generate the checksum on the entire string using the SHA256 algorithm.

`iv_checksumalgorithm` `TYPE /AWS1/EBSCHECKSUMALGORITHM` `/AWS1/EBSCHECKSUMALGORITHM`¶

The algorithm used to generate the checksum. Currently, the only supported algorithm is SHA256.

`iv_checksumaggregationmethod` `TYPE /AWS1/EBSCHECKSUMAGGRMETHOD` `/AWS1/EBSCHECKSUMAGGRMETHOD`¶

The aggregation method used to generate the checksum. Currently, the only supported aggregation method is LINEAR.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ebscomplsnapresponse` `/AWS1/CL_EBSCOMPLSNAPRESPONSE`¶

Domain /AWS1/RT_ACCOUNT_ID

Primitive Type NUMC

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->completesnapshot(
  iv_changedblockscount = 123
  iv_checksum = |string|
  iv_checksumaggregationmethod = |string|
  iv_checksumalgorithm = |string|
  iv_snapshotid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_status = lo_result->get_status( ).
ENDIF.

/AWS1/IF_EBS=>COMPLETESNAPSHOT()¶