Safe Haskell | None |
---|---|
Language | Haskell2010 |
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.
http://docs.aws.amazon.com/cloudsearch/latest/developerguide/API_UploadDocuments.html
- data UploadDocuments
- uploadDocuments :: Base64 -> Text -> UploadDocuments
- udContentType :: Lens' UploadDocuments Text
- udDocuments :: Lens' UploadDocuments Base64
- data UploadDocumentsResponse
- uploadDocumentsResponse :: UploadDocumentsResponse
- udrAdds :: Lens' UploadDocumentsResponse (Maybe Integer)
- udrDeletes :: Lens' UploadDocumentsResponse (Maybe Integer)
- udrStatus :: Lens' UploadDocumentsResponse (Maybe Text)
- udrWarnings :: Lens' UploadDocumentsResponse [DocumentServiceWarning]
Request
data UploadDocuments Source
Request constructor
UploadDocuments
constructor.
The fields accessible through corresponding lenses are:
Request lenses
udContentType :: Lens' UploadDocuments Text Source
The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats: applicationjson applicationxml.
udDocuments :: Lens' UploadDocuments Base64 Source
A batch of documents formatted in JSON or HTML.
Response
Response constructor
uploadDocumentsResponse :: UploadDocumentsResponse Source
UploadDocumentsResponse
constructor.
The fields accessible through corresponding lenses are:
Response lenses
udrAdds :: Lens' UploadDocumentsResponse (Maybe Integer) Source
The number of documents that were added to the search domain.
udrDeletes :: Lens' UploadDocumentsResponse (Maybe Integer) Source
The number of documents that were deleted from the search domain.
udrStatus :: Lens' UploadDocumentsResponse (Maybe Text) Source
The status of an UploadDocumentsRequest.
udrWarnings :: Lens' UploadDocumentsResponse [DocumentServiceWarning] Source
Any warnings returned by the document service about the documents being uploaded.