RESTORESNAPSHOTTIER()`¶

About RestoreSnapshotTier¶

Restores an archived Amazon EBS snapshot for use temporarily or permanently, or modifies the restore period or restore type for a snapshot that was previously temporarily restored.

For more information see Restore an archived snapshot and modify the restore period or restore type for a temporarily restored snapshot in the Amazon EBS User Guide.

Method Signature¶

METHODS /AWS1/IF_EC2~RESTORESNAPSHOTTIER
  IMPORTING
    !IV_SNAPSHOTID TYPE /AWS1/EC2SNAPSHOTID OPTIONAL
    !IV_TEMPORARYRESTOREDAYS TYPE /AWS1/EC2RESTORESNAPTIERREQT00 OPTIONAL
    !IV_PERMANENTRESTORE TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2restoresnaptierrs
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_snapshotid` `TYPE /AWS1/EC2SNAPSHOTID` `/AWS1/EC2SNAPSHOTID`¶

The ID of the snapshot to restore.

Optional arguments:¶

`iv_temporaryrestoredays` `TYPE /AWS1/EC2RESTORESNAPTIERREQT00` `/AWS1/EC2RESTORESNAPTIERREQT00`¶

Specifies the number of days for which to temporarily restore an archived snapshot. Required for temporary restores only. The snapshot will be automatically re-archived after this period.

To temporarily restore an archived snapshot, specify the number of days and omit the PermanentRestore parameter or set it to false.

`iv_permanentrestore` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Indicates whether to permanently restore an archived snapshot. To permanently restore an archived snapshot, specify true and omit the RestoreSnapshotTierRequest$TemporaryRestoreDays parameter.

`iv_dryrun` `TYPE /AWS1/EC2BOOLEAN` `/AWS1/EC2BOOLEAN`¶

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_ec2restoresnaptierrs` `/AWS1/CL_EC2RESTORESNAPTIERRS`¶

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->restoresnapshottier(
  iv_dryrun = ABAP_TRUE
  iv_permanentrestore = ABAP_TRUE
  iv_snapshotid = |string|
  iv_temporaryrestoredays = 123
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_string = lo_result->get_snapshotid( ).
  lv_milliseconddatetime = lo_result->get_restorestarttime( ).
  lv_integer = lo_result->get_restoreduration( ).
  lv_boolean = lo_result->get_ispermanentrestore( ).
ENDIF.

/AWS1/IF_EC2=>RESTORESNAPSHOTTIER()¶