CREATERESTOREIMAGETASK()`¶

About CreateRestoreImageTask¶

Starts a task that restores an AMI from an Amazon S3 object that was previously created by using CreateStoreImageTask.

To use this API, you must have the required permissions. For more information, see Permissions for storing and restoring AMIs using S3 in the Amazon EC2 User Guide.

For more information, see Store and restore an AMI using S3 in the Amazon EC2 User Guide.

Method Signature¶

IMPORTING¶

Required arguments:¶

`iv_bucket` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The name of the Amazon S3 bucket that contains the stored AMI object.

`iv_objectkey` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The name of the stored AMI object in the bucket.

Optional arguments:¶

`iv_name` `TYPE /AWS1/EC2STRING` `/AWS1/EC2STRING`¶

The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.

`it_tagspecifications` `TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST` `TT_TAGSPECIFICATIONLIST`¶

The tags to apply to the AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.

To tag the AMI, the value for ResourceType must be image.

To tag the snapshots, the value for ResourceType must be snapshot. The same tag is applied to all of the snapshots that are created.

`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_ec2crerestoreimaget01` `/AWS1/CL_EC2CRERESTOREIMAGET01`¶

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->/aws1/if_ec2~createrestoreimagetask(
  it_tagspecifications = VALUE /aws1/cl_ec2tagspecification=>tt_tagspecificationlist(
    (
      new /aws1/cl_ec2tagspecification(
        it_tags = VALUE /aws1/cl_ec2tag=>tt_taglist(
          (
            new /aws1/cl_ec2tag(
              iv_key = |string|
              iv_value = |string|
            )
          )
        )
        iv_resourcetype = |string|
      )
    )
  )
  iv_bucket = |string|
  iv_dryrun = ABAP_TRUE
  iv_name = |string|
  iv_objectkey = |string|
).

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_imageid( ).
ENDIF.

/AWS1/CL_EC2=>CREATERESTOREIMAGETASK()¶