Amazon CloudSearch
Developer Guide (API Version 2011-02-01)
« PreviousNext »
View the PDF for this guide.Go to the AWS Discussion Forum for this product.Go to the Kindle Store to download this guide in Kindle format.Did this page help you?  Yes | No |  Tell us about it...

IndexDocuments

Description

Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.

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

Response Elements

The following elements come wrapped in a IndexDocumentsResult structure.
NameDescription
FieldNames

The names of the fields that are currently being processed due to an IndexDocuments action.

Type: String 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