Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

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.

Request Syntax


{
   "Direction": "string",
   "Filters": { 
      "CreatedAfter": number,
      "CreatedBefore": number,
      "LineageTypes": [ "string" ],
      "ModifiedAfter": number,
      "ModifiedBefore": number,
      "Properties": { 
         "string" : "string" 
      },
      "Types": [ "string" ]
   },
   "IncludeEdges": boolean,
   "MaxDepth": number,
   "MaxResults": number,
   "NextToken": "string",
   "StartArns": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

Direction

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

Type: String

Valid Values: Both | Ascendants | Descendants

Required: No

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.

Type: QueryFilters object

Required: No

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.

Type: Boolean

Required: No

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.

Type: Integer

Valid Range: Maximum value of 10.

Required: No

MaxResults

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

Type: Integer

Valid Range: Maximum value of 50.

Required: No

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Required: No

StartArns

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

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 1 item.

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:(experiment|experiment-trial-component|artifact|action|context)/.*

Required: No

Response Syntax


{
   "Edges": [ 
      { 
         "AssociationType": "string",
         "DestinationArn": "string",
         "SourceArn": "string"
      }
   ],
   "NextToken": "string",
   "Vertices": [ 
      { 
         "Arn": "string",
         "LineageType": "string",
         "Type": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

Edges

A list of edges that connect vertices in the response.

Type: Array of Edge objects

NextToken

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

Type: String

Length Constraints: Maximum length of 8192.

Vertices

A list of vertices connected to the start entity(ies) in the lineage graph.

Type: Array of Vertex objects

Errors

For information about the errors that are common to all actions, see Common Errors.

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400