:doc:`CloudWatchLogs <../../logs>` / Paginator / FilterLogEvents

***************
FilterLogEvents
***************



.. py:class:: CloudWatchLogs.Paginator.FilterLogEvents

  ::

    
    paginator = client.get_paginator('filter_log_events')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`CloudWatchLogs.Client.filter_log_events`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/logs-2014-03-28/FilterLogEvents>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          logGroupName='string',
          logGroupIdentifier='string',
          logStreamNames=[
              'string',
          ],
          logStreamNamePrefix='string',
          startTime=123,
          endTime=123,
          filterPattern='string',
          interleaved=True|False,
          unmask=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type logGroupName: string
    :param logGroupName: 

      The name of the log group to search.

       

      .. note::

        

        You must include either ``logGroupIdentifier`` or ``logGroupName``, but not both.

        

      

    
    :type logGroupIdentifier: string
    :param logGroupIdentifier: 

      Specify either the name or ARN of the log group to view log events from. If the log group is in a source account and you are using a monitoring account, you must use the log group ARN.

       

      .. note::

        

        You must include either ``logGroupIdentifier`` or ``logGroupName``, but not both.

        

      

    
    :type logStreamNames: list
    :param logStreamNames: 

      Filters the results to only logs from the log streams in this list.

       

      If you specify a value for both ``logStreamNames`` and ``logStreamNamePrefix``, the action returns an ``InvalidParameterException`` error.

      

    
      - *(string) --* 

      
  
    :type logStreamNamePrefix: string
    :param logStreamNamePrefix: 

      Filters the results to include only events from log streams that have names starting with this prefix.

       

      If you specify a value for both ``logStreamNamePrefix`` and ``logStreamNames``, the action returns an ``InvalidParameterException`` error.

      

    
    :type startTime: integer
    :param startTime: 

      The start of the time range, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``. Events with a timestamp before this time are not returned.

      

    
    :type endTime: integer
    :param endTime: 

      The end of the time range, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``. Events with a timestamp later than this time are not returned.

      

    
    :type filterPattern: string
    :param filterPattern: 

      The filter pattern to use. For more information, see `Filter and Pattern Syntax <https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/FilterAndPatternSyntax.html>`__.

       

      If not provided, all the events are matched.

      

    
    :type interleaved: boolean
    :param interleaved: 

      If the value is true, the operation attempts to provide responses that contain events from multiple log streams within the log group, interleaved in a single response. If the value is false, all the matched log events in the first log stream are searched first, then those in the next log stream, and so on.

       

      **Important** As of June 17, 2019, this parameter is ignored and the value is assumed to be true. The response from this operation always interleaves events from multiple log streams within a log group.

      

    
    :type unmask: boolean
    :param unmask: 

      Specify ``true`` to display the log event fields with all sensitive data unmasked and visible. The default is ``false``.

       

      To use this operation with this parameter, you must be signed into an account with the ``logs:Unmask`` permission.

      

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

      
      ::

        {
            'events': [
                {
                    'logStreamName': 'string',
                    'timestamp': 123,
                    'message': 'string',
                    'ingestionTime': 123,
                    'eventId': 'string'
                },
            ],
            'searchedLogStreams': [
                {
                    'logStreamName': 'string',
                    'searchedCompletely': True|False
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **events** *(list) --* 

          The matched events.

          
          

          - *(dict) --* 

            Represents a matched event.

            
            

            - **logStreamName** *(string) --* 

              The name of the log stream to which this event belongs.

              
            

            - **timestamp** *(integer) --* 

              The time the event occurred, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``.

              
            

            - **message** *(string) --* 

              The data contained in the log event.

              
            

            - **ingestionTime** *(integer) --* 

              The time the event was ingested, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``.

              
            

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

              The ID of the event.

              
        
      
        

        - **searchedLogStreams** *(list) --* 

          **Important** As of May 15, 2020, this parameter is no longer supported. This parameter returns an empty list.

           

          Indicates which log streams have been searched and whether each has been searched completely.

          
          

          - *(dict) --* 

            Represents the search status of a log stream.

            
            

            - **logStreamName** *(string) --* 

              The name of the log stream.

              
            

            - **searchedCompletely** *(boolean) --* 

              Indicates whether all the events in this log stream were searched.

              
        
      
        

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

          A token to resume pagination.

          
    