:doc:`DataZone <../../datazone>` / Paginator / ListLineageEvents

*****************
ListLineageEvents
*****************



.. py:class:: DataZone.Paginator.ListLineageEvents

  ::

    
    paginator = client.get_paginator('list_lineage_events')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`DataZone.Client.list_lineage_events`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/datazone-2018-05-10/ListLineageEvents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          domainIdentifier='string',
          timestampAfter=datetime(2015, 1, 1),
          timestampBefore=datetime(2015, 1, 1),
          processingStatus='REQUESTED'|'PROCESSING'|'SUCCESS'|'FAILED',
          sortOrder='ASCENDING'|'DESCENDING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type domainIdentifier: string
    :param domainIdentifier: **[REQUIRED]** 

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

      

    
    :type timestampAfter: datetime
    :param timestampAfter: 

      The after timestamp of a lineage event.

      

    
    :type timestampBefore: datetime
    :param timestampBefore: 

      The before timestamp of a lineage event.

      

    
    :type processingStatus: string
    :param processingStatus: 

      The processing status of a lineage event.

      

    
    :type sortOrder: string
    :param sortOrder: 

      The sort order of the lineage events.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

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

      

      - *(dict) --* 
        

        - **items** *(list) --* 

          The results of the ListLineageEvents action.

          
          

          - *(dict) --* 

            The data lineage event summary.

            
            

            - **id** *(string) --* 

              The ID of the data lineage event.

              
            

            - **domainId** *(string) --* 

              The domain ID of the lineage event.

              
            

            - **processingStatus** *(string) --* 

              The processing status of the data lineage event.

              
            

            - **eventTime** *(datetime) --* 

              The time of the data 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.

                  
                

                - **runId** *(string) --* 

                  The runID of the open lineage run event summary.

                  
                

                - **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.

                    
              
                

                - **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.

                      
                
              
                

                - **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.

                      
                
              
            
          
            

            - **createdBy** *(string) --* 

              The user who created the data lineage event.

              
            

            - **createdAt** *(datetime) --* 

              The timestamp at which data lineage event was created.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    