Implementation for accessing CloudSearch
Amazon CloudSearch Configuration Service
You use the Amazon CloudSearch 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
Namespace: Amazon.CloudSearch
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 | |
|---|---|---|
|
|
BuildSuggesters(BuildSuggestersRequest) | Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide. |
|
|
BuildSuggestersAsync(BuildSuggestersRequest, CancellationToken) | Initiates the asynchronous execution of the BuildSuggesters operation. |
|
|
CreateDomain(CreateDomainRequest) | Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide. |
|
|
CreateDomainAsync(CreateDomainRequest, CancellationToken) | Initiates the asynchronous execution of the CreateDomain operation. |
|
|
DefineAnalysisScheme(DefineAnalysisSchemeRequest) |
Configures an analysis scheme that can be applied to a text or text-array
field to define language-specific text processing options. For more information, see
Configuring Analysis Schemes in the Amazon CloudSearch Developer
Guide.
|
|
|
DefineAnalysisSchemeAsync(DefineAnalysisSchemeRequest, CancellationToken) | Initiates the asynchronous execution of the DefineAnalysisScheme operation. |
|
|
DefineExpression(DefineExpressionRequest) |
Configures an Expression for the search domain. Used to create
new expressions and modify existing ones. If the expression exists, the new configuration
replaces the old one. For more information, see Configuring Expressions in the Amazon CloudSearch Developer
Guide.
|
|
|
DefineExpressionAsync(DefineExpressionRequest, CancellationToken) | Initiates the asynchronous execution of the DefineExpression operation. |
|
|
DefineIndexField(DefineIndexFieldRequest) |
Configures an IndexField for the search domain. Used to create
new fields and modify existing ones. You must specify the name of the domain you are
configuring and an index field configuration. The index field configuration specifies
a unique name, the index field type, and the options you want to configure for the
field. The options you can specify depend on the IndexFieldType.
If the field exists, the new configuration replaces the old one. For more information,
see Configuring Index Fields in the Amazon CloudSearch Developer
Guide.
|
|
|
DefineIndexFieldAsync(DefineIndexFieldRequest, CancellationToken) | Initiates the asynchronous execution of the DefineIndexField operation. |
|
|
DefineSuggester(DefineSuggesterRequest) | Configures a suggester for a domain. A suggester enables you to display possible matches before users finish typing their queries. When you configure a suggester, you must specify the name of the text field you want to search for possible matches and a unique name for the suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. |
|
|
DefineSuggesterAsync(DefineSuggesterRequest, CancellationToken) | Initiates the asynchronous execution of the DefineSuggester operation. |
|
|
DeleteAnalysisScheme(DeleteAnalysisSchemeRequest) | Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. |
|
|
DeleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteAnalysisScheme operation. |
|
|
DeleteDomain(DeleteDomainRequest) | Permanently deletes a search domain and all of its data. Once a domain has been deleted, it cannot be recovered. For more information, see Deleting a Search Domain in the Amazon CloudSearch Developer Guide. |
|
|
DeleteDomainAsync(DeleteDomainRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteDomain operation. |
|
|
DeleteExpression(DeleteExpressionRequest) |
Removes an Expression from the search domain. For more information,
see Configuring Expressions in the Amazon CloudSearch Developer
Guide.
|
|
|
DeleteExpressionAsync(DeleteExpressionRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteExpression operation. |
|
|
DeleteIndexField(DeleteIndexFieldRequest) |
Removes an IndexField from the search domain. For more information,
see Configuring Index Fields in the Amazon CloudSearch Developer
Guide.
|
|
|
DeleteIndexFieldAsync(DeleteIndexFieldRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteIndexField operation. |
|
|
DeleteSuggester(DeleteSuggesterRequest) | Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. |
|
|
DeleteSuggesterAsync(DeleteSuggesterRequest, CancellationToken) | Initiates the asynchronous execution of the DeleteSuggester operation. |
|
|
DescribeAnalysisSchemes(DescribeAnalysisSchemesRequest) |
Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific
text processing options for a text field. Can be limited to specific
analysis schemes by name. By default, shows all analysis schemes and includes any
pending changes to the configuration. Set the Deployed option to true
to show the active configuration and exclude pending changes. For more information,
see Configuring Analysis Schemes in the Amazon CloudSearch Developer
Guide.
|
|
|
DescribeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeAnalysisSchemes 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. |
|
|
DescribeDomains() |
Gets information about the search domains owned by this account. Can be limited to
specific domains. Shows all domains by default. To get the number of searchable documents
in a domain, use the console or submit a matchall request to your domain's
search endpoint: q=matchall&q.parser=structured&size=0.
For more information, see Getting Information about a Search Domain in the Amazon CloudSearch
Developer Guide.
|
|
|
DescribeDomains(DescribeDomainsRequest) |
Gets information about the search domains owned by this account. Can be limited to
specific domains. Shows all domains by default. To get the number of searchable documents
in a domain, use the console or submit a matchall request to your domain's
search endpoint: q=matchall&q.parser=structured&size=0.
For more information, see Getting Information about a Search Domain in the Amazon CloudSearch
Developer Guide.
|
|
|
DescribeDomainsAsync(DescribeDomainsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeDomains operation. |
|
|
DescribeExpressions(DescribeExpressionsRequest) |
Gets the expressions configured for the search domain. Can be limited to specific
expressions by name. By default, shows all expressions and includes any pending changes
to the configuration. Set the Deployed option to true to
show the active configuration and exclude pending changes. For more information, see
Configuring Expressions in the Amazon CloudSearch Developer
Guide.
|
|
|
DescribeExpressionsAsync(DescribeExpressionsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeExpressions operation. |
|
|
DescribeIndexFields(DescribeIndexFieldsRequest) |
Gets information about the index fields configured for the search domain. Can be limited
to specific fields by name. By default, shows all fields and includes any pending
changes to the configuration. Set the Deployed option to true
to show the active configuration and exclude pending changes. For more information,
see Getting Domain Information in the Amazon CloudSearch Developer
Guide.
|
|
|
DescribeIndexFieldsAsync(DescribeIndexFieldsRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeIndexFields operation. |
|
|
DescribeScalingParameters(DescribeScalingParametersRequest) | Gets the scaling parameters configured for a domain. A domain's scaling parameters specify the desired search instance type and replication count. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. |
|
|
DescribeScalingParametersAsync(DescribeScalingParametersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeScalingParameters operation. |
|
|
DescribeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest) |
Gets information about the access policies that control access to the domain's document
and search endpoints. 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 Access for a Search Domain in the Amazon CloudSearch
Developer Guide.
|
|
|
DescribeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation. |
|
|
DescribeSuggesters(DescribeSuggestersRequest) |
Gets the suggesters configured for a domain. A suggester enables you to display possible
matches before users finish typing their queries. Can be limited to specific suggesters
by name. By default, shows all suggesters and includes any pending changes to the
configuration. Set the Deployed option to true to show the
active configuration and exclude pending changes. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer
Guide.
|
|
|
DescribeSuggestersAsync(DescribeSuggestersRequest, CancellationToken) | Initiates the asynchronous execution of the DescribeSuggesters operation. |
|
|
Dispose() | Inherited from Amazon.Runtime.AmazonServiceClient. |
|
|
IndexDocuments(IndexDocumentsRequest) |
Tells the search domain to start indexing its documents using the latest indexing
options. This operation must be invoked to activate options whose OptionStatus
is RequiresIndexDocuments.
|
|
|
IndexDocumentsAsync(IndexDocumentsRequest, CancellationToken) | Initiates the asynchronous execution of the IndexDocuments operation. |
|
|
ListDomainNames() | Lists all search domains owned by an account. |
|
|
ListDomainNames(ListDomainNamesRequest) | Lists all search domains owned by an account. |
|
|
ListDomainNamesAsync(ListDomainNamesRequest, CancellationToken) | Initiates the asynchronous execution of the ListDomainNames 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. |
|
|
UpdateScalingParameters(UpdateScalingParametersRequest) | Configures scaling parameters for a domain. A domain's scaling parameters specify the desired search instance type and replication count. Amazon CloudSearch will still automatically scale your domain based on the volume of data and traffic, but not below the desired instance type and replication count. If the Multi-AZ option is enabled, these values control the resources used per Availability Zone. For more information, see Configuring Scaling Options in the Amazon CloudSearch Developer Guide. |
|
|
UpdateScalingParametersAsync(UpdateScalingParametersRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateScalingParameters operation. |
|
|
UpdateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest) | Configures the access rules that control access to the domain's document and search endpoints. For more information, see Configuring Access for an Amazon CloudSearch Domain. |
|
|
UpdateServiceAccessPoliciesAsync(UpdateServiceAccessPoliciesRequest, CancellationToken) | Initiates the asynchronous execution of the UpdateServiceAccessPolicies 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
.NET for Windows Store apps:
Supported in: Windows 8