AWS SDK Version 2 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.

.NET Framework 3.5
 
Interface for accessing CloudSearch Amazon CloudSearch Configuration Service

You use the configuration service to create, configure, and manage search domains. Configuration service requests are submitted using the AWS Query protocol. AWS Query requests are HTTP or HTTPS requests submitted via HTTP GET or POST with a query parameter named Action.

The endpoint for configuration service requests is region-specific: cloudsearch.region.amazonaws.com. For example, cloudsearch.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Inheritance Hierarchy

Amazon.CloudSearch_2011_02_01.IAmazonCloudSearch

Namespace: Amazon.CloudSearch_2011_02_01
Assembly: AWSSDK.dll
Version: (assembly version)

Syntax

C#
public interface IAmazonCloudSearch
         IDisposable

The IAmazonCloudSearch type exposes the following members

Methods

NameDescription
Public Method BeginCreateDomain(CreateDomainRequest, AsyncCallback, object) Initiates the asynchronous execution of the CreateDomain operation.
Public Method BeginDefineIndexField(DefineIndexFieldRequest, AsyncCallback, object) Initiates the asynchronous execution of the DefineIndexField operation.
Public Method BeginDefineRankExpression(DefineRankExpressionRequest, AsyncCallback, object) Initiates the asynchronous execution of the DefineRankExpression operation.
Public Method BeginDeleteDomain(DeleteDomainRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteDomain operation.
Public Method BeginDeleteIndexField(DeleteIndexFieldRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteIndexField operation.
Public Method BeginDeleteRankExpression(DeleteRankExpressionRequest, AsyncCallback, object) Initiates the asynchronous execution of the DeleteRankExpression operation.
Public Method BeginDescribeAvailabilityOptions(DescribeAvailabilityOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeAvailabilityOptions operation.
Public Method BeginDescribeDefaultSearchField(DescribeDefaultSearchFieldRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeDefaultSearchField operation.
Public Method BeginDescribeDomains(DescribeDomainsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeDomains operation.
Public Method BeginDescribeIndexFields(DescribeIndexFieldsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeIndexFields operation.
Public Method BeginDescribeRankExpressions(DescribeRankExpressionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeRankExpressions operation.
Public Method BeginDescribeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation.
Public Method BeginDescribeStemmingOptions(DescribeStemmingOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeStemmingOptions operation.
Public Method BeginDescribeStopwordOptions(DescribeStopwordOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeStopwordOptions operation.
Public Method BeginDescribeSynonymOptions(DescribeSynonymOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the DescribeSynonymOptions operation.
Public Method BeginIndexDocuments(IndexDocumentsRequest, AsyncCallback, object) Initiates the asynchronous execution of the IndexDocuments operation.
Public Method BeginUpdateAvailabilityOptions(UpdateAvailabilityOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateAvailabilityOptions operation.
Public Method BeginUpdateDefaultSearchField(UpdateDefaultSearchFieldRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateDefaultSearchField operation.
Public Method BeginUpdateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation.
Public Method BeginUpdateStemmingOptions(UpdateStemmingOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateStemmingOptions operation.
Public Method BeginUpdateStopwordOptions(UpdateStopwordOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateStopwordOptions operation.
Public Method BeginUpdateSynonymOptions(UpdateSynonymOptionsRequest, AsyncCallback, object) Initiates the asynchronous execution of the UpdateSynonymOptions operation.
Public Method CreateDomain(CreateDomainRequest) Creates a new search domain.
Public Method DefineIndexField(DefineIndexFieldRequest) Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.
Public Method DefineRankExpression(DefineRankExpressionRequest) Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.
Public Method DeleteDomain(DeleteDomainRequest) Permanently deletes a search domain and all of its data.
Public Method DeleteIndexField(DeleteIndexFieldRequest) Removes an IndexField from the search domain.
Public Method DeleteRankExpression(DeleteRankExpressionRequest) Removes a RankExpression from the search domain.
Public Method DescribeAvailabilityOptions(DescribeAvailabilityOptionsRequest) Gets the availability options configured for a domain. By default, shows the configuration with any pending changes. Set the Deployed option to true to show the active configuration and exclude pending changes. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
Public Method DescribeDefaultSearchField(DescribeDefaultSearchFieldRequest) Gets the default search field configured for the search domain.
Public Method DescribeDomains() Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.
Public Method DescribeDomains(DescribeDomainsRequest) Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.
Public Method DescribeIndexFields(DescribeIndexFieldsRequest) Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.
Public Method DescribeRankExpressions(DescribeRankExpressionsRequest) Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.
Public Method DescribeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest) Gets information about the resource-based policies that control access to the domain's document and search services.
Public Method DescribeStemmingOptions(DescribeStemmingOptionsRequest) Gets the stemming dictionary configured for the search domain.
Public Method DescribeStopwordOptions(DescribeStopwordOptionsRequest) Gets the stopwords configured for the search domain.
Public Method DescribeSynonymOptions(DescribeSynonymOptionsRequest) Gets the synonym dictionary configured for the search domain.
Public Method EndCreateDomain(IAsyncResult) Finishes the asynchronous execution of the CreateDomain operation.
Public Method EndDefineIndexField(IAsyncResult) Finishes the asynchronous execution of the DefineIndexField operation.
Public Method EndDefineRankExpression(IAsyncResult) Finishes the asynchronous execution of the DefineRankExpression operation.
Public Method EndDeleteDomain(IAsyncResult) Finishes the asynchronous execution of the DeleteDomain operation.
Public Method EndDeleteIndexField(IAsyncResult) Finishes the asynchronous execution of the DeleteIndexField operation.
Public Method EndDeleteRankExpression(IAsyncResult) Finishes the asynchronous execution of the DeleteRankExpression operation.
Public Method EndDescribeAvailabilityOptions(IAsyncResult) Finishes the asynchronous execution of the DescribeAvailabilityOptions operation.
Public Method EndDescribeDefaultSearchField(IAsyncResult) Finishes the asynchronous execution of the DescribeDefaultSearchField operation.
Public Method EndDescribeDomains(IAsyncResult) Finishes the asynchronous execution of the DescribeDomains operation.
Public Method EndDescribeIndexFields(IAsyncResult) Finishes the asynchronous execution of the DescribeIndexFields operation.
Public Method EndDescribeRankExpressions(IAsyncResult) Finishes the asynchronous execution of the DescribeRankExpressions operation.
Public Method EndDescribeServiceAccessPolicies(IAsyncResult) Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation.
Public Method EndDescribeStemmingOptions(IAsyncResult) Finishes the asynchronous execution of the DescribeStemmingOptions operation.
Public Method EndDescribeStopwordOptions(IAsyncResult) Finishes the asynchronous execution of the DescribeStopwordOptions operation.
Public Method EndDescribeSynonymOptions(IAsyncResult) Finishes the asynchronous execution of the DescribeSynonymOptions operation.
Public Method EndIndexDocuments(IAsyncResult) Finishes the asynchronous execution of the IndexDocuments operation.
Public Method EndUpdateAvailabilityOptions(IAsyncResult) Finishes the asynchronous execution of the UpdateAvailabilityOptions operation.
Public Method EndUpdateDefaultSearchField(IAsyncResult) Finishes the asynchronous execution of the UpdateDefaultSearchField operation.
Public Method EndUpdateServiceAccessPolicies(IAsyncResult) Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation.
Public Method EndUpdateStemmingOptions(IAsyncResult) Finishes the asynchronous execution of the UpdateStemmingOptions operation.
Public Method EndUpdateStopwordOptions(IAsyncResult) Finishes the asynchronous execution of the UpdateStopwordOptions operation.
Public Method EndUpdateSynonymOptions(IAsyncResult) Finishes the asynchronous execution of the UpdateSynonymOptions operation.
Public Method IndexDocuments(IndexDocumentsRequest) Tells the search domain to start indexing its documents using the latest text processing options and IndexFields. This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.
Public Method UpdateAvailabilityOptions(UpdateAvailabilityOptionsRequest) Configures the availability options for a domain. Enabling the Multi-AZ option expands an Amazon CloudSearch domain to an additional Availability Zone in the same Region to increase fault tolerance in the event of a service disruption. Changes to the Multi-AZ option can take about half an hour to become active. For more information, see Configuring Availability Options in the Amazon CloudSearch Developer Guide.
Public Method UpdateDefaultSearchField(UpdateDefaultSearchFieldRequest) Configures the default search field for the search domain. The default search field is the text field that is searched when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.
Public Method UpdateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest) Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100 KB.
Public Method UpdateStemmingOptions(UpdateStemmingOptionsRequest) Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500 KB.
Public Method UpdateStopwordOptions(UpdateStopwordOptionsRequest) Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10 KB.
Public Method UpdateSynonymOptions(UpdateSynonymOptionsRequest) Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100 KB.

Version Information

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