| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
DefineIndexField
Description
Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.
Request Parameters
For information about the common parameters that all actions use, see Common Query Parameters.
| Name | Description | Required |
|---|---|---|
DomainName
|
A string that represents the name of a domain. Domain names must be unique across the domains owned by an account within an AWS region. Domain names must start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen). Uppercase letters and underscores are not allowed. Type: String Length constraints: Minimum length of 3. Maximum length of 28. | Yes |
IndexField
|
Defines a field in the index, including its name, type, and the source of its data. The Type: IndexField | Yes |
Response Elements
DefineIndexFieldResult
structure.
| Name | Description |
|---|---|
IndexField
|
The value of an Type: IndexFieldStatus |
Errors
For information about the common errors that all actions use, see Common Errors.
| Error | Description | HTTP Status Code |
|---|---|---|
Base
|
An error occurred while processing the request. | 400 |
Internal
|
An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard. | 500 |
InvalidType
|
The request was rejected because it specified an invalid type definition. | 409 |
LimitExceeded
|
The request was rejected because a resource limit has already been met. | 409 |
ResourceNotFound
|
The request was rejected because it attempted to reference a resource that does not exist. | 409 |
