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.
Namespace: Amazon.CloudSearchDomain
Assembly: AWSSDK.CloudSearchDomain.dll
Version: 3.x.y.z
public class AmazonCloudSearchDomainClient : AmazonServiceClient IAmazonCloudSearchDomain, IAmazonService, IDisposable
The AmazonCloudSearchDomainClient type exposes the following members
Name | Description | |
---|---|---|
![]() |
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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
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. <?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSProfileName" value="AWS Default"/> </appSettings> </configuration> |
![]() |
AmazonCloudSearchDomainClient(string, AWSCredentials) |
Constructs AmazonCloudSearchDomainClient with AWS Credentials |
![]() |
AmazonCloudSearchDomainClient(AWSCredentials, AmazonCloudSearchDomainConfig) |
Constructs AmazonCloudSearchDomainClient with AWS Credentials and an AmazonCloudSearchDomainClient Configuration object. |
![]() |
AmazonCloudSearchDomainClient(string, string) |
Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudSearchDomainClient(string, string, string) |
Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudSearchDomainClient(string, string, AmazonCloudSearchDomainConfig) |
Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object. |
![]() |
AmazonCloudSearchDomainClient(string, string, string, string) |
Constructs AmazonCloudSearchDomainClient with AWS Access Key ID and AWS Secret Key |
![]() |
AmazonCloudSearchDomainClient(string, string, string, AmazonCloudSearchDomainConfig) |
Constructs AmazonCloudSearchDomainClient with AWS Access Key ID, AWS Secret Key and an AmazonCloudSearchDomainClient Configuration object. |
Name | Type | Description | |
---|---|---|---|
![]() |
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
Name | Description | |
---|---|---|
![]() |
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
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:
For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.
The endpoint for submitting |
![]() |
SearchAsync(SearchRequest, CancellationToken) |
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:
For more information, see Searching Your Data in the Amazon CloudSearch Developer Guide.
The endpoint for submitting |
![]() |
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 |
![]() |
SuggestAsync(SuggestRequest, CancellationToken) |
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 |
![]() |
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 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. |
![]() |
UploadDocumentsAsync(UploadDocumentsRequest, CancellationToken) |
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 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. |
Name | Description | |
---|---|---|
![]() |
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
![]() |
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5