Skip to content

/AWS1/IF_SGM=>QUERYLINEAGE()

About QueryLineage

Use this action to inspect your lineage and discover relationships between entities. For more information, see Querying Lineage Entities in the Amazon SageMaker Developer Guide.

Method Signature

METHODS /AWS1/IF_SGM~QUERYLINEAGE
  IMPORTING
    !IT_STARTARNS TYPE /AWS1/CL_SGMQUERYLINEAGESTRT00=>TT_QUERYLINEAGESTARTARNS OPTIONAL
    !IV_DIRECTION TYPE /AWS1/SGMDIRECTION OPTIONAL
    !IV_INCLUDEEDGES TYPE /AWS1/SGMBOOLEAN OPTIONAL
    !IO_FILTERS TYPE REF TO /AWS1/CL_SGMQUERYFILTERS OPTIONAL
    !IV_MAXDEPTH TYPE /AWS1/SGMQUERYLINEAGEMAXDEPTH OPTIONAL
    !IV_MAXRESULTS TYPE /AWS1/SGMQUERYLINEAGEMAXRSLTS OPTIONAL
    !IV_NEXTTOKEN TYPE /AWS1/SGMSTRING8192 OPTIONAL
  RETURNING
    VALUE(OO_OUTPUT) TYPE REF TO /aws1/cl_sgmquerylineagersp
  RAISING
    /AWS1/CX_SGMRESOURCENOTFOUND
    /AWS1/CX_SGMCLIENTEXC
    /AWS1/CX_SGMSERVEREXC
    /AWS1/CX_RT_TECHNICAL_GENERIC
    /AWS1/CX_RT_SERVICE_GENERIC.

IMPORTING

Optional arguments:

it_startarns TYPE /AWS1/CL_SGMQUERYLINEAGESTRT00=>TT_QUERYLINEAGESTARTARNS TT_QUERYLINEAGESTARTARNS

A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

iv_direction TYPE /AWS1/SGMDIRECTION /AWS1/SGMDIRECTION

Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

iv_includeedges TYPE /AWS1/SGMBOOLEAN /AWS1/SGMBOOLEAN

Setting this value to True retrieves not only the entities of interest but also the Associations and lineage entities on the path. Set to False to only return lineage entities that match your query.

io_filters TYPE REF TO /AWS1/CL_SGMQUERYFILTERS /AWS1/CL_SGMQUERYFILTERS

A set of filtering parameters that allow you to specify which entities should be returned.

  • Properties - Key-value pairs to match on the lineage entities' properties.

  • LineageTypes - A set of lineage entity types to match on. For example: TrialComponent, Artifact, or Context.

  • CreatedBefore - Filter entities created before this date.

  • ModifiedBefore - Filter entities modified before this date.

  • ModifiedAfter - Filter entities modified after this date.

iv_maxdepth TYPE /AWS1/SGMQUERYLINEAGEMAXDEPTH /AWS1/SGMQUERYLINEAGEMAXDEPTH

The maximum depth in lineage relationships from the StartArns that are traversed. Depth is a measure of the number of Associations from the StartArn entity to the matched results.

iv_maxresults TYPE /AWS1/SGMQUERYLINEAGEMAXRSLTS /AWS1/SGMQUERYLINEAGEMAXRSLTS

Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

iv_nexttoken TYPE /AWS1/SGMSTRING8192 /AWS1/SGMSTRING8192

Limits the number of vertices in the request. Use the NextToken in a response to to retrieve the next page of results.

RETURNING

oo_output TYPE REF TO /aws1/cl_sgmquerylineagersp /AWS1/CL_SGMQUERYLINEAGERSP

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->querylineage(
  io_filters = new /aws1/cl_sgmqueryfilters(
    it_lineagetypes = VALUE /aws1/cl_sgmquerylineagetype00=>tt_querylineagetypes(
      ( new /aws1/cl_sgmquerylineagetype00( |string| ) )
    )
    it_properties = VALUE /aws1/cl_sgmqueryproperties_w=>tt_queryproperties(
      (
        VALUE /aws1/cl_sgmqueryproperties_w=>ts_queryproperties_maprow(
          key = |string|
          value = new /aws1/cl_sgmqueryproperties_w( |string| )
        )
      )
    )
    it_types = VALUE /aws1/cl_sgmquerytypes_w=>tt_querytypes(
      ( new /aws1/cl_sgmquerytypes_w( |string| ) )
    )
    iv_createdafter = '20150101000000.0000000'
    iv_createdbefore = '20150101000000.0000000'
    iv_modifiedafter = '20150101000000.0000000'
    iv_modifiedbefore = '20150101000000.0000000'
  )
  it_startarns = VALUE /aws1/cl_sgmquerylineagestrt00=>tt_querylineagestartarns(
    ( new /aws1/cl_sgmquerylineagestrt00( |string| ) )
  )
  iv_direction = |string|
  iv_includeedges = ABAP_TRUE
  iv_maxdepth = 123
  iv_maxresults = 123
  iv_nexttoken = |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_vertices( ) into lo_row.
    lo_row_1 = lo_row.
    IF lo_row_1 IS NOT INITIAL.
      lv_associationentityarn = lo_row_1->get_arn( ).
      lv_string40 = lo_row_1->get_type( ).
      lv_lineagetype = lo_row_1->get_lineagetype( ).
    ENDIF.
  ENDLOOP.
  LOOP AT lo_result->get_edges( ) into lo_row_2.
    lo_row_3 = lo_row_2.
    IF lo_row_3 IS NOT INITIAL.
      lv_associationentityarn = lo_row_3->get_sourcearn( ).
      lv_associationentityarn = lo_row_3->get_destinationarn( ).
      lv_associationedgetype = lo_row_3->get_associationtype( ).
    ENDIF.
  ENDLOOP.
  lv_string8192 = lo_result->get_nexttoken( ).
ENDIF.