IndexField
Description
Configuration information for a field in the index, including its name, type, and options. The supported options depend on the
IndexFieldType
.
Contents
- DateArrayOptions
-
Options for a field that contains an array of dates. Present if
IndexFieldType
specifies the field is of typedate-array
. All options are enabled by default.Type: DateArrayOptions
Required: No
- DateOptions
-
Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if
IndexFieldType
specifies the field is of typedate
. All options are enabled by default.Type: DateOptions
Required: No
- DoubleArrayOptions
-
Options for a field that contains an array of double-precision 64-bit floating point values. Present if
IndexFieldType
specifies the field is of typedouble-array
. All options are enabled by default.Type: DoubleArrayOptions
Required: No
- DoubleOptions
-
Options for a double-precision 64-bit floating point field. Present if
IndexFieldType
specifies the field is of typedouble
. All options are enabled by default.Type: DoubleOptions
Required: No
- IndexFieldName
-
A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields. A dynamic field's name defines a pattern that begins or ends with a wildcard. Any document fields that don't map to a regular index field but do match a dynamic field's pattern are configured with the dynamic field's indexing options.
Regular field names begin with a letter and can contain the following characters: a-z (lowercase), 0-9, and _ (underscore). Dynamic field names must begin or end with a wildcard (*). The wildcard can also be the only character in a dynamic field name. Multiple wildcards, and wildcards embedded within a string are not supported.
The name
score
is reserved and cannot be used as a field name. To reference a document's ID, you can use the name_id
.Type: String
Length constraints: Minimum length of 1. Maximum length of 64.
Required: Yes
- IndexFieldType
-
The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see Configuring Index Fields in the Amazon CloudSearch Developer Guide.
Type: String
Valid Values:
int | double | literal | text | date | latlon | int-array | double-array | literal-array | text-array | date-array
Required: Yes
- IntArrayOptions
-
Options for a field that contains an array of 64-bit signed integers. Present if
IndexFieldType
specifies the field is of typeint-array
. All options are enabled by default.Type: IntArrayOptions
Required: No
- IntOptions
-
Options for a 64-bit signed integer field. Present if
IndexFieldType
specifies the field is of typeint
. All options are enabled by default.Type: IntOptions
Required: No
- LatLonOptions
-
Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if
IndexFieldType
specifies the field is of typelatlon
. All options are enabled by default.Type: LatLonOptions
Required: No
- LiteralArrayOptions
-
Options for a field that contains an array of literal strings. Present if
IndexFieldType
specifies the field is of typeliteral-array
. All options are enabled by default.Type: LiteralArrayOptions
Required: No
- LiteralOptions
-
Options for literal field. Present if
IndexFieldType
specifies the field is of typeliteral
. All options are enabled by default.Type: LiteralOptions
Required: No
- TextArrayOptions
-
Options for a field that contains an array of text strings. Present if
IndexFieldType
specifies the field is of typetext-array
. Atext-array
field is always searchable. All options are enabled by default.Type: TextArrayOptions
Required: No
- TextOptions
-
Options for text field. Present if
IndexFieldType
specifies the field is of typetext
. Atext
field is always searchable. All options are enabled by default.Type: TextOptions
Required: No