| « PreviousNext » | |
   | Did this page help you? Yes | No | Tell us about it... |
DescribeIndexFields
Description
Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.
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 |
FieldNames.member.N
|
Limits the Type: String list | No |
Response Elements
DescribeIndexFieldsResult
structure.
| Name | Description |
|---|---|
IndexFields
|
The index fields configured for the domain. Type: IndexFieldStatus list |
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 |
ResourceNotFound
|
The request was rejected because it attempted to reference a resource that does not exist. | 409 |
