Skip to content

/AWS1/IF_SGM=>LISTMODELCARDVERSIONS()

About ListModelCardVersions

List existing versions of an Amazon SageMaker Model Card.

Method Signature

METHODS /AWS1/IF_SGM~LISTMODELCARDVERSIONS
  IMPORTING
    !IV_CREATIONTIMEAFTER TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_CREATIONTIMEBEFORE TYPE /AWS1/SGMTIMESTAMP OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMMAXRESULTS OPTIONAL
    !IV_MODELCARDNAME TYPE /AWS1/SGMMODELCARDNAMEORARN OPTIONAL
    !IV_MODELCARDSTATUS TYPE /AWS1/SGMMODELCARDSTATUS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMNEXTTOKEN OPTIONAL
    !IV_SORTBY TYPE /AWS1/SGMMODELCARDVRSSORTBY OPTIONAL
    !IV_SORTORDER TYPE /AWS1/SGMMODELCARDSORTORDER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmlstmdelcardvrssrsp
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Required arguments:

iv_modelcardname TYPE /AWS1/SGMMODELCARDNAMEORARN /AWS1/SGMMODELCARDNAMEORARN

List model card versions for the model card with the specified name or Amazon Resource Name (ARN).

Optional arguments:

iv_creationtimeafter TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Only list model card versions that were created after the time specified.

iv_creationtimebefore TYPE /AWS1/SGMTIMESTAMP /AWS1/SGMTIMESTAMP

Only list model card versions that were created before the time specified.

iv_maxresults TYPE /AWS1/SGMMAXRESULTS /AWS1/SGMMAXRESULTS

The maximum number of model card versions to list.

iv_modelcardstatus TYPE /AWS1/SGMMODELCARDSTATUS /AWS1/SGMMODELCARDSTATUS

Only list model card versions with the specified approval status.

iv_nexttoken TYPE /AWS1/SGMNEXTTOKEN /AWS1/SGMNEXTTOKEN

If the response to a previous ListModelCardVersions request was truncated, the response includes a NextToken. To retrieve the next set of model card versions, use the token in the next request.

iv_sortby TYPE /AWS1/SGMMODELCARDVRSSORTBY /AWS1/SGMMODELCARDVRSSORTBY

Sort listed model card versions by version. Sorts by version by default.

iv_sortorder TYPE /AWS1/SGMMODELCARDSORTORDER /AWS1/SGMMODELCARDSORTORDER

Sort model card versions by ascending or descending order.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmlstmdelcardvrssrsp /AWS1/CL_SGMLSTMDELCARDVRSSRSP

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->listmodelcardversions(
  iv_creationtimeafter = '20150101000000.0000000'
  iv_creationtimebefore = '20150101000000.0000000'
  iv_maxresults = 123
  iv_modelcardname = |string|
  iv_modelcardstatus = |string|
  iv_nexttoken = |string|
  iv_sortby = |string|
  iv_sortorder = |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_modelcardvrssummarylist( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_entityname = lo_row_1->get_modelcardname( ).
      lv_modelcardarn = lo_row_1->get_modelcardarn( ).
      lv_modelcardstatus = lo_row_1->get_modelcardstatus( ).
      lv_integer = lo_row_1->get_modelcardversion( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_lastmodifiedtime( ).
    ENDIF.
  ENDLOOP.
  lv_nexttoken = lo_result->get_nexttoken( ).
ENDIF.