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 CloudSearch
Amazon CloudSearch Configuration ServiceYou 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.
Namespace: Amazon.CloudSearch
Assembly: AWSSDK.CloudSearch.dll
Version: 3.x.y.z
public class AmazonCloudSearchClient : AmazonServiceClient IAmazonCloudSearch, IAmazonService, IDisposable
The AmazonCloudSearchClient type exposes the following members
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. |
Name | Type | Description | |
---|---|---|---|
Config | Amazon.Runtime.IClientConfig | Inherited from Amazon.Runtime.AmazonServiceClient. |
Name | Description | |
---|---|---|
BuildSuggesters(BuildSuggestersRequest) |
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide. |
|
BuildSuggestersAsync(BuildSuggestersRequest, CancellationToken) |
Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide. |
|
CreateDomain(CreateDomainRequest) |
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide. |
|
CreateDomainAsync(CreateDomainRequest, CancellationToken) |
Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide. |
|
DefineAnalysisScheme(DefineAnalysisSchemeRequest) |
Configures an analysis scheme that can be applied to a |
|
DefineAnalysisSchemeAsync(DefineAnalysisSchemeRequest, CancellationToken) |
Configures an analysis scheme that can be applied to a |
|
DefineExpression(DefineExpressionRequest) |
Configures an |
|
DefineExpressionAsync(DefineExpressionRequest, CancellationToken) |
Configures an |
|
DefineIndexField(DefineIndexFieldRequest) |
Configures an |
|
DefineIndexFieldAsync(DefineIndexFieldRequest, CancellationToken) |
Configures an |
|
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) |
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. |
|
DeleteAnalysisScheme(DeleteAnalysisSchemeRequest) |
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. |
|
DeleteAnalysisSchemeAsync(DeleteAnalysisSchemeRequest, CancellationToken) |
Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide. |
|
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) |
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. |
|
DeleteExpression(DeleteExpressionRequest) |
Removes an |
|
DeleteExpressionAsync(DeleteExpressionRequest, CancellationToken) |
Removes an |
|
DeleteIndexField(DeleteIndexFieldRequest) |
Removes an |
|
DeleteIndexFieldAsync(DeleteIndexFieldRequest, CancellationToken) |
Removes an |
|
DeleteSuggester(DeleteSuggesterRequest) |
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. |
|
DeleteSuggesterAsync(DeleteSuggesterRequest, CancellationToken) |
Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide. |
|
DescribeAnalysisSchemes(DescribeAnalysisSchemesRequest) |
Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific
text processing options for a |
|
DescribeAnalysisSchemesAsync(DescribeAnalysisSchemesRequest, CancellationToken) |
Gets the analysis schemes configured for a domain. An analysis scheme defines language-specific
text processing options for a |
|
DescribeAvailabilityOptions(DescribeAvailabilityOptionsRequest) |
Gets the availability options configured for a domain. By default, shows the configuration
with any pending changes. Set the |
|
DescribeAvailabilityOptionsAsync(DescribeAvailabilityOptionsRequest, CancellationToken) |
Gets the availability options configured for a domain. By default, shows the configuration
with any pending changes. Set the |
|
DescribeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest) |
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide. |
|
DescribeDomainEndpointOptionsAsync(DescribeDomainEndpointOptionsRequest, CancellationToken) |
Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide. |
|
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 |
|
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 |
|
DescribeDomainsAsync(CancellationToken) |
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 |
|
DescribeDomainsAsync(DescribeDomainsRequest, CancellationToken) |
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 |
|
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 |
|
DescribeExpressionsAsync(DescribeExpressionsRequest, CancellationToken) |
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 |
|
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 |
|
DescribeIndexFieldsAsync(DescribeIndexFieldsRequest, CancellationToken) |
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 |
|
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) |
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. |
|
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 |
|
DescribeServiceAccessPoliciesAsync(DescribeServiceAccessPoliciesRequest, CancellationToken) |
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 |
|
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 |
|
DescribeSuggestersAsync(DescribeSuggestersRequest, CancellationToken) |
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 |
|
DetermineServiceOperationEndpoint(AmazonWebServiceRequest) |
Returns the endpoint that will be used for a particular request. |
|
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 |
|
IndexDocumentsAsync(IndexDocumentsRequest, CancellationToken) |
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 |
|
ListDomainNames() |
Lists all search domains owned by an account. |
|
ListDomainNames(ListDomainNamesRequest) |
Lists all search domains owned by an account. |
|
ListDomainNamesAsync(CancellationToken) |
Lists all search domains owned by an account. |
|
ListDomainNamesAsync(ListDomainNamesRequest, CancellationToken) |
Lists all search domains owned by an account. |
|
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) |
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. |
|
UpdateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest) |
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide. |
|
UpdateDomainEndpointOptionsAsync(UpdateDomainEndpointOptionsRequest, CancellationToken) |
Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide. |
|
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) |
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. |
|
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) |
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. |
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