Skip to content

DynamoDB  >  Structures  >  FilterSpecification

FilterSpecification

Structure Class

FilterSpecification dataclass

Contains the filter criteria used to limit which items are included in an export. If you don't include this parameter, all items and attributes are exported.

Attributes

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

One or more substitution tokens for attribute names in an expression. For more information, see Expression Attribute Names in the Amazon DynamoDB Developer Guide.

expression_attribute_values class-attribute instance-attribute 
expression_attribute_values: dict[str, AttributeValue] | None = None

One or more values that can be substituted in an expression. For more information, see Expression Attribute Values in the Amazon DynamoDB Developer Guide.

filter_expression class-attribute instance-attribute 
filter_expression: str | None = None

A condition that filters which items are included in the export. This parameter uses the same syntax as FilterExpression in Query and Scan. If you don't provide KeyConditionExpression, this expression can also reference key attributes. If you don't specify this parameter, all items are included in the export.

key_condition_expression class-attribute instance-attribute 
key_condition_expression: str | None = None

A condition expression that filters items by key values. The expression must test equality on a single partition key value and can optionally compare a sort key value. This parameter uses the same syntax as KeyConditionExpression in Query. When you provide this parameter, FilterExpression can only reference non-key attributes. If you don't specify this parameter, all items are eligible for export.

projection_expression class-attribute instance-attribute 
projection_expression: str | None = None

The attributes you want to retrieve for items included in the export. Separate attribute names in the expression with commas. If you don't specify this parameter, all attributes are returned.