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

Inherits:

Struct

• Object
• Struct
• Aws::SageMaker::Types::QueryLineageRequest

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-sagemaker/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #direction ⇒ String

  Associations between lineage entities have a direction.

• #filters ⇒ Types::QueryFilters

  A set of filtering parameters that allow you to specify which entities should be returned.

• #include_edges ⇒ Boolean

  Setting this value to ‘True` retrieves not only the entities of interest but also the [Associations] and lineage entities on the path.

• #max_depth ⇒ Integer

  The maximum depth in lineage relationships from the ‘StartArns` that are traversed.

• #max_results ⇒ Integer

  Limits the number of vertices in the results.

• #next_token ⇒ String

  Limits the number of vertices in the request.

• #start_arns ⇒ Array<String>

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

Instance Attribute Details

#direction ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 38466

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

#filters ⇒ Types::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:

• (Types::QueryFilters)

# File 'lib/aws-sdk-sagemaker/types.rb', line 38466

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

#include_edges ⇒ 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.

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

Returns:

• (Boolean)

# File 'lib/aws-sdk-sagemaker/types.rb', line 38466

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

#max_depth ⇒ Integer

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)

# File 'lib/aws-sdk-sagemaker/types.rb', line 38466

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

#max_results ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-sagemaker/types.rb', line 38466

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

#next_token ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-sagemaker/types.rb', line 38466

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

#start_arns ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-sagemaker/types.rb', line 38466

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