LISTREFERENCES()`¶

About ListReferences¶

Retrieves the metadata of one or more reference genomes in a reference store.

For more information, see Creating a reference store in the Amazon Web Services HealthOmics User Guide.

Method Signature¶

METHODS /AWS1/IF_OMX~LISTREFERENCES
  IMPORTING
    !IV_REFERENCESTOREID TYPE /AWS1/OMXREFERENCESTOREID OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/OMXINTEGER OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/OMXNEXTTOKEN OPTIONAL
    !IO_FILTER TYPE REF TO /AWS1/CL_OMXREFERENCEFILTER OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_omxlistreferencesrsp
  RAISING
    /AWS1/CX_OMXACCESSDENIEDEX
    /AWS1/CX_OMXINTERNALSERVEREX
    /AWS1/CX_OMXREQUESTTIMEOUTEX
    /AWS1/CX_OMXRESOURCENOTFOUNDEX
    /AWS1/CX_OMXTHROTTLINGEX
    /AWS1/CX_OMXVALIDATIONEX
    /AWS1/CX_OMXCLIENTEXC
    /AWS1/CX_OMXSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING¶

Required arguments:¶

`iv_referencestoreid` `TYPE /AWS1/OMXREFERENCESTOREID` `/AWS1/OMXREFERENCESTOREID`¶

The references' reference store ID.

Optional arguments:¶

`iv_maxresults` `TYPE /AWS1/OMXINTEGER` `/AWS1/OMXINTEGER`¶

The maximum number of references to return in one page of results.

`iv_nexttoken` `TYPE /AWS1/OMXNEXTTOKEN` `/AWS1/OMXNEXTTOKEN`¶

Specify the pagination token from a previous request to retrieve the next page of results.

`io_filter` `TYPE REF TO /AWS1/CL_OMXREFERENCEFILTER` `/AWS1/CL_OMXREFERENCEFILTER`¶

A filter to apply to the list.

RETURNING¶

`oo_output` `TYPE REF TO /aws1/cl_omxlistreferencesrsp` `/AWS1/CL_OMXLISTREFERENCESRSP`¶

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->listreferences(
  io_filter = new /aws1/cl_omxreferencefilter(
    iv_createdafter = '20150101000000.0000000'
    iv_createdbefore = '20150101000000.0000000'
    iv_md5 = |string|
    iv_name = |string|
  )
  iv_maxresults = 123
  iv_nexttoken = |string|
  iv_referencestoreid = |string|
).

This is an example of reading all possible response values

lo_result = lo_result.
IF lo_result IS NOT INITIAL.
  lv_nexttoken = lo_result->get_nexttoken( ).
  LOOP AT lo_result->get_references( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_referenceid = lo_row_1->get_id( ).
      lv_referencearn = lo_row_1->get_arn( ).
      lv_referencestoreid = lo_row_1->get_referencestoreid( ).
      lv_md5 = lo_row_1->get_md5( ).
      lv_referencestatus = lo_row_1->get_status( ).
      lv_referencename = lo_row_1->get_name( ).
      lv_referencedescription = lo_row_1->get_description( ).
      lv_timestamp = lo_row_1->get_creationtime( ).
      lv_timestamp = lo_row_1->get_updatetime( ).
    ENDIF.
  ENDLOOP.
ENDIF.

/AWS1/IF_OMX=>LISTREFERENCES()¶