Skip to content

describe_subscription_filters async

describe_subscription_filters(
    log_group_name: LogGroupName,
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    filter_name_prefix: Optional[FilterName] = None,
    next_token: Optional[NextToken] = None,
    limit: Optional[DescribeLimit] = None,
) -> DescribeSubscriptionFiltersResponse

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.

Parameters:

  • log_group_name (LogGroupName) –

    The name of the log group.

  • filter_name_prefix (Optional[FilterName], default: None ) –

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

  • next_token (Optional[NextToken], default: None ) –

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

  • limit (Optional[DescribeLimit], default: None ) –

    The maximum number of items returned. If you don't specify a value, the default is up to 50 items.

Raises:

Source code in docs_src/capo_cloudwatch_logs/_services/async_cloud_watch_logs.py
async def describe_subscription_filters(
    self,
    log_group_name: "capo_cloudwatch_logs.types.log_group_name.LogGroupName",
    *,
    config_overrides: Optional[AsyncCloudWatchLogsClientConfig] = None,
    filter_name_prefix: Optional[
        "capo_cloudwatch_logs.types.filter_name.FilterName"
    ] = None,
    next_token: Optional["capo_cloudwatch_logs.types.next_token.NextToken"] = None,
    limit: Optional[
        "capo_cloudwatch_logs.types.describe_limit.DescribeLimit"
    ] = None,
) -> "capo_cloudwatch_logs.types.describe_subscription_filters_response.DescribeSubscriptionFiltersResponse":
    """<p>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.</p>

    Args:
        log_group_name: <p>The name of the log group.</p>
        filter_name_prefix: <p>The prefix to match. If you don't specify a value, no prefix filter is applied.</p>
        next_token: <p>The token for the next set of items to return. (You received this token from a previous call.)</p>
        limit: <p>The maximum number of items returned. If you don't specify a value, the default is up to 50 items.</p>

    Raises:
        capo_cloudwatch_logs.errors.invalid_parameter_exception.InvalidParameterException: <p>A parameter is specified incorrectly.</p>
        capo_cloudwatch_logs.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_cloudwatch_logs.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service cannot complete the request.</p>
        capo_cloudwatch_logs.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_cloudwatch_logs.types.describe_subscription_filters_request.DescribeSubscriptionFiltersRequest]",
    ) -> AsyncOperationResponse[
        "capo_cloudwatch_logs.types.describe_subscription_filters_response.DescribeSubscriptionFiltersResponse"
    ]:
        import capo_cloudwatch_logs._operations.logs_20140328.describe_subscription_filters

        (
            output,
            http_response,
        ) = await capo_cloudwatch_logs._operations.logs_20140328.describe_subscription_filters.async_describe_subscription_filters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeSubscriptionFilters")
    )
    input_: capo_cloudwatch_logs.types.describe_subscription_filters_request.DescribeSubscriptionFiltersRequest = {
        "log_group_name": log_group_name
    }
    if filter_name_prefix is not None:
        input_["filter_name_prefix"] = filter_name_prefix
    if next_token is not None:
        input_["next_token"] = next_token
    if limit is not None:
        input_["limit"] = limit

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output