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.

Implementation for accessing CloudSearchDomain You use the AmazonCloudSearch2013 API to upload documents to a search domain and search those documents.

The endpoints for submitting UploadDocuments, Search, and Suggest requests are domain-specific. To get the endpoints for your domain, use the Amazon CloudSearch configuration service DescribeDomains action. The domain endpoints are also displayed on the domain dashboard in the Amazon CloudSearch console. You submit suggest requests to the search endpoint.

For more information, see the Amazon CloudSearch Developer Guide.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonServiceClient
    Amazon.CloudSearchDomain.AmazonCloudSearchDomainClient

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

Syntax

C#
public class AmazonCloudSearchDomainClient : AmazonServiceClient
         IAmazonCloudSearchDomain, IAmazonService, IDisposable

The AmazonCloudSearchDomainClient type exposes the following members

Constructors

NameDescription
Public Method AmazonCloudSearchDomainClient()

Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCloudSearchDomainClient(string)

Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCloudSearchDomainClient(AmazonCloudSearchDomainConfig)

Constructs AmazonCloudSearchDomainClient with the credentials loaded from the application's default configuration, and if unsuccessful from the Instance Profile service on an EC2 instance. Example App.config with credentials set.



    
        
    

             

Public Method AmazonCloudSearchDomainClient(string, AWSCredentials)

Constructs AmazonCloudSearchDomainClient with AWS Credentials

Public Method AmazonCloudSearchDomainClient(AWSCredentials, AmazonCloudSearchDomainConfig)

Constructs AmazonCloudSearchDomainClient with AWS Credentials and an AmazonCloudSearchDomainClient Configuration object.

Public Method AmazonCloudSearchDomainClient(string, string)

Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudSearchDomainClient(string, string, string)

Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudSearchDomainClient(string, string, AmazonCloudSearchDomainConfig)

Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object.

Public Method AmazonCloudSearchDomainClient(string, string, string, string)

Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key

Public Method AmazonCloudSearchDomainClient(string, string, string, AmazonCloudSearchDomainConfig)

Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object.

Properties

NameTypeDescription
Public Property Config Amazon.Runtime.IClientConfig Inherited from Amazon.Runtime.AmazonServiceClient.

Methods

Note:

Asynchronous operations (methods ending with Async) in the table below are for .NET 4.5 or higher. For .NET 3.5 the SDK follows the standard naming convention of BeginMethodName and EndMethodName to indicate asynchronous operations - these method pairs are not shown in the table below.

NameDescription
Public Method Dispose() Inherited from Amazon.Runtime.AmazonServiceClient.
Public Method Search(SearchRequest)

Retrieves a list of documents that match the specified search criteria. How you specify the search criteria depends on which query parser you use. Amazon CloudSearch supports four query parsers:

  • simple: search all text and text-array fields for the specified string. Search for phrases, individual terms, and prefixes.
  • structured: search specific fields, construct compound queries using Boolean operators, and use advanced features such as term boosting and proximity searching.
  • lucene: specify search criteria using the Apache Lucene query parser syntax.
  • dismax: specify search criteria using the simplified subset of the Apache Lucene query parser syntax defined by the DisMax query parser.

For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Search requests is domain-specific. You submit search requests to a domain's search endpoint. To get the search 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.

Public Method SearchAsync(SearchRequest, CancellationToken)

Initiates the asynchronous execution of the Search operation.

Public Method Suggest(SuggestRequest)

Retrieves autocomplete suggestions for a partial query string. You can use suggestions enable you to display likely matches before users finish typing. In Amazon CloudSearch, suggestions are based on the contents of a particular text field. When you request suggestions, Amazon CloudSearch finds all of the documents whose values in the suggester field start with the specified query string. The beginning of the field must match the query string to be considered a match.

For more information about configuring suggesters and retrieving suggestions, see Getting Suggestions in the Amazon CloudSearch Developer Guide.

The endpoint for submitting Suggest requests is domain-specific. You submit suggest requests to a domain's search endpoint. To get the search 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.

Public Method SuggestAsync(SuggestRequest, CancellationToken)

Initiates the asynchronous execution of the Suggest operation.

Public Method UploadDocuments(UploadDocumentsRequest)

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.

Public Method UploadDocumentsAsync(UploadDocumentsRequest, CancellationToken)

Initiates the asynchronous execution of the UploadDocuments operation.

Events

NameDescription
Event AfterResponseEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event BeforeRequestEvent Inherited from Amazon.Runtime.AmazonServiceClient.
Event ExceptionEvent Inherited from Amazon.Runtime.AmazonServiceClient.

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