/AWS1/IF_CGP=>STOPUSERIMPORTJOB()

About StopUserImportJob

Instructs your user pool to stop a running job that's importing users from a CSV file that contains their usernames and attributes. For more information about importing users from a CSV file, see Importing users from a CSV file.

Method Signature

METHODS /AWS1/IF_CGP~STOPUSERIMPORTJOB
  IMPORTING
    !IV_USERPOOLID TYPE /AWS1/CGPUSERPOOLIDTYPE OPTIONAL
    !IV_JOBID TYPE /AWS1/CGPUSERIMPORTJOBIDTYPE OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_cgpstopuserimpjobrsp
  RAISING
    /AWS1/CX_CGPINTERNALERROREX
    /AWS1/CX_CGPINVALIDPARAMETEREX
    /AWS1/CX_CGPNOTAUTHORIZEDEX
    /AWS1/CX_CGPPRECONDNOTMETEX
    /AWS1/CX_CGPRESOURCENOTFOUNDEX
    /AWS1/CX_CGPTOOMANYREQUESTSEX
    /AWS1/CX_CGPCLIENTEXC
    /AWS1/CX_CGPSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_userpoolid TYPE /AWS1/CGPUSERPOOLIDTYPE /AWS1/CGPUSERPOOLIDTYPE

The ID of the user pool that you want to stop.

iv_jobid TYPE /AWS1/CGPUSERIMPORTJOBIDTYPE /AWS1/CGPUSERIMPORTJOBIDTYPE

The ID of a running user import job.

RETURNING

oo_output TYPE REF TO /aws1/cl_cgpstopuserimpjobrsp /AWS1/CL_CGPSTOPUSERIMPJOBRSP

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->stopuserimportjob(
  iv_jobid = |string|
  iv_userpoolid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lo_userimportjobtype = lo_result->get_userimportjob( ).
  IF lo_userimportjobtype IS NOT INITIAL.
    lv_userimportjobnametype = lo_userimportjobtype->get_jobname( ).
    lv_userimportjobidtype = lo_userimportjobtype->get_jobid( ).
    lv_userpoolidtype = lo_userimportjobtype->get_userpoolid( ).
    lv_presignedurltype = lo_userimportjobtype->get_presignedurl( ).
    lv_datetype = lo_userimportjobtype->get_creationdate( ).
    lv_datetype = lo_userimportjobtype->get_startdate( ).
    lv_datetype = lo_userimportjobtype->get_completiondate( ).
    lv_userimportjobstatustype = lo_userimportjobtype->get_status( ).
    lv_arntype = lo_userimportjobtype->get_cloudwatchlogsrolearn( ).
    lv_longtype = lo_userimportjobtype->get_importedusers( ).
    lv_longtype = lo_userimportjobtype->get_skippedusers( ).
    lv_longtype = lo_userimportjobtype->get_failedusers( ).
    lv_completionmessagetype = lo_userimportjobtype->get_completionmessage( ).
  ENDIF.
ENDIF.