Amazonka.SageMaker.QueryLineage

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.

Creating a Request

data QueryLineage

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

ToJSON QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

toJSON :: QueryLineage -> Value

toEncoding :: QueryLineage -> Encoding

toJSONList :: [QueryLineage] -> Value

toEncodingList :: [QueryLineage] -> Encoding

ToHeaders QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

toHeaders :: QueryLineage -> [Header]

ToPath QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

toPath :: QueryLineage -> ByteString

ToQuery QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

toQuery :: QueryLineage -> QueryString

AWSRequest QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Associated Types

type AWSResponse QueryLineage

Methods

request :: (Service -> Service) -> QueryLineage -> Request QueryLineage

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy QueryLineage -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse QueryLineage)))

Generic QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Associated Types

type Rep QueryLineage :: Type -> Type

Methods

from :: QueryLineage -> Rep QueryLineage x

to :: Rep QueryLineage x -> QueryLineage

Read QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

readsPrec :: Int -> ReadS QueryLineage

readList :: ReadS [QueryLineage]

readPrec :: ReadPrec QueryLineage

readListPrec :: ReadPrec [QueryLineage]

Show QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

showsPrec :: Int -> QueryLineage -> ShowS

show :: QueryLineage -> String

showList :: [QueryLineage] -> ShowS

NFData QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

rnf :: QueryLineage -> ()

Eq QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

(==) :: QueryLineage -> QueryLineage -> Bool

(/=) :: QueryLineage -> QueryLineage -> Bool

Hashable QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

Methods

hashWithSalt :: Int -> QueryLineage -> Int

hash :: QueryLineage -> Int

type AWSResponse QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

type AWSResponse QueryLineage = QueryLineageResponse

type Rep QueryLineage

Defined in Amazonka.SageMaker.QueryLineage

type Rep QueryLineage = D1 ('MetaData "QueryLineage" "Amazonka.SageMaker.QueryLineage" "amazonka-sagemaker-2.0-9SyrKZ4KqhsL1qX9u3ILA3" 'False) (C1 ('MetaCons "QueryLineage'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "direction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Direction)) :*: (S1 ('MetaSel ('Just "filters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe QueryFilters)) :*: S1 ('MetaSel ('Just "includeEdges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :*: ((S1 ('MetaSel ('Just "maxDepth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "startArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))))))

newQueryLineage :: QueryLineage

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)

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)

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)

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)

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)

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)

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])

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

Destructuring the Response

data QueryLineageResponse

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

Generic QueryLineageResponse

Defined in Amazonka.SageMaker.QueryLineage

Associated Types

type Rep QueryLineageResponse :: Type -> Type

Methods

from :: QueryLineageResponse -> Rep QueryLineageResponse x

to :: Rep QueryLineageResponse x -> QueryLineageResponse

Read QueryLineageResponse

Defined in Amazonka.SageMaker.QueryLineage

Methods

readsPrec :: Int -> ReadS QueryLineageResponse

readList :: ReadS [QueryLineageResponse]

readPrec :: ReadPrec QueryLineageResponse

readListPrec :: ReadPrec [QueryLineageResponse]

Show QueryLineageResponse

Defined in Amazonka.SageMaker.QueryLineage

Methods

showsPrec :: Int -> QueryLineageResponse -> ShowS

show :: QueryLineageResponse -> String

showList :: [QueryLineageResponse] -> ShowS

NFData QueryLineageResponse

Defined in Amazonka.SageMaker.QueryLineage

Methods

rnf :: QueryLineageResponse -> ()

Eq QueryLineageResponse

Defined in Amazonka.SageMaker.QueryLineage

Methods

(==) :: QueryLineageResponse -> QueryLineageResponse -> Bool

(/=) :: QueryLineageResponse -> QueryLineageResponse -> Bool

type Rep QueryLineageResponse

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

Arguments

:: Int

$sel:httpStatus:QueryLineageResponse'

-> QueryLineageResponse

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])

A list of edges that connect vertices in the response.

queryLineageResponse_nextToken :: Lens' QueryLineageResponse (Maybe Text)

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])

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

queryLineageResponse_httpStatus :: Lens' QueryLineageResponse Int

The response's http status code.