Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-143021,9861.6 MB

Use this action to inspect your lineage and discover relationships between entities. For more information, see <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/querying-lineage-entities.html"> Querying Lineage Entities</a> in the <i>Amazon SageMaker Developer Guide</i>.

post/#X-Amz-Target=SageMaker.QueryLineage

Query parameters

MaxResultsstring

Pagination limit

NextTokenstring

Pagination token

Headers

X-Amz-Target'SageMaker.QueryLineage' required

Request body

StartArnsAssociationEntityArn[]

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

Direction'Both' | 'Ascendants' | 'Descendants'

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

IncludeEdgesboolean

Setting this value to <code>True</code> retrieves not only the entities of interest but also the <a href="https://docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html">Associations</a> and lineage entities on the path. Set to <code>False</code> to only return lineage entities that match your query.

MaxDepthinteger

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

MaxResultsinteger

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

NextTokenstring

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

Response

Success

NextTokenstring

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