LISTMIGRATIONS()`¶

About ListMigrations¶

Lists migration jobs for an Amazon OpenSearch Service application. You can filter results by migration status. Use pagination to ensure that the operation returns quickly and successfully.

Method Signature¶

METHODS /AWS1/IF_OSR~LISTMIGRATIONS
  IMPORTING
    !IV_APPLICATIONID TYPE /AWS1/OSRAPPLICATIONID OPTIONAL
    !IV_STATUS TYPE /AWS1/OSRSTRING OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OSRINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OSRSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_osrlistmigrsresponse
  RAISING
    /AWS1/CX_OSRACCESSDENIEDEX
    /AWS1/CX_OSRDISABLEDOPEX
    /AWS1/CX_OSRINTERNALEXCEPTION
    /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 list migrations for.

Optional arguments:¶

`iv_status` `TYPE /AWS1/OSRSTRING` `/AWS1/OSRSTRING`¶

Filters the results by migration status. Valid values are PENDING, IN_PROGRESS, SUCCEEDED, and FAILED.

`iv_maxresults` `TYPE /AWS1/OSRINTEGER` `/AWS1/OSRINTEGER`¶

The maximum number of results to return in a single call.

`iv_nexttoken` `TYPE /AWS1/OSRSTRING` `/AWS1/OSRSTRING`¶

The pagination token from a previous call to retrieve the next set of results.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_osrlistmigrsresponse` `/AWS1/CL_OSRLISTMIGRSRESPONSE`¶

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->listmigrations(
  iv_applicationid = |string|
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_status = |string|
).

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_migrations( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_migrationid( ).
      lv_string = lo_row_1->get_status( ).
      lv_applicationid = lo_row_1->get_applicationid( ).
      lo_migrationsource = lo_row_1->get_source( ).
      IF lo_migrationsource IS NOT INITIAL.
        lv_arn = lo_migrationsource->get_datasourcearn( ).
      ENDIF.
      lv_integer = lo_row_1->get_exportedcount( ).
      lv_integer = lo_row_1->get_importedcount( ).
      lo_migrationerror = lo_row_1->get_error( ).
      IF lo_migrationerror IS NOT INITIAL.
        lv_string = lo_migrationerror->get_code( ).
        lv_string = lo_migrationerror->get_message( ).
      ENDIF.
      lv_updatetimestamp = lo_row_1->get_createdat( ).
      lv_updatetimestamp = lo_row_1->get_updatedat( ).
    ENDIF.
  ENDLOOP.
  lv_string = lo_result->get_nexttoken( ).
ENDIF.

/AWS1/IF_OSR=>LISTMIGRATIONS()¶