Skip to content

/AWS1/IF_LXB=>GETMIGRATIONS()

About GetMigrations

Gets a list of migrations between Amazon Lex V1 and Amazon Lex V2.

Method Signature

METHODS /AWS1/IF_LXB~GETMIGRATIONS
  IMPORTING
    !IV_SORTBYATTRIBUTE TYPE /AWS1/LXBMIGRATIONSORTATTR OPTIONAL
    !IV_SORTBYORDER TYPE /AWS1/LXBSORTORDER OPTIONAL
    !IV_V1BOTNAMECONTAINS TYPE /AWS1/LXBBOTNAME OPTIONAL
    !IV_MIGRATIONSTATUSEQUALS TYPE /AWS1/LXBMIGRATIONSTATUS OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/LXBMAXRESULTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/LXBNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_lxbgetmigrationsrsp
  RAISING
    /AWS1/CX_LXBBADREQUESTEX
    /AWS1/CX_LXBINTERNALFAILUREEX
    /AWS1/CX_LXBLIMITEXCEEDEDEX
    /AWS1/CX_LXBCLIENTEXC
    /AWS1/CX_LXBSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_sortbyattribute TYPE /AWS1/LXBMIGRATIONSORTATTR /AWS1/LXBMIGRATIONSORTATTR

The field to sort the list of migrations by. You can sort by the Amazon Lex V1 bot name or the date and time that the migration was started.

iv_sortbyorder TYPE /AWS1/LXBSORTORDER /AWS1/LXBSORTORDER

The order so sort the list.

iv_v1botnamecontains TYPE /AWS1/LXBBOTNAME /AWS1/LXBBOTNAME

Filters the list to contain only bots whose name contains the specified string. The string is matched anywhere in bot name.

iv_migrationstatusequals TYPE /AWS1/LXBMIGRATIONSTATUS /AWS1/LXBMIGRATIONSTATUS

Filters the list to contain only migrations in the specified state.

iv_maxresults TYPE /AWS1/LXBMAXRESULTS /AWS1/LXBMAXRESULTS

The maximum number of migrations to return in the response. The default is 10.

iv_nexttoken TYPE /AWS1/LXBNEXTTOKEN /AWS1/LXBNEXTTOKEN

A pagination token that fetches the next page of migrations. If the response to this operation is truncated, Amazon Lex returns a pagination token in the response. To fetch the next page of migrations, specify the pagination token in the request.

RETURNING

oo_output TYPE REF TO /aws1/cl_lxbgetmigrationsrsp /AWS1/CL_LXBGETMIGRATIONSRSP

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->getmigrations(
  iv_maxresults = 123
  iv_migrationstatusequals = |string|
  iv_nexttoken = |string|
  iv_sortbyattribute = |string|
  iv_sortbyorder = |string|
  iv_v1botnamecontains = |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_migrationsummaries( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_migrationid = lo_row_1->get_migrationid( ).
      lv_botname = lo_row_1->get_v1botname( ).
      lv_version = lo_row_1->get_v1botversion( ).
      lv_locale = lo_row_1->get_v1botlocale( ).
      lv_v2botid = lo_row_1->get_v2botid( ).
      lv_iamrolearn = lo_row_1->get_v2botrole( ).
      lv_migrationstatus = lo_row_1->get_migrationstatus( ).
      lv_migrationstrategy = lo_row_1->get_migrationstrategy( ).
      lv_timestamp = lo_row_1->get_migrationtimestamp( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.