Skip to content

/AWS1/IF_CWL=>DESCRIBEIMPORTTASKBATCHES()

About DescribeImportTaskBatches

Gets detailed information about the individual batches within an import task, including their status and any error messages. For CloudTrail Event Data Store sources, a batch refers to a subset of stored events grouped by their eventTime.

Method Signature

METHODS /AWS1/IF_CWL~DESCRIBEIMPORTTASKBATCHES
  IMPORTING
    !IV_IMPORTID TYPE /AWS1/CWLIMPORTID OPTIONAL
    !IT_BATCHIMPORTSTATUS TYPE /AWS1/CL_CWLIMPORTSTATUSLIST_W=>TT_IMPORTSTATUSLIST OPTIONAL
    !IV_LIMIT TYPE /AWS1/CWLDESCRIBELIMIT OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/CWLNEXTTOKEN OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cwldscimptaskbtcesrsp
  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

Required arguments:

iv_importid TYPE /AWS1/CWLIMPORTID /AWS1/CWLIMPORTID

The ID of the import task to get batch information for.

Optional arguments:

it_batchimportstatus TYPE /AWS1/CL_CWLIMPORTSTATUSLIST_W=>TT_IMPORTSTATUSLIST TT_IMPORTSTATUSLIST

Optional filter to list import batches by their status. Accepts multiple status values: IN_PROGRESS, CANCELLED, COMPLETED and FAILED.

iv_limit TYPE /AWS1/CWLDESCRIBELIMIT /AWS1/CWLDESCRIBELIMIT

The maximum number of import batches to return in the response. Default: 10

iv_nexttoken TYPE /AWS1/CWLNEXTTOKEN /AWS1/CWLNEXTTOKEN

The pagination token for the next set of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_cwldscimptaskbtcesrsp /AWS1/CL_CWLDSCIMPTASKBTCESRSP

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->describeimporttaskbatches(
  it_batchimportstatus = VALUE /aws1/cl_cwlimportstatuslist_w=>tt_importstatuslist(
    ( new /aws1/cl_cwlimportstatuslist_w( |string| ) )
  )
  iv_importid = |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.
  lv_arn = lo_result->get_importsourcearn( ).
  lv_importid = lo_result->get_importid( ).
  LOOP AT lo_result->get_importbatches( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_batchid = lo_row_1->get_batchid( ).
      lv_importstatus = lo_row_1->get_status( ).
      lv_errormessage = lo_row_1->get_errormessage( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.