amazonka-sagemaker-2.0: Amazon SageMaker Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SageMaker.QueryLineage

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.

Synopsis

Creating a Request

data QueryLineage Source #

See: newQueryLineage smart constructor.

Constructors

QueryLineage' 

Fields

  • direction :: Maybe Direction

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

  • filters :: Maybe 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.
  • includeEdges :: Maybe Bool

    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.

  • maxDepth :: Maybe Int

    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.

  • maxResults :: Maybe Int

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

  • nextToken :: Maybe Text

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

  • startArns :: Maybe [Text]

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

Instances

Instances details
ToJSON QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

ToHeaders QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

ToPath QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

ToQuery QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

AWSRequest QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Associated Types

type AWSResponse QueryLineage #

Generic QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Associated Types

type Rep QueryLineage :: Type -> Type #

Read QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Show QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

NFData QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Methods

rnf :: QueryLineage -> () #

Eq QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Hashable QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

type AWSResponse QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

type Rep QueryLineage Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

newQueryLineage :: QueryLineage Source #

Create a value of QueryLineage with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:direction:QueryLineage', queryLineage_direction - Associations between lineage entities have a direction. This parameter determines the direction from the StartArn(s) that the query traverses.

QueryLineage, queryLineage_filters - 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.

$sel:includeEdges:QueryLineage', queryLineage_includeEdges - 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.

$sel:maxDepth:QueryLineage', queryLineage_maxDepth - 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.

$sel:maxResults:QueryLineage', queryLineage_maxResults - Limits the number of vertices in the results. Use the NextToken in a response to to retrieve the next page of results.

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

$sel:startArns:QueryLineage', queryLineage_startArns - A list of resource Amazon Resource Name (ARN) that represent the starting point for your lineage query.

Request Lenses

queryLineage_direction :: Lens' QueryLineage (Maybe Direction) Source #

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

queryLineage_filters :: Lens' QueryLineage (Maybe QueryFilters) Source #

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.

queryLineage_includeEdges :: Lens' QueryLineage (Maybe Bool) Source #

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.

queryLineage_maxDepth :: Lens' QueryLineage (Maybe Int) Source #

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.

queryLineage_maxResults :: Lens' QueryLineage (Maybe Int) Source #

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

queryLineage_nextToken :: Lens' QueryLineage (Maybe Text) Source #

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

queryLineage_startArns :: Lens' QueryLineage (Maybe [Text]) Source #

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

Destructuring the Response

data QueryLineageResponse Source #

See: newQueryLineageResponse smart constructor.

Constructors

QueryLineageResponse' 

Fields

  • edges :: Maybe [Edge]

    A list of edges that connect vertices in the response.

  • nextToken :: Maybe Text

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

  • vertices :: Maybe [Vertex]

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

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic QueryLineageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Associated Types

type Rep QueryLineageResponse :: Type -> Type #

Read QueryLineageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Show QueryLineageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

NFData QueryLineageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

Methods

rnf :: QueryLineageResponse -> () #

Eq QueryLineageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

type Rep QueryLineageResponse Source # 
Instance details

Defined in Amazonka.SageMaker.QueryLineage

type Rep QueryLineageResponse = D1 ('MetaData "QueryLineageResponse" "Amazonka.SageMaker.QueryLineage" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "QueryLineageResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "edges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Edge])) :*: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "vertices") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Vertex])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newQueryLineageResponse Source #

Create a value of QueryLineageResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:edges:QueryLineageResponse', queryLineageResponse_edges - A list of edges that connect vertices in the response.

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

$sel:vertices:QueryLineageResponse', queryLineageResponse_vertices - A list of vertices connected to the start entity(ies) in the lineage graph.

$sel:httpStatus:QueryLineageResponse', queryLineageResponse_httpStatus - The response's http status code.

Response Lenses

queryLineageResponse_edges :: Lens' QueryLineageResponse (Maybe [Edge]) Source #

A list of edges that connect vertices in the response.

queryLineageResponse_nextToken :: Lens' QueryLineageResponse (Maybe Text) Source #

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

queryLineageResponse_vertices :: Lens' QueryLineageResponse (Maybe [Vertex]) Source #

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