View a markdown version of this page

FilterSpecification - Amazon DynamoDB

FilterSpecification

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.

Contents

Note

In the following list, the required parameters are described first.

ExpressionAttributeNames

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

Type: String to string map

Value Length Constraints: Maximum length of 65535.

Required: No

ExpressionAttributeValues

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

Type: String to AttributeValue object map

Required: No

FilterExpression

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.

Type: String

Required: No

KeyConditionExpression

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.

Type: String

Required: No

ProjectionExpression

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.

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: