Skip to content

get_filter

Operation

get_filter

get_filter(request: GetFilterInput | GetFilterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFilterInputDict]) -> GetFilterOutput

Returns the details of the filter specified by the filter name.

Parameters:

Name Type Description Default
request GetFilterInput | GetFilterInputDict | 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[GetFilterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFilterOutput

An instance of GetFilterOutput.

get_filter async

get_filter(request: GetFilterInput | GetFilterInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetFilterInputDict]) -> GetFilterOutput

Returns the details of the filter specified by the filter name.

Parameters:

Name Type Description Default
request GetFilterInput | GetFilterInputDict | 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[GetFilterInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetFilterOutput

An instance of GetFilterOutput.

Input

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

GetFilterInputDict

Bases: TypedDict

Dictionary form of GetFilterInput.

Attributes

detector_id instance-attribute
detector_id: Required[str]

The unique ID of the detector that is associated with this 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 you want to get.

GetFilterInput dataclass

Bases: _SerdeShape

Dataclass for GetFilterInput structure.

Attributes

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

The unique ID of the detector that is associated with this 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 you want to get.

Output

GetFilterOutput dataclass

Bases: _SerdeShape

Dataclass for GetFilterOutput structure.

Attributes

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

Specifies the action that is to be applied to the findings that match the filter.

created_at class-attribute instance-attribute
created_at: datetime | None = ...

The timestamp when the filter was created. This field is not available for filters that were created before the lifecycle metadata feature was enabled (legacy filters).

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

The description of the filter.

finding_criteria class-attribute instance-attribute
finding_criteria: FindingCriteria | None = ...

Represents the criteria to be used in the filter for querying findings.

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

The name of the filter.

rank class-attribute instance-attribute
rank: int | None = ...

Specifies the position of the filter in the list of current filters. Also specifies the order in which this filter is applied to the findings.

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.

tags class-attribute instance-attribute
tags: dict[str, str] | None = ...

The tags of the filter resource.

updated_at class-attribute instance-attribute
updated_at: datetime | None = ...

The timestamp when the filter was last updated. For legacy filters, this field is present only after the filter has been updated at least once since the lifecycle metadata feature was enabled.

version class-attribute instance-attribute
version: int | None = ...

The version of the filter. Every time the filter is updated, the version increments by 1. This field is not available for legacy filters that were created before the lifecycle metadata feature was enabled.