Skip to content

Query Lineage

sagemaker_query_lineage R Documentation

Use this action to inspect your lineage and discover relationships between entities

Description

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.

Usage

sagemaker_query_lineage(StartArns, Direction, IncludeEdges, Filters,
  MaxDepth, MaxResults, NextToken)

Arguments

StartArns

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

Direction

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

IncludeEdges

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.

Filters

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.

MaxDepth

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.

MaxResults

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

NextToken

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

Value

A list with the following syntax: 

list(
  Vertices = list(
    list(
      Arn = "string",
      Type = "string",
      LineageType = "TrialComponent"|"Artifact"|"Context"|"Action"
    )
  ),
  Edges = list(
    list(
      SourceArn = "string",
      DestinationArn = "string",
      AssociationType = "ContributedTo"|"AssociatedWith"|"DerivedFrom"|"Produced"|"SameAs"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$query_lineage(
  StartArns = list(
    "string"
  ),
  Direction = "Both"|"Ascendants"|"Descendants",
  IncludeEdges = TRUE|FALSE,
  Filters = list(
    Types = list(
      "string"
    ),
    LineageTypes = list(
      "TrialComponent"|"Artifact"|"Context"|"Action"
    ),
    CreatedBefore = as.POSIXct(
      "2015-01-01"
    ),
    CreatedAfter = as.POSIXct(
      "2015-01-01"
    ),
    ModifiedBefore = as.POSIXct(
      "2015-01-01"
    ),
    ModifiedAfter = as.POSIXct(
      "2015-01-01"
    ),
    Properties = list(
      "string"
    )
  ),
  MaxDepth = 123,
  MaxResults = 123,
  NextToken = "string"
)