Skip to content

QueryLineageRequest

Source code in docs_src/capo_sagemaker/types/query_lineage_request.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
class QueryLineageRequest(TypedDict, closed=True):
    start_arns: NotRequired[
        "capo_sagemaker.types.query_lineage_start_arns.QueryLineageStartArns"
    ]
    """<p>A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.</p>"""
    direction: NotRequired["capo_sagemaker.types.direction.Direction"]
    """<p>Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.</p>"""
    include_edges: NotRequired["capo_sagemaker.types.boolean.Boolean"]
    """<p> 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.</p>"""
    filters: NotRequired["capo_sagemaker.types.query_filters.QueryFilters"]
    """<p>A set of filtering parameters that allow you to specify which entities should be returned.</p> <ul> <li> <p>Properties - Key-value pairs to match on the lineage entities' properties.</p> </li> <li> <p>LineageTypes - A set of lineage entity types to match on. For example: <code>TrialComponent</code>, <code>Artifact</code>, or <code>Context</code>.</p> </li> <li> <p>CreatedBefore - Filter entities created before this date.</p> </li> <li> <p>ModifiedBefore - Filter entities modified before this date.</p> </li> <li> <p>ModifiedAfter - Filter entities modified after this date.</p> </li> </ul>"""
    max_depth: NotRequired[
        "capo_sagemaker.types.query_lineage_max_depth.QueryLineageMaxDepth"
    ]
    """<p>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.</p>"""
    max_results: NotRequired[
        "capo_sagemaker.types.query_lineage_max_results.QueryLineageMaxResults"
    ]
    """<p>Limits the number of vertices in the results. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>"""
    next_token: NotRequired["capo_sagemaker.types.string8192.String8192"]
    """<p>Limits the number of vertices in the request. Use the <code>NextToken</code> in a response to to retrieve the next page of results.</p>"""

direction instance-attribute 

direction: NotRequired[Direction]

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

filters instance-attribute 

filters: NotRequired[QueryFilters]

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.

include_edges instance-attribute 

include_edges: NotRequired[Boolean]

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.

max_depth instance-attribute 

max_depth: NotRequired[QueryLineageMaxDepth]

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.

max_results instance-attribute 

max_results: NotRequired[QueryLineageMaxResults]

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

next_token instance-attribute 

next_token: NotRequired[String8192]

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

start_arns instance-attribute 

start_arns: NotRequired[QueryLineageStartArns]

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