/AWS1/IF_EC2=>EXPORTIMAGE()

About ExportImage

Exports an Amazon Machine Image (AMI) to a VM file. For more information, see Exporting a VM directly from an Amazon Machine Image (AMI) in the VM Import/Export User Guide.

Method Signature

METHODS /AWS1/IF_EC2~EXPORTIMAGE
  IMPORTING
    !IV_CLIENTTOKEN TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DESCRIPTION TYPE /AWS1/EC2STRING OPTIONAL
    !IV_DISKIMAGEFORMAT TYPE /AWS1/EC2DISKIMAGEFORMAT OPTIONAL
    !IV_DRYRUN TYPE /AWS1/EC2BOOLEAN OPTIONAL
    !IV_IMAGEID TYPE /AWS1/EC2IMAGEID OPTIONAL
    !IO_S3EXPORTLOCATION TYPE REF TO /AWS1/CL_EC2EXPORTTASKS3LOCREQ OPTIONAL
    !IV_ROLENAME TYPE /AWS1/EC2STRING OPTIONAL
    !IT_TAGSPECIFICATIONS TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_ec2exportimageresult
  RAISING
    /AWS1/CX_EC2CLIENTEXC
    /AWS1/CX_EC2SERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_diskimageformat TYPE /AWS1/EC2DISKIMAGEFORMAT /AWS1/EC2DISKIMAGEFORMAT

The disk image format.

iv_imageid TYPE /AWS1/EC2IMAGEID /AWS1/EC2IMAGEID

The ID of the image.

io_s3exportlocation TYPE REF TO /AWS1/CL_EC2EXPORTTASKS3LOCREQ /AWS1/CL_EC2EXPORTTASKS3LOCREQ

The Amazon S3 bucket for the destination image. The destination bucket must exist.

Optional arguments:

iv_clienttoken TYPE /AWS1/EC2STRING /AWS1/EC2STRING

Token to enable idempotency for export image requests.

iv_description TYPE /AWS1/EC2STRING /AWS1/EC2STRING

A description of the image being exported. The maximum length is 255 characters.

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.

iv_rolename TYPE /AWS1/EC2STRING /AWS1/EC2STRING

The name of the role that grants VM Import/Export permission to export images to your Amazon S3 bucket. If this parameter is not specified, the default role is named 'vmimport'.

it_tagspecifications TYPE /AWS1/CL_EC2TAGSPECIFICATION=>TT_TAGSPECIFICATIONLIST TT_TAGSPECIFICATIONLIST

The tags to apply to the export image task during creation.

RETURNING

oo_output TYPE REF TO /aws1/cl_ec2exportimageresult /AWS1/CL_EC2EXPORTIMAGERESULT

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->exportimage(
  io_s3exportlocation = new /aws1/cl_ec2exporttasks3locreq(
    iv_s3bucket = |string|
    iv_s3prefix = |string|
  )
  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_clienttoken = |string|
  iv_description = |string|
  iv_diskimageformat = |string|
  iv_dryrun = ABAP_TRUE
  iv_imageid = |string|
  iv_rolename = |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_description( ).
  lv_diskimageformat = lo_result->get_diskimageformat( ).
  lv_string = lo_result->get_exportimagetaskid( ).
  lv_string = lo_result->get_imageid( ).
  lv_string = lo_result->get_rolename( ).
  lv_string = lo_result->get_progress( ).
  lo_exporttasks3location = lo_result->get_s3exportlocation( ).
  IF lo_exporttasks3location IS NOT INITIAL.
    lv_string = lo_exporttasks3location->get_s3bucket( ).
    lv_string = lo_exporttasks3location->get_s3prefix( ).
  ENDIF.
  lv_string = lo_result->get_status( ).
  lv_string = lo_result->get_statusmessage( ).
  LOOP AT lo_result->get_tags( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_key( ).
      lv_string = lo_row_1->get_value( ).
    ENDIF.
  ENDLOOP.
ENDIF.