Network.AWS.CloudSearchDomains.UploadDocuments

Posts a batch of documents to a search domain for indexing. A document batch is a collection of add and delete operations that represent the documents you want to add, update, or delete from your domain. Batches can be described in either JSON or XML. Each item that you want Amazon CloudSearch to return as a search result (such as a product) is represented as a document. Every document has a unique ID and one or more fields that contain the data that you want to search and return in results. Individual documents cannot contain more than 1 MB of data. The entire batch cannot exceed 5 MB. To get the best possible upload performance, group add and delete operations in batches that are close the 5 MB limit. Submitting a large volume of single-document batches can overload a domain's document service.

The endpoint for submitting UploadDocuments requests is domain-specific. To get the document endpoint for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. A domain's endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console.

For more information about formatting your data for Amazon CloudSearch, see Preparing Your Data in the Amazon CloudSearch Developer Guide. For more information about uploading data for indexing, see Uploading Data in the Amazon CloudSearch Developer Guide.

See: AWS API Reference for UploadDocuments.

Creating a Request

uploadDocuments

Arguments

:: ContentType

udContentType

-> RqBody

udDocuments

-> UploadDocuments

Creates a value of UploadDocuments with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• udContentType
• udDocuments

data UploadDocuments

Container for the parameters to the UploadDocuments request.

See: uploadDocuments smart constructor.

Instances

Show UploadDocuments

Generic UploadDocuments

AWSRequest UploadDocuments

ToPath UploadDocuments

ToHeaders UploadDocuments

ToBody UploadDocuments

ToQuery UploadDocuments

type Rep UploadDocuments

type Sv UploadDocuments = CloudSearchDomains

type Rs UploadDocuments = UploadDocumentsResponse

Request Lenses

udContentType :: Lens' UploadDocuments ContentType

The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:

• application/json
• application/xml

udDocuments :: Lens' UploadDocuments RqBody

A batch of documents formatted in JSON or HTML.

Destructuring the Response

uploadDocumentsResponse

Arguments

:: Int

udrsStatus

-> UploadDocumentsResponse

Creates a value of UploadDocumentsResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• udrsAdds
• udrsWarnings
• udrsDeletes
• udrsStatus

data UploadDocumentsResponse

Contains the response to an UploadDocuments request.

See: uploadDocumentsResponse smart constructor.

Instances

Eq UploadDocumentsResponse

Data UploadDocumentsResponse

Read UploadDocumentsResponse

Show UploadDocumentsResponse

Generic UploadDocumentsResponse

type Rep UploadDocumentsResponse

Response Lenses

udrsAdds :: Lens' UploadDocumentsResponse (Maybe Integer)

The number of documents that were added to the search domain.

udrsWarnings :: Lens' UploadDocumentsResponse [DocumentServiceWarning]

Any warnings returned by the document service about the documents being uploaded.

udrsDeletes :: Lens' UploadDocumentsResponse (Maybe Integer)

The number of documents that were deleted from the search domain.

udrsStatus :: Lens' UploadDocumentsResponse Int

The response status code.