View a markdown version of this page

TextSearchConfiguration - Amazon S3

TextSearchConfiguration

A full-text search configuration for a single metadata key.

Contents

metadataKey

The metadata key to make full-text searchable.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Required: Yes

language

The language that the text search analyzer uses. Valid values are en (English), fr (French), es (Spanish), pt (Portuguese), it (Italian), de (German), nl (Dutch), zh (Chinese), ja (Japanese), and ko (Korean). If you don't specify a language, Amazon S3 Vectors uses the default standard analyzer.

Type: String

Valid Values: en | fr | es | pt | it | de | nl | zh | ja | ko

Required: No

status

The backfill status of the text search configuration. Valid values are ACTIVE, which indicates that the analyzer is built and serving queries, and BUILDING, which indicates that the analyzer is being backfilled and isn't yet serving queries. This field is returned by GetIndex.

Type: String

Valid Values: ACTIVE | BUILDING

Required: No

See Also

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