/AWS1/IF_LSA=>COPYSNAPSHOT()

About CopySnapshot

Copies a manual snapshot of an instance or disk as another manual snapshot, or copies an automatic snapshot of an instance or disk as a manual snapshot. This operation can also be used to copy a manual or automatic snapshot of an instance or a disk from one Amazon Web Services Region to another in Amazon Lightsail.

When copying a manual snapshot, be sure to define the source region, source snapshot name, and target snapshot name parameters.

When copying an automatic snapshot, be sure to define the source region, source resource name, target snapshot name, and either the restore date or the use latest restorable auto snapshot parameters.

Method Signature

METHODS /AWS1/IF_LSA~COPYSNAPSHOT
  IMPORTING
    !IV_SOURCESNAPSHOTNAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_SOURCERESOURCENAME TYPE /AWS1/LSASTRING OPTIONAL
    !IV_RESTOREDATE TYPE /AWS1/LSASTRING OPTIONAL
    !IV_USELATSTRESTORABLEAUTOS00 TYPE /AWS1/LSABOOLEAN OPTIONAL
    !IV_TARGETSNAPSHOTNAME TYPE /AWS1/LSARESOURCENAME OPTIONAL
    !IV_SOURCEREGION TYPE /AWS1/LSAREGIONNAME OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lsacopysnapshotresult
  RAISING
    /AWS1/CX_LSAACCESSDENIEDEX
    /AWS1/CX_LSAACCTSETUPINPRGSSEX
    /AWS1/CX_LSAINVALIDINPUTEX
    /AWS1/CX_LSANOTFOUNDEXCEPTION
    /AWS1/CX_LSAOPERATIONFAILUREEX
    /AWS1/CX_LSARGNSETUPINPRGSSEX
    /AWS1/CX_LSASERVICEEXCEPTION
    /AWS1/CX_LSAUNAUTHNTCTDEX
    /AWS1/CX_LSACLIENTEXC
    /AWS1/CX_LSASERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_targetsnapshotname TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the new manual snapshot to be created as a copy.

iv_sourceregion TYPE /AWS1/LSAREGIONNAME /AWS1/LSAREGIONNAME

The Amazon Web Services Region where the source manual or automatic snapshot is located.

Optional arguments:

iv_sourcesnapshotname TYPE /AWS1/LSARESOURCENAME /AWS1/LSARESOURCENAME

The name of the source manual snapshot to copy.

Constraint:

• Define this parameter only when copying a manual snapshot as another manual snapshot.

iv_sourceresourcename TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The name of the source instance or disk from which the source automatic snapshot was created.

Constraint:

• Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

iv_restoredate TYPE /AWS1/LSASTRING /AWS1/LSASTRING

The date of the source automatic snapshot to copy. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

• Must be specified in YYYY-MM-DD format.

• This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

• Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

iv_uselatstrestorableautos00 TYPE /AWS1/LSABOOLEAN /AWS1/LSABOOLEAN

A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.

Constraints:

• This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

• Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.

RETURNING

oo_output TYPE REF TO /aws1/cl_lsacopysnapshotresult /AWS1/CL_LSACOPYSNAPSHOTRESULT

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->copysnapshot(
  iv_restoredate = |string|
  iv_sourceregion = |string|
  iv_sourceresourcename = |string|
  iv_sourcesnapshotname = |string|
  iv_targetsnapshotname = |string|
  iv_uselatstrestorableautos00 = ABAP_TRUE
).

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_operations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_nonemptystring = lo_row_1->get_id( ).
      lv_resourcename = lo_row_1->get_resourcename( ).
      lv_resourcetype = lo_row_1->get_resourcetype( ).
      lv_isodate = lo_row_1->get_createdat( ).
      lo_resourcelocation = lo_row_1->get_location( ).
      IF lo_resourcelocation IS NOT INITIAL.
        lv_string = lo_resourcelocation->get_availabilityzone( ).
        lv_regionname = lo_resourcelocation->get_regionname( ).
      ENDIF.
      lv_boolean = lo_row_1->get_isterminal( ).
      lv_string = lo_row_1->get_operationdetails( ).
      lv_operationtype = lo_row_1->get_operationtype( ).
      lv_operationstatus = lo_row_1->get_status( ).
      lv_isodate = lo_row_1->get_statuschangedat( ).
      lv_string = lo_row_1->get_errorcode( ).
      lv_string = lo_row_1->get_errordetails( ).
    ENDIF.
  ENDLOOP.
ENDIF.