/AWS1/IF_SGM=>LISTHYPERPARAMETERTUNINGJOBS()

About ListHyperParameterTuningJobs

Gets a list of HyperParameterTuningJobSummary objects that describe the hyperparameter tuning jobs launched in your account.

Method Signature

METHODS /AWS1/IF_SGM~LISTHYPERPARAMETERTUNINGJOBS
  IMPORTING
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMHYPPRMTUNJOBSORTBYO00 OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMSORTORDER OPTIONAL
    !IV_NAMECONTAINS TYPE /AWS1/SGMNAMECONTAINS OPTIONAL
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_LASTMODIFIEDTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_STATUSEQUALS TYPE /AWS1/SGMHYPERPARAMTUNJOBSTAT OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlsthypprmtunjobs01
  RAISING
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the result of the previous ListHyperParameterTuningJobs request was truncated, the response includes a NextToken. To retrieve the next set of tuning jobs, use the token in the next request.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of tuning jobs to return. The default value is 10.

iv_sortby TYPE /AWS1/SGMHYPPRMTUNJOBSORTBYO00 /AWS1/SGMHYPPRMTUNJOBSORTBYO00

The field to sort results by. The default is Name.

iv_sortorder TYPE /AWS1/SGMSORTORDER /AWS1/SGMSORTORDER

The sort order for results. The default is Ascending.

iv_namecontains TYPE /AWS1/SGMNAMECONTAINS /AWS1/SGMNAMECONTAINS

A string in the tuning job name. This filter returns only tuning jobs whose name contains the specified string.

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only tuning jobs that were created after the specified time.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only tuning jobs that were created before the specified time.

iv_lastmodifiedtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only tuning jobs that were modified after the specified time.

iv_lastmodifiedtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

A filter that returns only tuning jobs that were modified before the specified time.

iv_statusequals TYPE /AWS1/SGMHYPERPARAMTUNJOBSTAT /AWS1/SGMHYPERPARAMTUNJOBSTAT

A filter that returns only tuning jobs with the specified status.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlsthypprmtunjobs01 /AWS1/CL_SGMLSTHYPPRMTUNJOBS01

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->listhyperparametertuningjobs(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_lastmodifiedtimeafter = '20150101000000.0000000'
  iv_lastmodifiedtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_namecontains = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |string|
  iv_statusequals = |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_hyperparamtuningjobsums( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_hyperparametertuningjob = lo_row_1->get_hyperparamtuningjobname( ).
      lv_hyperparametertuningjob_1 = lo_row_1->get_hyperparamtuningjobarn( ).
      lv_hyperparametertuningjob_2 = lo_row_1->get_hyperparamtunjobstatus( ).
      lv_hyperparametertuningjob_3 = lo_row_1->get_strategy( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_hyperparamtuningendtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
      lo_trainingjobstatuscounte = lo_row_1->get_trnjobstatuscounters( ).
      IF lo_trainingjobstatuscounte IS NOT INITIAL.
        lv_trainingjobstatuscounte_1 = lo_trainingjobstatuscounte->get_completed( ).
        lv_trainingjobstatuscounte_1 = lo_trainingjobstatuscounte->get_inprogress( ).
        lv_trainingjobstatuscounte_1 = lo_trainingjobstatuscounte->get_retryableerror( ).
        lv_trainingjobstatuscounte_1 = lo_trainingjobstatuscounte->get_nonretryableerror( ).
        lv_trainingjobstatuscounte_1 = lo_trainingjobstatuscounte->get_stopped( ).
      ENDIF.
      lo_objectivestatuscounters = lo_row_1->get_objectivestatuscounters( ).
      IF lo_objectivestatuscounters IS NOT INITIAL.
        lv_objectivestatuscounter = lo_objectivestatuscounters->get_succeeded( ).
        lv_objectivestatuscounter = lo_objectivestatuscounters->get_pending( ).
        lv_objectivestatuscounter = lo_objectivestatuscounters->get_failed( ).
      ENDIF.
      lo_resourcelimits = lo_row_1->get_resourcelimits( ).
      IF lo_resourcelimits IS NOT INITIAL.
        lv_maxnumberoftrainingjobs = lo_resourcelimits->get_maxnumberoftrainingjobs( ).
        lv_maxparalleltrainingjobs = lo_resourcelimits->get_maxparalleltrainingjobs( ).
        lv_hyperparametertuningmax = lo_resourcelimits->get_maxruntimeinseconds( ).
      ENDIF.
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.