CloudWatchLogs / Paginator / DescribeSubscriptionFilters


class CloudWatchLogs.Paginator.DescribeSubscriptionFilters#
paginator = client.get_paginator('describe_subscription_filters')

Creates an iterator that will paginate through responses from CloudWatchLogs.Client.describe_subscription_filters().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • logGroupName (string) –


    The name of the log group.

  • filterNamePrefix (string) – The prefix to match. If you don’t specify a value, no prefix filter is applied.

  • PaginationConfig (dict) –

    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.

Return type:



Response Syntax

    'subscriptionFilters': [
            'filterName': 'string',
            'logGroupName': 'string',
            'filterPattern': 'string',
            'destinationArn': 'string',
            'roleArn': 'string',
            'distribution': 'Random'|'ByLogStream',
            'creationTime': 123
    '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.

        • creationTime (integer) –

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

    • NextToken (string) –

      A token to resume pagination.