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 .
Declaration Syntax| C# |
public class AmazonCloudSearchClient : AmazonWebServiceClient, AmazonCloudSearch, IDisposable
Members| All Members | Constructors | Methods | Events | ||
| Icon | Member | Description |
|---|---|---|
 | AmazonCloudSearchClient()()()() |
Constructs AmazonCloudSearchClient 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.
 CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| AmazonCloudSearchClient(RegionEndpoint) |
Constructs AmazonCloudSearchClient 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.
CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| AmazonCloudSearchClient(AmazonCloudSearchConfig) |
Constructs AmazonCloudSearchClient 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.
CopyC#<?xml version="1.0" encoding="utf-8" ?> <configuration> <appSettings> <add key="AWSAccessKey" value="********************"/> <add key="AWSSecretKey" value="****************************************"/> </appSettings> </configuration> |
| AmazonCloudSearchClient(AWSCredentials) |
Constructs AmazonCloudSearchClient with AWS Credentials
|
| AmazonCloudSearchClient(AWSCredentials, RegionEndpoint) |
Constructs AmazonCloudSearchClient with AWS Credentials
|
| AmazonCloudSearchClient(AWSCredentials, AmazonCloudSearchConfig) |
Constructs AmazonCloudSearchClient with AWS Credentials and an
AmazonCloudSearchClient Configuration object.
|
| AmazonCloudSearchClient(String, String) |
Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key
|
| AmazonCloudSearchClient(String, String, RegionEndpoint) |
Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key
|
| AmazonCloudSearchClient(String, String, AmazonCloudSearchConfig) |
Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an
AmazonCloudSearchClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
|
| AmazonCloudSearchClient(String, String, String) |
Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key
|
| AmazonCloudSearchClient(String, String, String, RegionEndpoint) |
Constructs AmazonCloudSearchClient with AWS Access Key ID and AWS Secret Key
|
| AmazonCloudSearchClient(String, String, String, AmazonCloudSearchConfig) |
Constructs AmazonCloudSearchClient with AWS Access Key ID, AWS Secret Key and an
AmazonCloudSearchClient Configuration object. If the config object's
UseSecureStringForAwsSecretKey is false, the AWS Secret Key
is stored as a clear-text string. Please use this option only
if the application environment doesn't allow the use of SecureStrings.
|
 | AfterResponseEvent |
Occurs after a response is received from the service.
(Inherited from AmazonWebServiceClient.) |
| BeforeRequestEvent |
Occurs before a request is issued against the service.
(Inherited from AmazonWebServiceClient.) |
| BeginCreateDomain(CreateDomainRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the CreateDomain operation.
|
| BeginDefineIndexField(DefineIndexFieldRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DefineIndexField operation.
|
| BeginDefineRankExpression(DefineRankExpressionRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DefineRankExpression operation.
|
| BeginDeleteDomain(DeleteDomainRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteDomain operation.
|
| BeginDeleteIndexField(DeleteIndexFieldRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteIndexField operation.
|
| BeginDeleteRankExpression(DeleteRankExpressionRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DeleteRankExpression operation.
|
| BeginDescribeDefaultSearchField(DescribeDefaultSearchFieldRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDefaultSearchField operation.
|
| BeginDescribeDomains(DescribeDomainsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeDomains operation.
|
| BeginDescribeIndexFields(DescribeIndexFieldsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeIndexFields operation.
|
| BeginDescribeRankExpressions(DescribeRankExpressionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeRankExpressions operation.
|
| BeginDescribeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation.
|
| BeginDescribeStemmingOptions(DescribeStemmingOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeStemmingOptions operation.
|
| BeginDescribeStopwordOptions(DescribeStopwordOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeStopwordOptions operation.
|
| BeginDescribeSynonymOptions(DescribeSynonymOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the DescribeSynonymOptions operation.
|
| BeginIndexDocuments(IndexDocumentsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the IndexDocuments operation.
|
| BeginUpdateDefaultSearchField(UpdateDefaultSearchFieldRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateDefaultSearchField operation.
|
| BeginUpdateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation.
|
| BeginUpdateStemmingOptions(UpdateStemmingOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateStemmingOptions operation.
|
| BeginUpdateStopwordOptions(UpdateStopwordOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateStopwordOptions operation.
|
| BeginUpdateSynonymOptions(UpdateSynonymOptionsRequest, AsyncCallback, Object) |
Initiates the asynchronous execution of the UpdateSynonymOptions operation.
|
| CreateDomain(CreateDomainRequest) | Creates a new search domain. |
| 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. |
| 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. |
| DeleteDomain(DeleteDomainRequest) | Permanently deletes a search domain and all of its data. |
| DeleteIndexField(DeleteIndexFieldRequest) | Removes an IndexField from the search domain. |
| DeleteRankExpression(DeleteRankExpressionRequest) | Removes a RankExpression from the search domain. |
| DescribeDefaultSearchField(DescribeDefaultSearchFieldRequest) | Gets the default search field configured for the search domain. |
| DescribeDomains(DescribeDomainsRequest) | Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. |
| DescribeDomains()()()() | Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. |
| 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. |
| 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. |
| DescribeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest) | Gets information about the resource-based policies that control access to the domain's document and search services. |
| DescribeStemmingOptions(DescribeStemmingOptionsRequest) | Gets the stemming dictionary configured for the search domain. |
| DescribeStopwordOptions(DescribeStopwordOptionsRequest) | Gets the stopwords configured for the search domain. |
| DescribeSynonymOptions(DescribeSynonymOptionsRequest) | Gets the synonym dictionary configured for the search domain. |
| Dispose()()()() |
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.) |
| EndCreateDomain(IAsyncResult) |
Finishes the asynchronous execution of the CreateDomain operation.
|
| EndDefineIndexField(IAsyncResult) |
Finishes the asynchronous execution of the DefineIndexField operation.
|
| EndDefineRankExpression(IAsyncResult) |
Finishes the asynchronous execution of the DefineRankExpression operation.
|
| EndDeleteDomain(IAsyncResult) |
Finishes the asynchronous execution of the DeleteDomain operation.
|
| EndDeleteIndexField(IAsyncResult) |
Finishes the asynchronous execution of the DeleteIndexField operation.
|
| EndDeleteRankExpression(IAsyncResult) |
Finishes the asynchronous execution of the DeleteRankExpression operation.
|
| EndDescribeDefaultSearchField(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDefaultSearchField operation.
|
| EndDescribeDomains(IAsyncResult) |
Finishes the asynchronous execution of the DescribeDomains operation.
|
| EndDescribeIndexFields(IAsyncResult) |
Finishes the asynchronous execution of the DescribeIndexFields operation.
|
| EndDescribeRankExpressions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeRankExpressions operation.
|
| EndDescribeServiceAccessPolicies(IAsyncResult) |
Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation.
|
| EndDescribeStemmingOptions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeStemmingOptions operation.
|
| EndDescribeStopwordOptions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeStopwordOptions operation.
|
| EndDescribeSynonymOptions(IAsyncResult) |
Finishes the asynchronous execution of the DescribeSynonymOptions operation.
|
| EndIndexDocuments(IAsyncResult) |
Finishes the asynchronous execution of the IndexDocuments operation.
|
| EndUpdateDefaultSearchField(IAsyncResult) |
Finishes the asynchronous execution of the UpdateDefaultSearchField operation.
|
| EndUpdateServiceAccessPolicies(IAsyncResult) |
Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation.
|
| EndUpdateStemmingOptions(IAsyncResult) |
Finishes the asynchronous execution of the UpdateStemmingOptions operation.
|
| EndUpdateStopwordOptions(IAsyncResult) |
Finishes the asynchronous execution of the UpdateStopwordOptions operation.
|
| EndUpdateSynonymOptions(IAsyncResult) |
Finishes the asynchronous execution of the UpdateSynonymOptions operation.
|
| Equals(Object) | (Inherited from Object.) |
| ExceptionEvent |
Occurs after an exception is encountered.
(Inherited from AmazonWebServiceClient.) |
| GetHashCode()()()() | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType()()()() | Gets the type of the current instance. (Inherited from Object.) |
| 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. |
| ToString()()()() | Returns a string that represents the current object. (Inherited from Object.) |
| 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. |
| 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. |
| 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. |
| 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. |
| 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. |
Inheritance Hierarchy| Object | ||
 | AmazonWebServiceClient | |
| AmazonCloudSearchClient | |