/AWS1/CL_PPT=>GETSEGMENTIMPORTJOBS()

About GetSegmentImportJobs

Retrieves information about the status and settings of the import jobs for a segment.

Method Signature

IMPORTING

Required arguments:

iv_applicationid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.

iv_segmentid TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The unique identifier for the segment.

Optional arguments:

iv_pagesize TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.

iv_token TYPE /AWS1/PPT__STRING /AWS1/PPT__STRING

The NextToken string that specifies which page of results to return in a paginated response.

RETURNING

oo_output TYPE REF TO /aws1/cl_pptgetsegmentimpjob01 /AWS1/CL_PPTGETSEGMENTIMPJOB01

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->/aws1/if_ppt~getsegmentimportjobs(
  iv_applicationid = |string|
  iv_pagesize = |string|
  iv_segmentid = |string|
  iv_token = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_importjobsresponse = lo_result->get_importjobsresponse( ).
  IF lo_importjobsresponse IS NOT INITIAL.
    LOOP AT lo_importjobsresponse->get_item( ) into lo_row.
      lo_row_1 = lo_row.
      IF lo_row_1 IS NOT INITIAL.
        lv___string = lo_row_1->get_applicationid( ).
        lv___integer = lo_row_1->get_completedpieces( ).
        lv___string = lo_row_1->get_completiondate( ).
        lv___string = lo_row_1->get_creationdate( ).
        lo_importjobresource = lo_row_1->get_definition( ).
        IF lo_importjobresource IS NOT INITIAL.
          lv___boolean = lo_importjobresource->get_definesegment( ).
          lv___string = lo_importjobresource->get_externalid( ).
          lv_format = lo_importjobresource->get_format( ).
          lv___boolean = lo_importjobresource->get_registerendpoints( ).
          lv___string = lo_importjobresource->get_rolearn( ).
          lv___string = lo_importjobresource->get_s3url( ).
          lv___string = lo_importjobresource->get_segmentid( ).
          lv___string = lo_importjobresource->get_segmentname( ).
        ENDIF.
        lv___integer = lo_row_1->get_failedpieces( ).
        LOOP AT lo_row_1->get_failures( ) into lo_row_2.
          lo_row_3 = lo_row_2.
          IF lo_row_3 IS NOT INITIAL.
            lv___string = lo_row_3->get_value( ).
          ENDIF.
        ENDLOOP.
        lv___string = lo_row_1->get_id( ).
        lv_jobstatus = lo_row_1->get_jobstatus( ).
        lv___integer = lo_row_1->get_totalfailures( ).
        lv___integer = lo_row_1->get_totalpieces( ).
        lv___integer = lo_row_1->get_totalprocessed( ).
        lv___string = lo_row_1->get_type( ).
      ENDIF.
    ENDLOOP.
    lv___string = lo_importjobsresponse->get_nexttoken( ).
  ENDIF.
ENDIF.