DataZone / Client / list_lineage_events

list_lineage_events

DataZone.Client.list_lineage_events(**kwargs)

Lists lineage events.

See also: AWS API Documentation

Request Syntax

response = client.list_lineage_events(
    domainIdentifier='string',
    maxResults=123,
    nextToken='string',
    processingStatus='REQUESTED'|'PROCESSING'|'SUCCESS'|'FAILED',
    sortOrder='ASCENDING'|'DESCENDING',
    timestampAfter=datetime(2015, 1, 1),
    timestampBefore=datetime(2015, 1, 1)
)

Parameters:

• domainIdentifier (string) –

  [REQUIRED]

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

• maxResults (integer) – 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.

• nextToken (string) – 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.

• processingStatus (string) – The processing status of a lineage event.

• sortOrder (string) – The sort order of the lineage events.

• timestampAfter (datetime) – The after timestamp of a lineage event.

• timestampBefore (datetime) – The before timestamp of a lineage event.

Return type:

dict

Returns:

Response Syntax

{
    'items': [
        {
            'createdAt': datetime(2015, 1, 1),
            'createdBy': 'string',
            'domainId': 'string',
            'eventSummary': {
                'openLineageRunEventSummary': {
                    'eventType': 'START'|'RUNNING'|'COMPLETE'|'ABORT'|'FAIL'|'OTHER',
                    'inputs': [
                        {
                            'name': 'string',
                            'namespace': 'string'
                        },
                    ],
                    'job': {
                        'name': 'string',
                        'namespace': 'string'
                    },
                    'outputs': [
                        {
                            'name': 'string',
                            'namespace': 'string'
                        },
                    ],
                    'runId': 'string'
                }
            },
            'eventTime': datetime(2015, 1, 1),
            'id': 'string',
            'processingStatus': 'REQUESTED'|'PROCESSING'|'SUCCESS'|'FAILED'
        },
    ],
    'nextToken': 'string'
}

Response Structure

• (dict) –

  • items (list) –

    The results of the ListLineageEvents action.

    • (dict) –

      The data lineage event summary.

      • createdAt (datetime) –

        The timestamp at which data lineage event was created.

      • createdBy (string) –

        The user who created the data lineage event.

      • domainId (string) –

        The domain ID of the lineage event.

      • eventSummary (dict) –

        The summary of the data lineate event.

        Note

        This is a Tagged Union structure. Only one of the following top level keys will be set: openLineageRunEventSummary. If a client receives an unknown member it will set SDK_UNKNOWN_MEMBER as the top level key, which maps to the name or tag of the unknown member. The structure of SDK_UNKNOWN_MEMBER is as follows:

        'SDK_UNKNOWN_MEMBER': {'name': 'UnknownMemberName'}
        

        • openLineageRunEventSummary (dict) –

          The open lineage run event summary.

          • eventType (string) –

            The event type of the open lineage run event summary.

          • inputs (list) –

            The inputs of the open lineage run event summary.

            • (dict) –

              The name identifier.

              • name (string) –

                The name in the name identifier.

              • namespace (string) –

                The namespace in the name identifier.

          • job (dict) –

            The job of the open lineage run event summary.

            • name (string) –

              The name in the name identifier.

            • namespace (string) –

              The namespace in the name identifier.

          • outputs (list) –

            The outputs of the open lineage run event summary.

            • (dict) –

              The name identifier.

              • name (string) –

                The name in the name identifier.

              • namespace (string) –

                The namespace in the name identifier.

          • runId (string) –

            The runID of the open lineage run event summary.

      • eventTime (datetime) –

        The time of the data lineage event.

      • id (string) –

        The ID of the data lineage event.

      • processingStatus (string) –

        The processing status of the data lineage event.

  • nextToken (string) –

    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.

Exceptions

• DataZone.Client.exceptions.InternalServerException

• DataZone.Client.exceptions.AccessDeniedException

• DataZone.Client.exceptions.ThrottlingException

• DataZone.Client.exceptions.ValidationException

• DataZone.Client.exceptions.UnauthorizedException