com.amazonaws.services.cloudsearch

Interface AmazonCloudSearch

All Known Subinterfaces:

AmazonCloudSearchAsync

All Known Implementing Classes:

AmazonCloudSearchAsyncClient, AmazonCloudSearchClient

Deprecated.

This code uses the older version of Amazon Cloud Search API (2011-02-01) and hence deprecated. The code in the package com.amazonaws.services.cloudsearchv2 uses the latest version of Amazon Cloud Search API.Use AmazonCloudSearch instead.

@Deprecated
public interface AmazonCloudSearch

Interface for accessing AmazonCloudSearch. 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 .

Method Summary

Methods

Modifier and Type	Method and Description
CreateDomainResult	createDomain(CreateDomainRequest createDomainRequest) Deprecated. Creates a new search domain.
DefineIndexFieldResult	defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest) Deprecated. Configures an IndexField for the search domain.
DefineRankExpressionResult	defineRankExpression(DefineRankExpressionRequest defineRankExpressionRequest) Deprecated. Configures a RankExpression for the search domain.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Deprecated. Permanently deletes a search domain and all of its data.
DeleteIndexFieldResult	deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest) Deprecated. Removes an IndexField from the search domain.
DeleteRankExpressionResult	deleteRankExpression(DeleteRankExpressionRequest deleteRankExpressionRequest) Deprecated. Removes a RankExpression from the search domain.
DescribeAvailabilityOptionsResult	describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) Deprecated. Gets the availability options configured for a domain.
DescribeDefaultSearchFieldResult	describeDefaultSearchField(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest) Deprecated. Gets the default search field configured for the search domain.
DescribeDomainsResult	describeDomains() Deprecated. Gets information about the search domains owned by this account.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest describeDomainsRequest) Deprecated. Gets information about the search domains owned by this account.
DescribeIndexFieldsResult	describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest) Deprecated. Gets information about the index fields configured for the search domain.
DescribeRankExpressionsResult	describeRankExpressions(DescribeRankExpressionsRequest describeRankExpressionsRequest) Deprecated. Gets the rank expressions configured for the search domain.
DescribeServiceAccessPoliciesResult	describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) Deprecated. Gets information about the resource-based policies that control access to the domain's document and search services.
DescribeStemmingOptionsResult	describeStemmingOptions(DescribeStemmingOptionsRequest describeStemmingOptionsRequest) Deprecated. Gets the stemming dictionary configured for the search domain.
DescribeStopwordOptionsResult	describeStopwordOptions(DescribeStopwordOptionsRequest describeStopwordOptionsRequest) Deprecated. Gets the stopwords configured for the search domain.
DescribeSynonymOptionsResult	describeSynonymOptions(DescribeSynonymOptionsRequest describeSynonymOptionsRequest) Deprecated. Gets the synonym dictionary configured for the search domain.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Deprecated. Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
IndexDocumentsResult	indexDocuments(IndexDocumentsRequest indexDocumentsRequest) Deprecated. Tells the search domain to start indexing its documents using the latest text processing options and IndexFields .
void	setEndpoint(String endpoint) Deprecated. Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/").
void	setRegion(Region region) Deprecated. An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Deprecated. Shuts down this client object, releasing any resources that might be held open.
UpdateAvailabilityOptionsResult	updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) Deprecated. Configures the availability options for a domain.
UpdateDefaultSearchFieldResult	updateDefaultSearchField(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest) Deprecated. Configures the default search field for the search domain.
UpdateServiceAccessPoliciesResult	updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) Deprecated. Configures the policies that control access to the domain's document and search services.
UpdateStemmingOptionsResult	updateStemmingOptions(UpdateStemmingOptionsRequest updateStemmingOptionsRequest) Deprecated. Configures a stemming dictionary for the search domain.
UpdateStopwordOptionsResult	updateStopwordOptions(UpdateStopwordOptionsRequest updateStopwordOptionsRequest) Deprecated. Configures stopwords for the search domain.
UpdateSynonymOptionsResult	updateSynonymOptions(UpdateSynonymOptionsRequest updateSynonymOptionsRequest) Deprecated. Configures a synonym dictionary for the search domain.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

Deprecated.

Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/"). Callers can use this method to control which AWS region they want to work with.

Callers can pass in just the endpoint (ex: "cloudsearch.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudsearch.us-east-1.amazonaws.com/"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.

For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912

This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

endpoint - The endpoint (ex: "cloudsearch.us-east-1.amazonaws.com/") or a full URL, including the protocol (ex: "https://cloudsearch.us-east-1.amazonaws.com/") of the region specific AWS endpoint this client will communicate with.

Throws:

IllegalArgumentException - If any problems are detected with the specified endpoint.

setRegion

void setRegion(Region region)
               throws IllegalArgumentException

Deprecated.

An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.

By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the ClientConfiguration supplied at construction.

This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.

Parameters:

region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region.

Throws:

IllegalArgumentException - If the given region is null, or if this service isn't available in the given region. See Region.isServiceSupported(String)

See Also:

Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)

updateDefaultSearchField

UpdateDefaultSearchFieldResult updateDefaultSearchField(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Deprecated.

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.

Parameters:

updateDefaultSearchFieldRequest - Container for the necessary parameters to execute the UpdateDefaultSearchField service method on AmazonCloudSearch.

Returns:

The response from the UpdateDefaultSearchField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

deleteRankExpression

DeleteRankExpressionResult deleteRankExpression(DeleteRankExpressionRequest deleteRankExpressionRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Deprecated.

Removes a RankExpression from the search domain.

Parameters:

deleteRankExpressionRequest - Container for the necessary parameters to execute the DeleteRankExpression service method on AmazonCloudSearch.

Returns:

The response from the DeleteRankExpression service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeRankExpressions

DescribeRankExpressionsResult describeRankExpressions(DescribeRankExpressionsRequest describeRankExpressionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Deprecated.

Gets the rank expressions configured for the search domain. Can be limited to specific rank expressions by name. Shows all rank expressions by default.

Parameters:

describeRankExpressionsRequest - Container for the necessary parameters to execute the DescribeRankExpressions service method on AmazonCloudSearch.

Returns:

The response from the DescribeRankExpressions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

createDomain

CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Deprecated.

Creates a new search domain.

Parameters:

createDomainRequest - Container for the necessary parameters to execute the CreateDomain service method on AmazonCloudSearch.

Returns:

The response from the CreateDomain service method, as returned by AmazonCloudSearch.

Throws:

BaseException

LimitExceededException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateServiceAccessPolicies

UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Deprecated.

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.

Parameters:

updateServiceAccessPoliciesRequest - Container for the necessary parameters to execute the UpdateServiceAccessPolicies service method on AmazonCloudSearch.

Returns:

The response from the UpdateServiceAccessPolicies service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

defineIndexField

DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deprecated.

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.

Parameters:

defineIndexFieldRequest - Container for the necessary parameters to execute the DefineIndexField service method on AmazonCloudSearch.

Returns:

The response from the DefineIndexField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

defineRankExpression

DefineRankExpressionResult defineRankExpression(DefineRankExpressionRequest defineRankExpressionRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Deprecated.

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.

Parameters:

defineRankExpressionRequest - Container for the necessary parameters to execute the DefineRankExpression service method on AmazonCloudSearch.

Returns:

The response from the DefineRankExpression service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeSynonymOptions

DescribeSynonymOptionsResult describeSynonymOptions(DescribeSynonymOptionsRequest describeSynonymOptionsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Deprecated.

Gets the synonym dictionary configured for the search domain.

Parameters:

describeSynonymOptionsRequest - Container for the necessary parameters to execute the DescribeSynonymOptions service method on AmazonCloudSearch.

Returns:

The response from the DescribeSynonymOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeStopwordOptions

DescribeStopwordOptionsResult describeStopwordOptions(DescribeStopwordOptionsRequest describeStopwordOptionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Deprecated.

Gets the stopwords configured for the search domain.

Parameters:

describeStopwordOptionsRequest - Container for the necessary parameters to execute the DescribeStopwordOptions service method on AmazonCloudSearch.

Returns:

The response from the DescribeStopwordOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

deleteDomain

DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Deprecated.

Permanently deletes a search domain and all of its data.

Parameters:

deleteDomainRequest - Container for the necessary parameters to execute the DeleteDomain service method on AmazonCloudSearch.

Returns:

The response from the DeleteDomain service method, as returned by AmazonCloudSearch.

Throws:

BaseException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeServiceAccessPolicies

DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

Deprecated.

Gets information about the resource-based policies that control access to the domain's document and search services.

Parameters:

describeServiceAccessPoliciesRequest - Container for the necessary parameters to execute the DescribeServiceAccessPolicies service method on AmazonCloudSearch.

Returns:

The response from the DescribeServiceAccessPolicies service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateAvailabilityOptions

UpdateAvailabilityOptionsResult updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

Deprecated.

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 .

Parameters:

updateAvailabilityOptionsRequest - Container for the necessary parameters to execute the UpdateAvailabilityOptions service method on AmazonCloudSearch.

Returns:

The response from the UpdateAvailabilityOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

DisabledOperationException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeDefaultSearchField

DescribeDefaultSearchFieldResult describeDefaultSearchField(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Deprecated.

Gets the default search field configured for the search domain.

Parameters:

describeDefaultSearchFieldRequest - Container for the necessary parameters to execute the DescribeDefaultSearchField service method on AmazonCloudSearch.

Returns:

The response from the DescribeDefaultSearchField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateStopwordOptions

UpdateStopwordOptionsResult updateStopwordOptions(UpdateStopwordOptionsRequest updateStopwordOptionsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Deprecated.

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.

Parameters:

updateStopwordOptionsRequest - Container for the necessary parameters to execute the UpdateStopwordOptions service method on AmazonCloudSearch.

Returns:

The response from the UpdateStopwordOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateSynonymOptions

UpdateSynonymOptionsResult updateSynonymOptions(UpdateSynonymOptionsRequest updateSynonymOptionsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Deprecated.

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.

Parameters:

updateSynonymOptionsRequest - Container for the necessary parameters to execute the UpdateSynonymOptions service method on AmazonCloudSearch.

Returns:

The response from the UpdateSynonymOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

updateStemmingOptions

UpdateStemmingOptionsResult updateStemmingOptions(UpdateStemmingOptionsRequest updateStemmingOptionsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Deprecated.

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.

Parameters:

updateStemmingOptionsRequest - Container for the necessary parameters to execute the UpdateStemmingOptions service method on AmazonCloudSearch.

Returns:

The response from the UpdateStemmingOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeStemmingOptions

DescribeStemmingOptionsResult describeStemmingOptions(DescribeStemmingOptionsRequest describeStemmingOptionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Deprecated.

Gets the stemming dictionary configured for the search domain.

Parameters:

describeStemmingOptionsRequest - Container for the necessary parameters to execute the DescribeStemmingOptions service method on AmazonCloudSearch.

Returns:

The response from the DescribeStemmingOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeDomains

DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Deprecated.

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.

Parameters:

describeDomainsRequest - Container for the necessary parameters to execute the DescribeDomains service method on AmazonCloudSearch.

Returns:

The response from the DescribeDomains service method, as returned by AmazonCloudSearch.

Throws:

BaseException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

indexDocuments

IndexDocumentsResult indexDocuments(IndexDocumentsRequest indexDocumentsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Deprecated.

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.

Parameters:

indexDocumentsRequest - Container for the necessary parameters to execute the IndexDocuments service method on AmazonCloudSearch.

Returns:

The response from the IndexDocuments service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeAvailabilityOptions

DescribeAvailabilityOptionsResult describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Deprecated.

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 .

Parameters:

describeAvailabilityOptionsRequest - Container for the necessary parameters to execute the DescribeAvailabilityOptions service method on AmazonCloudSearch.

Returns:

The response from the DescribeAvailabilityOptions service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

DisabledOperationException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeIndexFields

DescribeIndexFieldsResult describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

Deprecated.

Gets information about the index fields configured for the search domain. Can be limited to specific fields by name. Shows all fields by default.

Parameters:

describeIndexFieldsRequest - Container for the necessary parameters to execute the DescribeIndexFields service method on AmazonCloudSearch.

Returns:

The response from the DescribeIndexFields service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

deleteIndexField

DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Deprecated.

Removes an IndexField from the search domain.

Parameters:

deleteIndexFieldRequest - Container for the necessary parameters to execute the DeleteIndexField service method on AmazonCloudSearch.

Returns:

The response from the DeleteIndexField service method, as returned by AmazonCloudSearch.

Throws:

BaseException

ResourceNotFoundException

InternalException

InvalidTypeException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

describeDomains

DescribeDomainsResult describeDomains()
                                      throws AmazonServiceException,
                                             AmazonClientException

Deprecated.

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default.

Returns:

The response from the DescribeDomains service method, as returned by AmazonCloudSearch.

Throws:

BaseException

InternalException

AmazonClientException - If any internal errors are encountered inside the client while attempting to make the request or handle the response. For example if a network connection is not available.

AmazonServiceException - If an error response is returned by AmazonCloudSearch indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

Deprecated.

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Deprecated.

Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.