Skip to content

RDS  >  Structures  >  Filter

Filter

Structure Class

Filter dataclass

Bases: _SerdeShape

A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as IDs. The filters supported by a describe operation are documented with the describe operation.

Note

Currently, wildcards are not supported in filters.

The following actions can be filtered:

  • DescribeDBCapacityReservations

  • DescribeDBClusterBacktracks

  • DescribeDBClusterEndpoints

  • DescribeDBClusters

  • DescribeDBInstances

  • DescribeDBRecommendations

  • DescribeDBShardGroups

  • DescribePendingMaintenanceActions

Attributes

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

The name of the filter. Filter names are case-sensitive.

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

One or more filter values. Filter values are case-sensitive.