:doc:`SSMIncidents <../../ssm-incidents>` / Paginator / ListTimelineEvents

******************
ListTimelineEvents
******************



.. py:class:: SSMIncidents.Paginator.ListTimelineEvents

  ::

    
    paginator = client.get_paginator('list_timeline_events')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`SSMIncidents.Client.list_timeline_events`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          filters=[
              {
                  'condition': {
                      'after': datetime(2015, 1, 1),
                      'before': datetime(2015, 1, 1),
                      'equals': {
                          'integerValues': [
                              123,
                          ],
                          'stringValues': [
                              'string',
                          ]
                      }
                  },
                  'key': 'string'
              },
          ],
          incidentRecordArn='string',
          sortBy='EVENT_TIME',
          sortOrder='ASCENDING'|'DESCENDING',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type filters: list
    :param filters: 

      Filters the timeline events based on the provided conditional values. You can filter timeline events with the following keys:

       

      
      * ``eventReference``
       
      * ``eventTime``
       
      * ``eventType``
      

       

      Note the following when deciding how to use Filters:

       

      
      * If you don't specify a Filter, the response includes all timeline events.
       
      * If you specify more than one filter in a single request, the response returns timeline events that match all filters.
       
      * If you specify a filter with more than one value, the response returns timeline events that match any of the values provided.
      

      

    
      - *(dict) --* 

        Filter the selection by using a condition.

        

      
        - **condition** *(dict) --* **[REQUIRED]** 

          The condition accepts before or after a specified time, equal to a string, or equal to an integer.

          .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``after``, ``before``, ``equals``. 

        
          - **after** *(datetime) --* 

            After the specified timestamp.

            

          
          - **before** *(datetime) --* 

            Before the specified timestamp

            

          
          - **equals** *(dict) --* 

            The value is equal to the provided string or integer.

            .. note::    This is a Tagged Union structure. Only one of the     following top level keys can be set: ``integerValues``, ``stringValues``. 

          
            - **integerValues** *(list) --* 

              The list of integer values that the filter matches.

              

            
              - *(integer) --* 

              
          
            - **stringValues** *(list) --* 

              The list of string values that the filter matches.

              

            
              - *(string) --* 

              
          
          
        
        - **key** *(string) --* **[REQUIRED]** 

          The key that you're filtering on.

          

        
      
  
    :type incidentRecordArn: string
    :param incidentRecordArn: **[REQUIRED]** 

      The Amazon Resource Name (ARN) of the incident that includes the timeline event.

      

    
    :type sortBy: string
    :param sortBy: 

      Sort timeline events by the specified key value pair.

      

    
    :type sortOrder: string
    :param sortOrder: 

      Sorts the order of timeline events by the value specified in the ``sortBy`` field.

      

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

      
      ::

        {
            'eventSummaries': [
                {
                    'eventId': 'string',
                    'eventReferences': [
                        {
                            'relatedItemId': 'string',
                            'resource': 'string'
                        },
                    ],
                    'eventTime': datetime(2015, 1, 1),
                    'eventType': 'string',
                    'eventUpdatedTime': datetime(2015, 1, 1),
                    'incidentRecordArn': 'string'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **eventSummaries** *(list) --* 

          Details about each event that occurred during the incident.

          
          

          - *(dict) --* 

            Details about a timeline event during an incident.

            
            

            - **eventId** *(string) --* 

              The timeline event ID.

              
            

            - **eventReferences** *(list) --* 

              A list of references in a ``TimelineEvent``.

              
              

              - *(dict) --* 

                An item referenced in a ``TimelineEvent`` that is involved in or somehow associated with an incident. You can specify an Amazon Resource Name (ARN) for an Amazon Web Services resource or a ``RelatedItem`` ID.

                .. note::    This is a Tagged Union structure. Only one of the     following top level keys will be set: ``relatedItemId``, ``resource``.     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'}


              
                

                - **relatedItemId** *(string) --* 

                  The ID of a ``RelatedItem`` referenced in a ``TimelineEvent``.

                  
                

                - **resource** *(string) --* 

                  The Amazon Resource Name (ARN) of an Amazon Web Services resource referenced in a ``TimelineEvent``.

                  
            
          
            

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

              The timestamp for when the event occurred.

              
            

            - **eventType** *(string) --* 

              The type of event. The timeline event must be ``Custom Event`` or ``Note``.

              
            

            - **eventUpdatedTime** *(datetime) --* 

              The timestamp for when the timeline event was last updated.

              
            

            - **incidentRecordArn** *(string) --* 

              The Amazon Resource Name (ARN) of the incident that the event happened during.

              
        
      
        

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

          A token to resume pagination.

          
    