Skip to content

list_filters

Operation

list_filters

list_filters(request: ListFiltersInput | ListFiltersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFiltersInputDict]) -> ListFiltersOutput

Returns a paginated list of the current filters.

Parameters:

Name Type Description Default
request ListFiltersInput | ListFiltersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListFiltersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListFiltersOutput

An instance of ListFiltersOutput.

list_filters async

list_filters(request: ListFiltersInput | ListFiltersInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[ListFiltersInputDict]) -> ListFiltersOutput

Returns a paginated list of the current filters.

Parameters:

Name Type Description Default
request ListFiltersInput | ListFiltersInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None
**kwargs Unpack[ListFiltersInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
ListFiltersOutput

An instance of ListFiltersOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

ListFiltersInputDict

Bases: TypedDict

Dictionary form of ListFiltersInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

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 instance-attribute
max_results: int | 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 instance-attribute
next_token: str | 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.

ListFiltersInput dataclass

Bases: _SerdeShape

Dataclass for ListFiltersInput structure.

Attributes

detector_id class-attribute instance-attribute
detector_id: str | None = ...

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 class-attribute instance-attribute
max_results: int | 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 class-attribute instance-attribute
next_token: str | 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.

Output

ListFiltersOutput dataclass

Bases: _SerdeShape

Dataclass for ListFiltersOutput structure.

Attributes

filter_names class-attribute instance-attribute
filter_names: list[str] | None = ...

A list of filter names.

next_token class-attribute instance-attribute
next_token: str | None = ...

The pagination parameter to be used on the next list operation to retrieve more items.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.