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

***************************
DescribeSubscriptionFilters
***************************



.. py:class:: CloudWatchLogs.Paginator.DescribeSubscriptionFilters

  ::

    
    paginator = client.get_paginator('describe_subscription_filters')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          logGroupName='string',
          filterNamePrefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type logGroupName: string
    :param logGroupName: **[REQUIRED]** 

      The name of the log group.

      

    
    :type filterNamePrefix: string
    :param filterNamePrefix: 

      The prefix to match. If you don't specify a value, no prefix filter is applied.

      

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

      
      ::

        {
            'subscriptionFilters': [
                {
                    'filterName': 'string',
                    'logGroupName': 'string',
                    'filterPattern': 'string',
                    'destinationArn': 'string',
                    'roleArn': 'string',
                    'distribution': 'Random'|'ByLogStream',
                    'applyOnTransformedLogs': True|False,
                    'creationTime': 123,
                    'fieldSelectionCriteria': 'string',
                    'emitSystemFields': [
                        'string',
                    ]
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **subscriptionFilters** *(list) --* 

          The subscription filters.

          
          

          - *(dict) --* 

            Represents a subscription filter.

            
            

            - **filterName** *(string) --* 

              The name of the subscription filter.

              
            

            - **logGroupName** *(string) --* 

              The name of the log group.

              
            

            - **filterPattern** *(string) --* 

              A symbolic description of how CloudWatch Logs should interpret the data in each log event. For example, a log event can contain timestamps, IP addresses, strings, and so on. You use the filter pattern to specify what to look for in the log event message.

              
            

            - **destinationArn** *(string) --* 

              The Amazon Resource Name (ARN) of the destination.

              
            

            - **roleArn** *(string) --* 
            

            - **distribution** *(string) --* 

              The method used to distribute log data to the destination, which can be either random or grouped by log stream.

              
            

            - **applyOnTransformedLogs** *(boolean) --* 

              This parameter is valid only for log groups that have an active log transformer. For more information about log transformers, see `PutTransformer <https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_PutTransformer.html>`__.

               

              If this value is ``true``, the subscription filter is applied on the transformed version of the log events instead of the original ingested log events.

              
            

            - **creationTime** *(integer) --* 

              The creation time of the subscription filter, expressed as the number of milliseconds after ``Jan 1, 1970 00:00:00 UTC``.

              
            

            - **fieldSelectionCriteria** *(string) --* 

              The filter expression that specifies which log events are processed by this subscription filter based on system fields. Returns the ``fieldSelectionCriteria`` value if it was specified when the subscription filter was created.

              
            

            - **emitSystemFields** *(list) --* 

              The list of system fields that are included in the log events sent to the subscription destination. Returns the ``emitSystemFields`` value if it was specified when the subscription filter was created.

              
              

              - *(string) --* 
          
        
      
        

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

          A token to resume pagination.

          
    