STARTMIGRATION()`¶

About StartMigration¶

Initiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace. Saved objects include dashboards, visualizations, index patterns, and searches. You can specify export filters to control the scope of the migration and a conflict resolution strategy for handling existing objects in the target workspace.

Method Signature¶

METHODS /AWS1/IF_OSR~STARTMIGRATION
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/OSRAPPLICATIONID OPTIONAL
    !IO_MIGRATIONOPTIONS TYPE REF TO /AWS1/CL_OSRMIGRATIONOPTIONS OPTIONAL
    !IV_CLIENTTOKEN TYPE /AWS1/OSRCLIENTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrstartmigrresponse
  RAISING
    /AWS1/CX_OSRACCESSDENIEDEX
    /AWS1/CX_OSRCONFLICTEXCEPTION
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINTERNALEXCEPTION
    /AWS1/CX_OSRRESOURCENOTFOUNDEX
    /AWS1/CX_OSRVALIDATIONEX
    /AWS1/CX_OSRCLIENTEXC
    /AWS1/CX_OSRSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_applicationid` `TYPE /AWS1/OSRAPPLICATIONID` `/AWS1/OSRAPPLICATIONID`¶

The unique identifier of the OpenSearch application to migrate saved objects into.

`io_migrationoptions` `TYPE REF TO /AWS1/CL_OSRMIGRATIONOPTIONS` `/AWS1/CL_OSRMIGRATIONOPTIONS`¶

The configuration options for the migration, including the source data source, target workspace, export filters, and conflict resolution strategy.

Optional arguments:¶

`iv_clienttoken` `TYPE /AWS1/OSRCLIENTTOKEN` `/AWS1/OSRCLIENTTOKEN`¶

A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, Amazon OpenSearch Service ignores the request but does not return an error.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrstartmigrresponse` `/AWS1/CL_OSRSTARTMIGRRESPONSE`¶

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->startmigration(
  io_migrationoptions = new /aws1/cl_osrmigrationoptions(
    io_exportoptions = new /aws1/cl_osrexportoptions(
      it_objects = VALUE /aws1/cl_osrsavedobjectid=>tt_savedobjectidentifierlist(
        (
          new /aws1/cl_osrsavedobjectid(
            iv_id = |string|
            iv_type = |string|
          )
        )
      )
      it_types = VALUE /aws1/cl_osrstringlist_w=>tt_stringlist(
        ( new /aws1/cl_osrstringlist_w( |string| ) )
      )
      iv_includereferencesdeep = ABAP_TRUE
    )
    io_source = new /aws1/cl_osrmigrationsource( |string| )
    io_workspace = new /aws1/cl_osrmigrationworkspace(
      iv_createworkspace = ABAP_TRUE
      iv_name = |string|
      iv_type = |string|
      iv_workspaceid = |string|
    )
    iv_conflictresolution = |string|
  )
  iv_applicationid = |string|
  iv_clienttoken = |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_migrationid( ).
  lv_string = lo_result->get_status( ).
ENDIF.

/AWS1/IF_OSR=>STARTMIGRATION()¶