Skip to content

aws.sagemaker.query_lineage

Example SQL Queries

SELECT * FROM
aws.sagemaker.query_lineage;

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.

Table Definition

Column NameColumn Data Type
direction Input Column

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

VARCHAR
filters Input Column

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.

STRUCT(
"types" VARCHAR[],
"lineage_types" VARCHAR[],
"created_before" TIMESTAMP_S,
"created_after" TIMESTAMP_S,
"modified_before" TIMESTAMP_S,
"modified_after" TIMESTAMP_S,
"properties" MAP(VARCHAR, VARCHAR)
)
Show child fields
filters.created_after

Filter the lineage entities connected to the StartArn(s) after the create date.

filters.created_before

Filter the lineage entities connected to the StartArn(s) by created date.

filters.lineage_types[]
filters.modified_after

Filter the lineage entities connected to the StartArn(s) after the last modified date.

filters.modified_before

Filter the lineage entities connected to the StartArn(s) before the last modified date.

filters.properties

Filter the lineage entities connected to the StartArn(s) by a set if property key value pairs. If multiple pairs are provided, an entity is included in the results if it matches any of the provided pairs.

filters.types[]
include_edges Input Column

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.

BOOLEAN
max_depth Input Column

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.

BIGINT
max_results Input Column

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

BIGINT
next_token Input Column

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

VARCHAR
start_arns Input Column

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

VARCHAR[]
Show child fields
start_arns[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

edges

A list of edges that connect vertices in the response.

STRUCT(
"source_arn" VARCHAR,
"destination_arn" VARCHAR,
"association_type" VARCHAR
)[]
Show child fields
edges[]
Show child fields
edges[].association_type

The type of the Association(Edge) between the source and destination. For example ContributedTo, Produced, or DerivedFrom.

edges[].destination_arn

The Amazon Resource Name (ARN) of the destination lineage entity of the directed edge.

edges[].source_arn

The Amazon Resource Name (ARN) of the source lineage entity of the directed edge.

vertices

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

STRUCT(
"arn" VARCHAR,
"type" VARCHAR,
"lineage_type" VARCHAR
)[]
Show child fields
vertices[]
Show child fields
vertices[].arn

The Amazon Resource Name (ARN) of the lineage entity resource.

vertices[].lineage_type

The type of resource of the lineage entity.

vertices[].type

The type of the lineage entity resource. For example: DataSet, Model, Endpoint, etc...