Implementation 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
System.Object
Amazon.Runtime.AmazonServiceClient
Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient
Amazon.Runtime.AmazonServiceClient
Amazon.CloudSearch_2011_02_01.AmazonCloudSearchClient
Namespace: Amazon.CloudSearch_2011_02_01
Assembly: AWSSDK.dll
Version: (assembly version)
Syntax
public class AmazonCloudSearchClient : AmazonServiceClient IAmazonCloudSearch, IDisposable
The AmazonCloudSearchClient type exposes the following members
Constructors
| Name | 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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</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.
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<appSettings>
<add key="AWSProfileName" value="AWS Default"/>
</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. |
|
|
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. |
Methods
| Name | Description | |
|---|---|---|
|
|
CreateDomain(CreateDomainRequest) | Creates a new search domain. |
|
|
CreateDomainAsync(CreateDomainRequest, CancellationToken) | Initiates the asynchronous execution of the CreateDomain operation. |
|
|
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.
|
|
|
DefineIndexFieldAsync(DefineIndexFieldRequest, CancellationToken) | Initiates the asynchronous execution of the DefineIndexField operation. |
|
|
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.
|
|
|
DefineRankExpressionAsync(DefineRankExpressionRequest, CancellationToken) | Initiates the asynchronous execution of the DefineRankExpression operation. |
|
|
DeleteDomain(DeleteDomainRequest) | Permanently deletes a search domain and all of its data. |
|
|
DeleteDomainAsync(DeleteDomainRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteDomain operation. |
|
|
DeleteIndexField(DeleteIndexFieldRequest) |
Removes an IndexField from the search domain.
|
|
|
DeleteIndexFieldAsync(DeleteIndexFieldRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteIndexField operation. |
|
|
DeleteRankExpression(DeleteRankExpressionRequest) |
Removes a RankExpression from the search domain.
|
|
|
DeleteRankExpressionAsync(DeleteRankExpressionRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteRankExpression operation. |
|
|
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.
|
|
|
DescribeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeAvailabilityOptions operation. |
|
|
DescribeDefaultSearchField(DescribeDefaultSearchFieldRequest) | Gets the default search field configured for the search domain. |
|
|
DescribeDefaultSearchFieldAsync(DescribeDefaultSearchFieldRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDefaultSearchField operation. |
|
|
DescribeDomains() | Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. |
|
|
DescribeDomains(DescribeDomainsRequest) | Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. |
|
|
DescribeDomainsAsync(DescribeDomainsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDomains operation. |
|
|
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. |
|
|
DescribeIndexFieldsAsync(DescribeIndexFieldsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeIndexFields operation. |
|
|
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. |
|
|
DescribeRankExpressionsAsync(DescribeRankExpressionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeRankExpressions operation. |
|
|
DescribeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest) | Gets information about the resource-based policies that control access to the domain's document and search services. |
|
|
DescribeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. |
|
|
DescribeStemmingOptions(DescribeStemmingOptionsRequest) | Gets the stemming dictionary configured for the search domain. |
|
|
DescribeStemmingOptionsAsync(DescribeStemmingOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeStemmingOptions operation. |
|
|
DescribeStopwordOptions(DescribeStopwordOptionsRequest) | Gets the stopwords configured for the search domain. |
|
|
DescribeStopwordOptionsAsync(DescribeStopwordOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeStopwordOptions operation. |
|
|
DescribeSynonymOptions(DescribeSynonymOptionsRequest) | Gets the synonym dictionary configured for the search domain. |
|
|
DescribeSynonymOptionsAsync(DescribeSynonymOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeSynonymOptions operation. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
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.
|
|
|
IndexDocumentsAsync(IndexDocumentsRequest, CancellationToken) | Initiates the asynchronous execution of the IndexDocuments operation. |
|
|
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. |
|
|
UpdateAvailabilityOptionsAsync(UpdateAvailabilityOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateAvailabilityOptions operation. |
|
|
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. |
|
|
UpdateDefaultSearchFieldAsync(UpdateDefaultSearchFieldRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateDefaultSearchField operation. |
|
|
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. |
|
|
UpdateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation. |
|
|
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. |
|
|
UpdateStemmingOptionsAsync(UpdateStemmingOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateStemmingOptions operation. |
|
|
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. |
|
|
UpdateStopwordOptionsAsync(UpdateStopwordOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateStopwordOptions operation. |
|
|
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. |
|
|
UpdateSynonymOptionsAsync(UpdateSynonymOptionsRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateSynonymOptions operation. |
Events
| Name | Description | |
|---|---|---|
|
|
AfterResponseEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
BeforeRequestEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
ExceptionEvent | Inherited from Amazon.Runtime.AmazonServiceClient. |
Version Information
.NET Framework:
Supported in: 4.5, 4.0, 3.5