list_filters `async` ¶

list_filters(
    detector_id: DetectorId,
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    max_results: Optional[MaxResults] = None,
    next_token: Optional[String] = None,
) -> ListFiltersResponse

Returns a paginated list of the current filters.

Parameters:

detector_id (DetectorId) –

The unique ID of the detector that is associated with the filter.

To find the detectorId in the current Region, see the Settings page in the GuardDuty console, or run the ListDetectors API.
max_results (Optional[MaxResults], default: None ) –

You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.
next_token (Optional[String], default: None ) –

You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.

Raises:

BadRequestException –

A bad request exception object.
InternalServerErrorException –

An internal server error exception object.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_guardduty/_services/async_guard_duty.py

async def list_filters(
    self,
    detector_id: "capo_guardduty.types.detector_id.DetectorId",
    *,
    config_overrides: Optional[AsyncGuardDutyClientConfig] = None,
    max_results: Optional["capo_guardduty.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_guardduty.types.string.String"] = None,
) -> "capo_guardduty.types.list_filters_response.ListFiltersResponse":
    """<p>Returns a paginated list of the current filters.</p>

    Args:
        detector_id: <p>The unique ID of the detector that is associated with the filter.</p> <p>To find the <code>detectorId</code> in the current Region, see the Settings page in the GuardDuty console, or run the <a href="https://docs.aws.amazon.com/guardduty/latest/APIReference/API_ListDetectors.html">ListDetectors</a> API.</p>
        max_results: <p>You can use this parameter to indicate the maximum number of items that you want in the response. The default value is 50. The maximum value is 50.</p>
        next_token: <p>You can use this parameter when paginating results. Set the value of this parameter to null on your first call to the list action. For subsequent calls to the action, fill nextToken in the request with the value of NextToken from the previous response to continue listing data.</p>

    Raises:
        capo_guardduty.errors.bad_request_exception.BadRequestException: <p>A bad request exception object.</p>
        capo_guardduty.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal server error exception object.</p>
        capo_guardduty.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_guardduty.types.list_filters_request.ListFiltersRequest]",
    ) -> AsyncOperationResponse[
        "capo_guardduty.types.list_filters_response.ListFiltersResponse"
    ]:
        import capo_guardduty._operations.guard_duty_api_service.list_filters

        (
            output,
            http_response,
        ) = await capo_guardduty._operations.guard_duty_api_service.list_filters.async_list_filters(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListFilters")
    )
    input_: capo_guardduty.types.list_filters_request.ListFiltersRequest = {
        "detector_id": detector_id
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token

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

list_filters async ¶

list_filters `async` ¶