DESCRIBEMIGRATIONPROJECTS()`¶

About DescribeMigrationProjects¶

Returns a paginated list of migration projects for your account in the current region.

Required permissions: dms:ListMigrationProjects. For more information, see Actions, resources, and condition keys for Database Migration Service.

Method Signature¶

METHODS /AWS1/IF_DMG~DESCRIBEMIGRATIONPROJECTS
  IMPORTING
    !IT_FILTERS TYPE /AWS1/CL_DMGFILTER=>TT_FILTERLIST OPTIONAL
    !IV_MAXRECORDS TYPE /AWS1/DMGINTEGEROPTIONAL OPTIONAL
    !IV_MARKER TYPE /AWS1/DMGSTRING OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_dmgdscmigrationproj01
  RAISING
    /AWS1/CX_DMGACCESSDENIEDFAULT
    /AWS1/CX_DMGFAILEDDEPENDENCY00
    /AWS1/CX_DMGRESRCNOTFOUNDFAULT
    /AWS1/CX_DMGCLIENTEXC
    /AWS1/CX_DMGSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Optional arguments:¶

`it_filters` `TYPE /AWS1/CL_DMGFILTER=>TT_FILTERLIST` `TT_FILTERLIST`¶

The filters to apply to the migration projects.

The following filter names are supported:

migration-project-identifier – The migration project name or ARN.

instance-profile-identifier – The instance profile name or ARN.

data-provider-identifier – The source or target data provider name or ARN.

source-data-provider-identifier – The source data provider name or ARN.

target-data-provider-identifier – The target data provider name or ARN.

`iv_maxrecords` `TYPE /AWS1/DMGINTEGEROPTIONAL` `/AWS1/DMGINTEGEROPTIONAL`¶

The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, DMS includes a pagination token
in the response so that you can retrieve the remaining results.

`iv_marker` `TYPE /AWS1/DMGSTRING` `/AWS1/DMGSTRING`¶

Specifies the unique pagination token that makes it possible to display the next page of results. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

If Marker is returned by a previous response, there are more results available. The value of Marker is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token and keeping all other arguments unchanged.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_dmgdscmigrationproj01` `/AWS1/CL_DMGDSCMIGRATIONPROJ01`¶

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->describemigrationprojects(
  it_filters = VALUE /aws1/cl_dmgfilter=>tt_filterlist(
    (
      new /aws1/cl_dmgfilter(
        it_values = VALUE /aws1/cl_dmgfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_dmgfiltervaluelist_w( |string| ) )
        )
        iv_name = |string|
      )
    )
  )
  iv_marker = |string|
  iv_maxrecords = 123
).

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_marker( ).
  LOOP AT lo_result->get_migrationprojects( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_string = lo_row_1->get_migrationprojectname( ).
      lv_string = lo_row_1->get_migrationprojectarn( ).
      lv_iso8601datetime = lo_row_1->get_migrationprojectcreati00( ).
      LOOP AT lo_row_1->get_srcdatapvdrdescriptors( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_secretsmanagersecretid( ).
          lv_string = lo_row_3->get_secretsmanageraccrolearn( ).
          lv_string = lo_row_3->get_dataprovidername( ).
          lv_string = lo_row_3->get_dataproviderarn( ).
        ENDIF.
      ENDLOOP.
      LOOP AT lo_row_1->get_tgtdatapvdrdescriptors( ) into lo_row_2.
        lo_row_3 = lo_row_2.
        IF lo_row_3 IS NOT INITIAL.
          lv_string = lo_row_3->get_secretsmanagersecretid( ).
          lv_string = lo_row_3->get_secretsmanageraccrolearn( ).
          lv_string = lo_row_3->get_dataprovidername( ).
          lv_string = lo_row_3->get_dataproviderarn( ).
        ENDIF.
      ENDLOOP.
      lv_string = lo_row_1->get_instanceprofilearn( ).
      lv_string = lo_row_1->get_instanceprofilename( ).
      lv_string = lo_row_1->get_transformationrules( ).
      lv_string = lo_row_1->get_description( ).
      lo_scapplicationattributes = lo_row_1->get_schconvrsapplicationat00( ).
      IF lo_scapplicationattributes IS NOT INITIAL.
        lv_string = lo_scapplicationattributes->get_s3bucketpath( ).
        lv_string = lo_scapplicationattributes->get_s3bucketrolearn( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
ENDIF.

Describe migration projects with a filter¶

The following example retrieves the details of a migration project identified by its ARN.

DATA(lo_result) = lo_client->describemigrationprojects(
  it_filters = VALUE /aws1/cl_dmgfilter=>tt_filterlist(
    (
      new /aws1/cl_dmgfilter(
        it_values = VALUE /aws1/cl_dmgfiltervaluelist_w=>tt_filtervaluelist(
          ( new /aws1/cl_dmgfiltervaluelist_w( |arn:aws:dms:us-east-1:111122223333:migration-project:EXAMPLEABCDEFGHIJKLMNOPQRS| ) )
        )
        iv_name = |migration-project-identifier|
      )
    )
  )
).

/AWS1/IF_DMG=>DESCRIBEMIGRATIONPROJECTS()¶