AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the UploadDocuments operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.CloudSearchDomain.AmazonCloudSearchDomainRequest
      Amazon.CloudSearchDomain.Model.UploadDocumentsRequest

Namespace: Amazon.CloudSearchDomain.Model
Assembly: AWSSDK.CloudSearchDomain.dll
Version: 3.x.y.z

Syntax

C#
public class UploadDocumentsRequest : AmazonCloudSearchDomainRequest
         IAmazonWebServiceRequest

The UploadDocumentsRequest type exposes the following members

Constructors

NameDescription
Public Method UploadDocumentsRequest()

Properties

NameTypeDescription
Public Property ContentType Amazon.CloudSearchDomain.ContentType

Gets and sets the property ContentType.

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

  • application/json
  • application/xml

Public Property Documents System.IO.Stream

Gets and sets the property Documents.

A batch of documents formatted in JSON or HTML.

Public Property FilePath System.String

The full path and name to a file that contains a batch of documents to be uploaded. The batch of documents should be formatted in JSON or HTML. If this property is set, the UploadDocumentsRequest.Documents property is ignored.

For WinRT and Windows Phone this property must be in the form of "ms-appdata:///local/file.txt".

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms