CloudSearchDomain / Client / upload_documents

upload_documents#

CloudSearchDomain.Client.upload_documents(**kwargs)#

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 also: AWS API Documentation

Request Syntax

response = client.upload_documents(
    documents=b'bytes'|file,
    contentType='application/json'|'application/xml'
)
Parameters:

  • documents (bytes or seekable file-like object) –

    [REQUIRED]

    A batch of documents formatted in JSON or HTML.

  • contentType (string) –

    [REQUIRED]

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

    • application/json

    • application/xml

Return type:

dict

Returns:

Response Syntax

{
    'status': 'string',
    'adds': 123,
    'deletes': 123,
    'warnings': [
        {
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    Contains the response to an UploadDocuments request.

    • status (string) –

      The status of an UploadDocumentsRequest.

    • adds (integer) –

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

    • deletes (integer) –

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

    • warnings (list) –

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

      • (dict) –

        A warning returned by the document service when an issue is discovered while processing an upload request.

        • message (string) –

          The description for a warning returned by the document service.

Exceptions

  • CloudSearchDomain.Client.exceptions.DocumentServiceException