Class: Aws::SageMaker::Types::QueryLineageRequest

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-sagemaker/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#directionString

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

Returns:

  • (String)


38557
38558
38559
38560
38561
38562
38563
38564
38565
38566
38567
# File 'lib/aws-sdk-sagemaker/types.rb', line 38557

class QueryLineageRequest < Struct.new(
  :start_arns,
  :direction,
  :include_edges,
  :filters,
  :max_depth,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#filtersTypes::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.

Returns:



38557
38558
38559
38560
38561
38562
38563
38564
38565
38566
38567
# File 'lib/aws-sdk-sagemaker/types.rb', line 38557

class QueryLineageRequest < Struct.new(
  :start_arns,
  :direction,
  :include_edges,
  :filters,
  :max_depth,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#include_edgesBoolean

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.

[1]: docs.aws.amazon.com/sagemaker/latest/dg/lineage-tracking-entities.html

Returns:

  • (Boolean)


38557
38558
38559
38560
38561
38562
38563
38564
38565
38566
38567
# File 'lib/aws-sdk-sagemaker/types.rb', line 38557

class QueryLineageRequest < Struct.new(
  :start_arns,
  :direction,
  :include_edges,
  :filters,
  :max_depth,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_depthInteger

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.

Returns:

  • (Integer)


38557
38558
38559
38560
38561
38562
38563
38564
38565
38566
38567
# File 'lib/aws-sdk-sagemaker/types.rb', line 38557

class QueryLineageRequest < Struct.new(
  :start_arns,
  :direction,
  :include_edges,
  :filters,
  :max_depth,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

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

Returns:

  • (Integer)


38557
38558
38559
38560
38561
38562
38563
38564
38565
38566
38567
# File 'lib/aws-sdk-sagemaker/types.rb', line 38557

class QueryLineageRequest < Struct.new(
  :start_arns,
  :direction,
  :include_edges,
  :filters,
  :max_depth,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

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

Returns:

  • (String)


38557
38558
38559
38560
38561
38562
38563
38564
38565
38566
38567
# File 'lib/aws-sdk-sagemaker/types.rb', line 38557

class QueryLineageRequest < Struct.new(
  :start_arns,
  :direction,
  :include_edges,
  :filters,
  :max_depth,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end

#start_arnsArray<String>

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

Returns:

  • (Array<String>)


38557
38558
38559
38560
38561
38562
38563
38564
38565
38566
38567
# File 'lib/aws-sdk-sagemaker/types.rb', line 38557

class QueryLineageRequest < Struct.new(
  :start_arns,
  :direction,
  :include_edges,
  :filters,
  :max_depth,
  :max_results,
  :next_token)
  SENSITIVE = []
  include Aws::Structure
end