Skip to content

list_lineage_events

list_lineage_events(
    domain_identifier: DomainId,
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    timestamp_after: Optional[datetime] = None,
    timestamp_before: Optional[datetime] = None,
    processing_status: Optional[LineageEventProcessingStatus] = None,
    sort_order: Optional[SortOrder] = None,
    next_token: Optional[PaginationToken] = None,
) -> ListLineageEventsOutput

Lists lineage events.

Parameters:

  • domain_identifier (DomainId) –

    The ID of the domain where you want to list lineage events.

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

    The maximum number of lineage events to return in a single call to ListLineageEvents. When the number of lineage events 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 ListLineageEvents to list the next set of lineage events.

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

    The after timestamp of a lineage event.

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

    The before timestamp of a lineage event.

  • processing_status (Optional[LineageEventProcessingStatus], default: None ) –

    The processing status of a lineage event.

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

    The sort order of the lineage events.

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

    When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.

Raises:

Source code in docs_src/capo_datazone/_services/data_zone.py
def list_lineage_events(
    self,
    domain_identifier: "capo_datazone.types.domain_id.DomainId",
    *,
    config_overrides: Optional[DataZoneClientConfig] = None,
    max_results: Optional["capo_datazone.types.max_results.MaxResults"] = None,
    timestamp_after: Optional[datetime.datetime] = None,
    timestamp_before: Optional[datetime.datetime] = None,
    processing_status: Optional[
        "capo_datazone.types.lineage_event_processing_status.LineageEventProcessingStatus"
    ] = None,
    sort_order: Optional["capo_datazone.types.sort_order.SortOrder"] = None,
    next_token: Optional[
        "capo_datazone.types.pagination_token.PaginationToken"
    ] = None,
) -> "capo_datazone.types.list_lineage_events_output.ListLineageEventsOutput":
    """<p>Lists lineage events.</p>

    Args:
        domain_identifier: <p>The ID of the domain where you want to list lineage events.</p>
        max_results: <p>The maximum number of lineage events to return in a single call to ListLineageEvents. When the number of lineage events 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 ListLineageEvents to list the next set of lineage events.</p>
        timestamp_after: <p>The after timestamp of a lineage event.</p>
        timestamp_before: <p>The before timestamp of a lineage event.</p>
        processing_status: <p>The processing status of a lineage event.</p>
        sort_order: <p>The sort order of the lineage events.</p>
        next_token: <p>When the number of lineage events 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 lineage events, the response includes a pagination token named NextToken. You can specify this NextToken value in a subsequent call to ListLineageEvents to list the next set of lineage events.</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.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.
    """

    def _handler(
        req: "OperationRequest[capo_datazone.types.list_lineage_events_input.ListLineageEventsInput]",
    ) -> OperationResponse[
        "capo_datazone.types.list_lineage_events_output.ListLineageEventsOutput"
    ]:
        import capo_datazone._operations.data_zone.list_lineage_events

        output, http_response = (
            capo_datazone._operations.data_zone.list_lineage_events.list_lineage_events(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListLineageEvents")
    )
    input_: capo_datazone.types.list_lineage_events_input.ListLineageEventsInput = {
        "domain_identifier": domain_identifier
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if timestamp_after is not None:
        input_["timestamp_after"] = timestamp_after
    if timestamp_before is not None:
        input_["timestamp_before"] = timestamp_before
    if processing_status is not None:
        input_["processing_status"] = processing_status
    if sort_order is not None:
        input_["sort_order"] = sort_order
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output