Skip to content

/AWS1/IF_CWL=>DESCRIBEIMPORTTASKS()

About DescribeImportTasks

Lists and describes import tasks, with optional filtering by import status and source ARN.

Method Signature

METHODS /AWS1/IF_CWL~DESCRIBEIMPORTTASKS
  IMPORTING
    !IV_IMPORTID TYPE /AWS1/CWLIMPORTID OPTIONAL
    !IV_IMPORTSTATUS TYPE /AWS1/CWLIMPORTSTATUS OPTIONAL
    !IV_IMPORTSOURCEARN TYPE /AWS1/CWLARN OPTIONAL
    !IV_LIMIT TYPE /AWS1/CWLDESCRIBELIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CWLNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwldescrimptasksrsp
  RAISING
    /AWS1/CX_CWLACCESSDENIEDEX
    /AWS1/CX_CWLINVALIDOPERATIONEX
    /AWS1/CX_CWLINVALIDPARAMETEREX
    /AWS1/CX_CWLRESOURCENOTFOUNDEX
    /AWS1/CX_CWLTHROTTLINGEX
    /AWS1/CX_CWLCLIENTEXC
    /AWS1/CX_CWLSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_importid TYPE /AWS1/CWLIMPORTID /AWS1/CWLIMPORTID

Optional filter to describe a specific import task by its ID.

iv_importstatus TYPE /AWS1/CWLIMPORTSTATUS /AWS1/CWLIMPORTSTATUS

Optional filter to list imports by their status. Valid values are IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

iv_importsourcearn TYPE /AWS1/CWLARN /AWS1/CWLARN

Optional filter to list imports from a specific source

iv_limit TYPE /AWS1/CWLDESCRIBELIMIT /AWS1/CWLDESCRIBELIMIT

The maximum number of import tasks to return in the response. Default: 50

iv_nexttoken TYPE /AWS1/CWLNEXTTOKEN /AWS1/CWLNEXTTOKEN

The pagination token for the next set of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwldescrimptasksrsp /AWS1/CL_CWLDESCRIMPTASKSRSP

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->describeimporttasks(
  iv_importid = |string|
  iv_importsourcearn = |string|
  iv_importstatus = |string|
  iv_limit = 123
  iv_nexttoken = |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_imports( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_importid = lo_row_1->get_importid( ).
      lv_arn = lo_row_1->get_importsourcearn( ).
      lv_importstatus = lo_row_1->get_importstatus( ).
      lv_arn = lo_row_1->get_importdestinationarn( ).
      lo_importstatistics = lo_row_1->get_importstatistics( ).
      IF lo_importstatistics IS NOT INITIAL.
        lv_storedbytes = lo_importstatistics->get_bytesimported( ).
      ENDIF.
      lo_importfilter = lo_row_1->get_importfilter( ).
      IF lo_importfilter IS NOT INITIAL.
        lv_timestamp = lo_importfilter->get_starteventtime( ).
        lv_timestamp = lo_importfilter->get_endeventtime( ).
      ENDIF.
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastupdatedtime( ).
      lv_errormessage = lo_row_1->get_errormessage( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.