AWS SDK for .NET Documentation
AmazonCloudSearchClient Class
AmazonAmazon.CloudSearchAmazonCloudSearchClient Did this page help you?   Yes   No    Tell us about it...
Implementation for accessing AmazonCloudSearch. 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 .

Declaration Syntax
C#
public class AmazonCloudSearchClient : AmazonWebServiceClient, 
	AmazonCloudSearch, IDisposable
Members
All MembersConstructorsMethodsEvents



IconMemberDescription
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.)
BeginBuildSuggesters(BuildSuggestersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the BuildSuggesters operation.

BeginCreateDomain(CreateDomainRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the CreateDomain operation.

BeginDefineAnalysisScheme(DefineAnalysisSchemeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DefineAnalysisScheme operation.

BeginDefineExpression(DefineExpressionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DefineExpression operation.

BeginDefineIndexField(DefineIndexFieldRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DefineIndexField operation.

BeginDefineSuggester(DefineSuggesterRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DefineSuggester operation.

BeginDeleteAnalysisScheme(DeleteAnalysisSchemeRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteAnalysisScheme operation.

BeginDeleteDomain(DeleteDomainRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteDomain operation.

BeginDeleteExpression(DeleteExpressionRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteExpression operation.

BeginDeleteIndexField(DeleteIndexFieldRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteIndexField operation.

BeginDeleteSuggester(DeleteSuggesterRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DeleteSuggester operation.

BeginDescribeAnalysisSchemes(DescribeAnalysisSchemesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeAnalysisSchemes operation.

BeginDescribeAvailabilityOptions(DescribeAvailabilityOptionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeAvailabilityOptions operation.

BeginDescribeDomains(DescribeDomainsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeDomains operation.

BeginDescribeExpressions(DescribeExpressionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeExpressions operation.

BeginDescribeIndexFields(DescribeIndexFieldsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeIndexFields operation.

BeginDescribeScalingParameters(DescribeScalingParametersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeScalingParameters operation.

BeginDescribeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeServiceAccessPolicies operation.

BeginDescribeSuggesters(DescribeSuggestersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the DescribeSuggesters operation.

BeginIndexDocuments(IndexDocumentsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the IndexDocuments operation.

BeginListDomainNames(ListDomainNamesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the ListDomainNames operation.

BeginUpdateAvailabilityOptions(UpdateAvailabilityOptionsRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateAvailabilityOptions operation.

BeginUpdateScalingParameters(UpdateScalingParametersRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateScalingParameters operation.

BeginUpdateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest, AsyncCallback, Object)
Initiates the asynchronous execution of the UpdateServiceAccessPolicies operation.

BuildSuggesters(BuildSuggestersRequest)

Indexes the search suggestions.


CreateDomain(CreateDomainRequest)

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 for a domain. An analysis scheme defines language-specific text processing options for a text field. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .


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 .


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 .


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 .


DeleteAnalysisScheme(DeleteAnalysisSchemeRequest)

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 .


DeleteExpression(DeleteExpressionRequest)

Removes an Expression from the search domain. For more information, see Configuring Expressions in the Amazon CloudSearch Developer Guide .


DeleteIndexField(DeleteIndexFieldRequest)

Removes an IndexField from the search domain. For more information, see Configuring Index Fields in the Amazon CloudSearch Developer Guide .


DeleteSuggester(DeleteSuggesterRequest)

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 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 .


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 .


DescribeDomains(DescribeDomainsRequest)

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. For more information, see Getting Information about a Search Domain 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. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide .


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 .


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 .


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 .


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 .


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 .


Dispose()()()()
Disposes of all managed and unmanaged resources.
(Inherited from AmazonWebServiceClient.)
EndBuildSuggesters(IAsyncResult)
Finishes the asynchronous execution of the BuildSuggesters operation.

EndCreateDomain(IAsyncResult)
Finishes the asynchronous execution of the CreateDomain operation.

EndDefineAnalysisScheme(IAsyncResult)
Finishes the asynchronous execution of the DefineAnalysisScheme operation.

EndDefineExpression(IAsyncResult)
Finishes the asynchronous execution of the DefineExpression operation.

EndDefineIndexField(IAsyncResult)
Finishes the asynchronous execution of the DefineIndexField operation.

EndDefineSuggester(IAsyncResult)
Finishes the asynchronous execution of the DefineSuggester operation.

EndDeleteAnalysisScheme(IAsyncResult)
Finishes the asynchronous execution of the DeleteAnalysisScheme operation.

EndDeleteDomain(IAsyncResult)
Finishes the asynchronous execution of the DeleteDomain operation.

EndDeleteExpression(IAsyncResult)
Finishes the asynchronous execution of the DeleteExpression operation.

EndDeleteIndexField(IAsyncResult)
Finishes the asynchronous execution of the DeleteIndexField operation.

EndDeleteSuggester(IAsyncResult)
Finishes the asynchronous execution of the DeleteSuggester operation.

EndDescribeAnalysisSchemes(IAsyncResult)
Finishes the asynchronous execution of the DescribeAnalysisSchemes operation.

EndDescribeAvailabilityOptions(IAsyncResult)
Finishes the asynchronous execution of the DescribeAvailabilityOptions operation.

EndDescribeDomains(IAsyncResult)
Finishes the asynchronous execution of the DescribeDomains operation.

EndDescribeExpressions(IAsyncResult)
Finishes the asynchronous execution of the DescribeExpressions operation.

EndDescribeIndexFields(IAsyncResult)
Finishes the asynchronous execution of the DescribeIndexFields operation.

EndDescribeScalingParameters(IAsyncResult)
Finishes the asynchronous execution of the DescribeScalingParameters operation.

EndDescribeServiceAccessPolicies(IAsyncResult)
Finishes the asynchronous execution of the DescribeServiceAccessPolicies operation.

EndDescribeSuggesters(IAsyncResult)
Finishes the asynchronous execution of the DescribeSuggesters operation.

EndIndexDocuments(IAsyncResult)
Finishes the asynchronous execution of the IndexDocuments operation.

EndListDomainNames(IAsyncResult)
Finishes the asynchronous execution of the ListDomainNames operation.

EndUpdateAvailabilityOptions(IAsyncResult)
Finishes the asynchronous execution of the UpdateAvailabilityOptions operation.

EndUpdateScalingParameters(IAsyncResult)
Finishes the asynchronous execution of the UpdateScalingParameters operation.

EndUpdateServiceAccessPolicies(IAsyncResult)
Finishes the asynchronous execution of the UpdateServiceAccessPolicies operation.

Equals(Object)
Determines whether the specified Object is equal to the current 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 indexing options. This operation must be invoked to activate options whose OptionStatus is RequiresIndexDocuments .


ListDomainNames(ListDomainNamesRequest)

Lists all search domains owned by an account.


ListDomainNames()()()()

Lists all search domains owned by an account.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
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 .


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 .


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 .


Inheritance Hierarchy
Object
AmazonWebServiceClient
 AmazonCloudSearchClient

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)