com.amazonaws.services.cloudsearchv2

Interface AmazonCloudSearch

All Known Subinterfaces:

AmazonCloudSearchAsync

All Known Implementing Classes:

AmazonCloudSearchAsyncClient, AmazonCloudSearchClient

public interface AmazonCloudSearch

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

Method Summary

Methods

Modifier and Type	Method and Description
BuildSuggestersResult	buildSuggesters(BuildSuggestersRequest buildSuggestersRequest) Indexes the search suggestions.
CreateDomainResult	createDomain(CreateDomainRequest createDomainRequest) Creates a new search domain.
DefineAnalysisSchemeResult	defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest) Configures an analysis scheme that can be applied to a text or text-array field to define language-specific text processing options.
DefineExpressionResult	defineExpression(DefineExpressionRequest defineExpressionRequest) Configures an Expression for the search domain.
DefineIndexFieldResult	defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest) Configures an IndexField for the search domain.
DefineSuggesterResult	defineSuggester(DefineSuggesterRequest defineSuggesterRequest) Configures a suggester for a domain.
DeleteAnalysisSchemeResult	deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest) Deletes an analysis scheme.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Permanently deletes a search domain and all of its data.
DeleteExpressionResult	deleteExpression(DeleteExpressionRequest deleteExpressionRequest) Removes an Expression from the search domain.
DeleteIndexFieldResult	deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest) Removes an IndexField from the search domain.
DeleteSuggesterResult	deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest) Deletes a suggester.
DescribeAnalysisSchemesResult	describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest) Gets the analysis schemes configured for a domain.
DescribeAvailabilityOptionsResult	describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest) Gets the availability options configured for a domain.
DescribeDomainsResult	describeDomains() Gets information about the search domains owned by this account.
DescribeDomainsResult	describeDomains(DescribeDomainsRequest describeDomainsRequest) Gets information about the search domains owned by this account.
DescribeExpressionsResult	describeExpressions(DescribeExpressionsRequest describeExpressionsRequest) Gets the expressions configured for the search domain.
DescribeIndexFieldsResult	describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest) Gets information about the index fields configured for the search domain.
DescribeScalingParametersResult	describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest) Gets the scaling parameters configured for a domain.
DescribeServiceAccessPoliciesResult	describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) Gets information about the access policies that control access to the domain's document and search endpoints.
DescribeSuggestersResult	describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest) Gets the suggesters configured for a domain.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) 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) Tells the search domain to start indexing its documents using the latest indexing options.
ListDomainNamesResult	listDomainNames() Lists all search domains owned by an account.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Lists all search domains owned by an account.
void	setEndpoint(String endpoint) Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/").
void	setRegion(Region region) An alternative to setEndpoint(String), sets the regional endpoint for this client's service calls.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
UpdateAvailabilityOptionsResult	updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest) Configures the availability options for a domain.
UpdateScalingParametersResult	updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest) Configures scaling parameters for a domain.
UpdateServiceAccessPoliciesResult	updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) Configures the access rules that control access to the domain's document and search endpoints.

Method Detail

setEndpoint

void setEndpoint(String endpoint)
                 throws IllegalArgumentException

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

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)

describeAnalysisSchemes

DescribeAnalysisSchemesResult describeAnalysisSchemes(DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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 .

Parameters:

describeAnalysisSchemesRequest - Container for the necessary parameters to execute the DescribeAnalysisSchemes service method on AmazonCloudSearchv2.

Returns:

The response from the DescribeAnalysisSchemes service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

deleteIndexField

DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Parameters:

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

Returns:

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

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

updateAvailabilityOptions

UpdateAvailabilityOptionsResult updateAvailabilityOptions(UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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

Returns:

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

Throws:

InternalException

InvalidTypeException

DisabledOperationException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeIndexFields

DescribeIndexFieldsResult describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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 .

Parameters:

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

Returns:

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

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

defineExpression

DefineExpressionResult defineExpression(DefineExpressionRequest defineExpressionRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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 .

Parameters:

defineExpressionRequest - Container for the necessary parameters to execute the DefineExpression service method on AmazonCloudSearchv2.

Returns:

The response from the DefineExpression service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

updateServiceAccessPolicies

UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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 .

Parameters:

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

Returns:

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

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

defineSuggester

DefineSuggesterResult defineSuggester(DefineSuggesterRequest defineSuggesterRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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 .

Parameters:

defineSuggesterRequest - Container for the necessary parameters to execute the DefineSuggester service method on AmazonCloudSearchv2.

Returns:

The response from the DefineSuggester service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

deleteAnalysisScheme

DeleteAnalysisSchemeResult deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .

Parameters:

deleteAnalysisSchemeRequest - Container for the necessary parameters to execute the DeleteAnalysisScheme service method on AmazonCloudSearchv2.

Returns:

The response from the DeleteAnalysisScheme service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

indexDocuments

IndexDocumentsResult indexDocuments(IndexDocumentsRequest indexDocumentsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

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 .

Parameters:

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

Returns:

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

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeSuggesters

DescribeSuggestersResult describeSuggesters(DescribeSuggestersRequest describeSuggestersRequest)
                                            throws AmazonServiceException,
                                                   AmazonClientException

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 .

Parameters:

describeSuggestersRequest - Container for the necessary parameters to execute the DescribeSuggesters service method on AmazonCloudSearchv2.

Returns:

The response from the DescribeSuggesters service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

updateScalingParameters

UpdateScalingParametersResult updateScalingParameters(UpdateScalingParametersRequest updateScalingParametersRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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 .

Parameters:

updateScalingParametersRequest - Container for the necessary parameters to execute the UpdateScalingParameters service method on AmazonCloudSearchv2.

Returns:

The response from the UpdateScalingParameters service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

listDomainNames

ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Lists all search domains owned by an account.

Parameters:

listDomainNamesRequest - Container for the necessary parameters to execute the ListDomainNames service method on AmazonCloudSearchv2.

Returns:

The response from the ListDomainNames service method, as returned by AmazonCloudSearchv2.

Throws:

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

defineIndexField

DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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 .

Parameters:

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

Returns:

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

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

createDomain

CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch Developer Guide .

Parameters:

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

Returns:

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

Throws:

InternalException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

deleteSuggester

DeleteSuggesterResult deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon CloudSearch Developer Guide .

Parameters:

deleteSuggesterRequest - Container for the necessary parameters to execute the DeleteSuggester service method on AmazonCloudSearchv2.

Returns:

The response from the DeleteSuggester service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

deleteExpression

DeleteExpressionResult deleteExpression(DeleteExpressionRequest deleteExpressionRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

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

Parameters:

deleteExpressionRequest - Container for the necessary parameters to execute the DeleteExpression service method on AmazonCloudSearchv2.

Returns:

The response from the DeleteExpression service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeAvailabilityOptions

DescribeAvailabilityOptionsResult describeAvailabilityOptions(DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

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

Returns:

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

Throws:

InternalException

InvalidTypeException

DisabledOperationException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

defineAnalysisScheme

DefineAnalysisSchemeResult defineAnalysisScheme(DefineAnalysisSchemeRequest defineAnalysisSchemeRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

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 .

Parameters:

defineAnalysisSchemeRequest - Container for the necessary parameters to execute the DefineAnalysisScheme service method on AmazonCloudSearchv2.

Returns:

The response from the DefineAnalysisScheme service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

InvalidTypeException

ResourceNotFoundException

LimitExceededException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

buildSuggesters

BuildSuggestersResult buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

Indexes the search suggestions.

Parameters:

buildSuggestersRequest - Container for the necessary parameters to execute the BuildSuggesters service method on AmazonCloudSearchv2.

Returns:

The response from the BuildSuggesters service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeServiceAccessPolicies

DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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 .

Parameters:

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

Returns:

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

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

deleteDomain

DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

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 .

Parameters:

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

Returns:

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

Throws:

InternalException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeExpressions

DescribeExpressionsResult describeExpressions(DescribeExpressionsRequest describeExpressionsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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 .

Parameters:

describeExpressionsRequest - Container for the necessary parameters to execute the DescribeExpressions service method on AmazonCloudSearchv2.

Returns:

The response from the DescribeExpressions service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeDomains

DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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.

Parameters:

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

Returns:

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

Throws:

InternalException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeScalingParameters

DescribeScalingParametersResult describeScalingParameters(DescribeScalingParametersRequest describeScalingParametersRequest)
                                                          throws AmazonServiceException,
                                                                 AmazonClientException

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 .

Parameters:

describeScalingParametersRequest - Container for the necessary parameters to execute the DescribeScalingParameters service method on AmazonCloudSearchv2.

Returns:

The response from the DescribeScalingParameters service method, as returned by AmazonCloudSearchv2.

Throws:

InternalException

ResourceNotFoundException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

listDomainNames

ListDomainNamesResult listDomainNames()
                                      throws AmazonServiceException,
                                             AmazonClientException

Lists all search domains owned by an account.

Returns:

The response from the ListDomainNames service method, as returned by AmazonCloudSearchv2.

Throws:

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

describeDomains

DescribeDomainsResult describeDomains()
                                      throws AmazonServiceException,
                                             AmazonClientException

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.

Returns:

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

Throws:

InternalException

BaseException

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 AmazonCloudSearchv2 indicating either a problem with the data in the request, or a server side issue.

shutdown

void shutdown()

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)

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.