Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
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.
See: AWS API Reference for UploadDocuments.
- uploadDocuments :: ContentType -> HashedBody -> UploadDocuments
- data UploadDocuments
- udContentType :: Lens' UploadDocuments ContentType
- udDocuments :: Lens' UploadDocuments HashedBody
- uploadDocumentsResponse :: Int -> UploadDocumentsResponse
- data UploadDocumentsResponse
- udrsStatus :: Lens' UploadDocumentsResponse (Maybe Text)
- udrsAdds :: Lens' UploadDocumentsResponse (Maybe Integer)
- udrsWarnings :: Lens' UploadDocumentsResponse [DocumentServiceWarning]
- udrsDeletes :: Lens' UploadDocumentsResponse (Maybe Integer)
- udrsResponseStatus :: Lens' UploadDocumentsResponse Int
Creating a Request
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:
data UploadDocuments Source
Container for the parameters to the UploadDocuments
request.
See: uploadDocuments
smart constructor.
Request Lenses
udContentType :: Lens' UploadDocuments ContentType Source
The format of the batch you are uploading. Amazon CloudSearch supports two document batch formats:
- application/json
- application/xml
udDocuments :: Lens' UploadDocuments HashedBody Source
A batch of documents formatted in JSON or HTML.
Destructuring the Response
uploadDocumentsResponse Source
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:
data UploadDocumentsResponse Source
Contains the response to an UploadDocuments
request.
See: uploadDocumentsResponse
smart constructor.
Response Lenses
udrsStatus :: Lens' UploadDocumentsResponse (Maybe Text) Source
The status of an UploadDocumentsRequest
.
udrsAdds :: Lens' UploadDocumentsResponse (Maybe Integer) Source
The number of documents that were added to the search domain.
udrsWarnings :: Lens' UploadDocumentsResponse [DocumentServiceWarning] Source
Any warnings returned by the document service about the documents being uploaded.
udrsDeletes :: Lens' UploadDocumentsResponse (Maybe Integer) Source
The number of documents that were deleted from the search domain.
udrsResponseStatus :: Lens' UploadDocumentsResponse Int Source
The response status code.