Skip to content

delete_filter

Operation

delete_filter

delete_filter(request: DeleteFilterInput | DeleteFilterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFilterInputDict]) -> DeleteFilterOutput

Deletes the filter specified by the filter name.

Parameters:

Name Type Description Default
request DeleteFilterInput | DeleteFilterInputDict | 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[DeleteFilterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFilterOutput

An instance of DeleteFilterOutput.

delete_filter async

delete_filter(request: DeleteFilterInput | DeleteFilterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteFilterInputDict]) -> DeleteFilterOutput

Deletes the filter specified by the filter name.

Parameters:

Name Type Description Default
request DeleteFilterInput | DeleteFilterInputDict | 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[DeleteFilterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
DeleteFilterOutput

An instance of DeleteFilterOutput.

Input

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

DeleteFilterInputDict

Bases: TypedDict

Dictionary form of DeleteFilterInput.

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.

filter_name instance-attribute
filter_name: Required[str]

The name of the filter that you want to delete.

DeleteFilterInput dataclass

Bases: _SerdeShape

Dataclass for DeleteFilterInput 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.

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

The name of the filter that you want to delete.

Output

DeleteFilterOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteFilterOutput structure.

Attributes

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.