Skip to content

list_lineage_node_history async

list_lineage_node_history(
    domain_identifier: DomainId,
    identifier: LineageNodeIdentifier,
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[PaginationToken] = None,
    direction: Optional[EdgeDirection] = None,
    event_timestamp_gte: Optional[datetime] = None,
    event_timestamp_lte: Optional[datetime] = None,
    sort_order: Optional[SortOrder] = None,
) -> ListLineageNodeHistoryOutput

Lists the history of the specified data lineage node.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the domain where you want to list the history of the specified data lineage node.

  • max_results (Optional[MaxResults], default: None ) –

    The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.

  • next_token (Optional[PaginationToken], default: None ) –

    When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.

  • identifier (LineageNodeIdentifier) –

    The ID of the data lineage node whose history you want to list.

  • direction (Optional[EdgeDirection], default: None ) –

    The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is UPSTREAM, the ListLineageNodeHistory API responds with historical versions with upstream neighbors only.

  • event_timestamp_gte (Optional[datetime], default: None ) –

    Specifies whether the action is to return data lineage node history from the time after the event timestamp.

  • event_timestamp_lte (Optional[datetime], default: None ) –

    Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.

  • sort_order (Optional[SortOrder], default: None ) –

    The order by which you want data lineage node history to be sorted.

Raises:

Source code in docs_src/capo_datazone/_services/async_data_zone.py
async def list_lineage_node_history(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    identifier: "capo_datazone.types.lineage_node_identifier.LineageNodeIdentifier",
    *,
    config_overrides: Optional[AsyncDataZoneClientConfig] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
    direction: Optional["capo_datazone.types.edge_direction.EdgeDirection"] = None,
    event_timestamp_gte: Optional[datetime.datetime] = None,
    event_timestamp_lte: Optional[datetime.datetime] = None,
    sort_order: Optional["capo_datazone.types.sort_order.SortOrder"] = None,
) -> "capo_datazone.types.list_lineage_node_history_output.ListLineageNodeHistoryOutput":
    """<p>Lists the history of the specified data lineage node.</p>

    Args:
        domain_identifier: <p>The ID of the domain where you want to list the history of the specified data lineage node.</p>
        max_results: <p>The maximum number of history items to return in a single call to ListLineageNodeHistory. When the number of memberships to be listed is greater than the value of MaxResults, the response contains a NextToken value that you can use in a subsequent call to ListLineageNodeHistory to list the next set of items.</p>
        next_token: <p>When the number of history items is greater than the default value for the MaxResults parameter, or if you explicitly specify a value for MaxResults that is less than the number of items, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageNodeHistory to list the next set of items.</p>
        identifier: <p>The ID of the data lineage node whose history you want to list.</p>
        direction: <p>The direction of the data lineage node refers to the lineage node having neighbors in that direction. For example, if direction is <code>UPSTREAM</code>, the <code>ListLineageNodeHistory</code> API responds with historical versions with upstream neighbors only.</p>
        event_timestamp_gte: <p>Specifies whether the action is to return data lineage node history from the time after the event timestamp.</p>
        event_timestamp_lte: <p>Specifies whether the action is to return data lineage node history from the time prior of the event timestamp.</p>
        sort_order: <p>The order by which you want data lineage node history to be sorted.</p>

    Raises:
        capo_datazone.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_datazone.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_datazone.errors.unauthorized_exception.UnauthorizedException: <p>You do not have permission to perform this action.</p>
        capo_datazone.errors.internal_server_exception.InternalServerException: <p>The request has failed because of an unknown error, exception or failure.</p>
        capo_datazone.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource cannot be found.</p>
        capo_datazone.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by the Amazon Web Services service.</p>
        capo_datazone.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_datazone.types.list_lineage_node_history_input.ListLineageNodeHistoryInput]",
    ) -> AsyncOperationResponse[
        "capo_datazone.types.list_lineage_node_history_output.ListLineageNodeHistoryOutput"
    ]:
        import capo_datazone._operations.data_zone.list_lineage_node_history

        (
            output,
            http_response,
        ) = await capo_datazone._operations.data_zone.list_lineage_node_history.async_list_lineage_node_history(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLineageNodeHistory")
    )
    input_: capo_datazone.types.list_lineage_node_history_input.ListLineageNodeHistoryInput = {
        "domain_identifier": domain_identifier,
        "identifier": identifier,
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if direction is not None:
        input_["direction"] = direction
    if event_timestamp_gte is not None:
        input_["event_timestamp_gte"] = event_timestamp_gte
    if event_timestamp_lte is not None:
        input_["event_timestamp_lte"] = event_timestamp_lte
    if sort_order is not None:
        input_["sort_order"] = sort_order

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output