CloudWatchLogs / Client / describe_subscription_filters

describe_subscription_filters#

CloudWatchLogs.Client.describe_subscription_filters(**kwargs)#

Lists the subscription filters for the specified log group. You can list all the subscription filters or filter the results by prefix. The results are ASCII-sorted by filter name.

See also: AWS API Documentation

Request Syntax

response = client.describe_subscription_filters(
    logGroupName='string',
    filterNamePrefix='string',
    nextToken='string',
    limit=123
)
Parameters:

  • logGroupName (string) –

    [REQUIRED]

    The name of the log group.

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

  • nextToken (string) – The token for the next set of items to return. (You received this token from a previous call.)

  • limit (integer) – The maximum number of items returned. If you don’t specify a value, the default is up to 50 items.

Return type:

dict

Returns:

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) –

      The token for the next set of items to return. The token expires after 24 hours.

Exceptions

  • CloudWatchLogs.Client.exceptions.InvalidParameterException

  • CloudWatchLogs.Client.exceptions.ResourceNotFoundException

  • CloudWatchLogs.Client.exceptions.ServiceUnavailableException