com.amazonaws.services.cloudsearchv2

Class AmazonCloudSearchClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudsearchv2.AmazonCloudSearchClient

All Implemented Interfaces:

AmazonCloudSearch

Direct Known Subclasses:

AmazonCloudSearchAsyncClient

public class AmazonCloudSearchClient
extends AmazonWebServiceClient
implements AmazonCloudSearch

Client for accessing AmazonCloudSearchv2. All service calls made using this client are blocking, and will not return until the service call completes.

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 .

Field Summary

Fields

Modifier and Type	Field and Description
protected List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>>	exceptionUnmarshallers List of exception unmarshallers for all AmazonCloudSearchv2 exceptions.

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Constructor Summary

Constructors

Constructor and Description
AmazonCloudSearchClient() Constructs a new client to invoke service methods on AmazonCloudSearchv2.
AmazonCloudSearchClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials.
AmazonCloudSearchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials and client configuration options.
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials provider.
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials provider and client configuration options.
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector) Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials provider, client configuration options, and request metric collector.
AmazonCloudSearchClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearchv2.

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

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configSigner, configSigner, convertToHttpRequest, createExecutionContext, createExecutionContext, createExecutionContext, endClientExecution, endClientExecution, findRequestMetricCollector, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerRegionOverride, getTimeOffset, isProfilingEnabled, isRequestMetricsEnabled, removeRequestHandler, removeRequestHandler, requestMetricCollector, setConfiguration, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shutdown, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.amazonaws.services.cloudsearchv2.AmazonCloudSearch

setEndpoint, setRegion, shutdown

Field Detail

exceptionUnmarshallers

protected final List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonCloudSearchv2 exceptions.

Constructor Detail

AmazonCloudSearchClient

public AmazonCloudSearchClient()

Constructs a new client to invoke service methods on AmazonCloudSearchv2. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchClient

public AmazonCloudSearchClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCloudSearchv2. A credentials provider chain will be used that searches for credentials in this order:

• Environment Variables - AWS_ACCESS_KEY_ID and AWS_SECRET_KEY
• Java System Properties - aws.accessKeyId and aws.secretKey
• Instance profile credentials delivered through the Amazon EC2 metadata service

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudSearchv2 (ex: proxy settings, retry counts, etc.).

See Also:

DefaultAWSCredentialsProviderChain

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentials awsCredentials,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentials - The AWS credentials (access key ID and secret key) to use when authenticating with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudSearchv2 (ex: proxy settings, retry counts, etc.).

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials provider.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials provider and client configuration options.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudSearchv2 (ex: proxy settings, retry counts, etc.).

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider,
                       ClientConfiguration clientConfiguration,
                       RequestMetricCollector requestMetricCollector)

Constructs a new client to invoke service methods on AmazonCloudSearchv2 using the specified AWS account credentials provider, client configuration options, and request metric collector.

All service calls made using this new client object are blocking, and will not return until the service call completes.

Parameters:

awsCredentialsProvider - The AWS credentials provider which will provide credentials to authenticate requests with AWS services.

clientConfiguration - The client configuration options controlling how this client connects to AmazonCloudSearchv2 (ex: proxy settings, retry counts, etc.).

requestMetricCollector - optional request metric collector

Method Detail

describeAnalysisSchemes

public DescribeAnalysisSchemesResult describeAnalysisSchemes(DescribeAnalysisSchemesRequest 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 .

Specified by:

describeAnalysisSchemes in interface AmazonCloudSearch

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

public DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)

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

Specified by:

deleteIndexField in interface AmazonCloudSearch

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

public UpdateAvailabilityOptionsResult updateAvailabilityOptions(UpdateAvailabilityOptionsRequest 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 .

Specified by:

updateAvailabilityOptions in interface AmazonCloudSearch

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

public DescribeIndexFieldsResult describeIndexFields(DescribeIndexFieldsRequest 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 .

Specified by:

describeIndexFields in interface AmazonCloudSearch

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

public DefineExpressionResult defineExpression(DefineExpressionRequest 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 .

Specified by:

defineExpression in interface AmazonCloudSearch

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

public UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest 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 .

Specified by:

updateServiceAccessPolicies in interface AmazonCloudSearch

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

public DefineSuggesterResult defineSuggester(DefineSuggesterRequest 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 .

Specified by:

defineSuggester in interface AmazonCloudSearch

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

public DeleteAnalysisSchemeResult deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)

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

Specified by:

deleteAnalysisScheme in interface AmazonCloudSearch

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

public IndexDocumentsResult indexDocuments(IndexDocumentsRequest 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 .

Specified by:

indexDocuments in interface AmazonCloudSearch

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

public DescribeSuggestersResult describeSuggesters(DescribeSuggestersRequest 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 .

Specified by:

describeSuggesters in interface AmazonCloudSearch

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

public UpdateScalingParametersResult updateScalingParameters(UpdateScalingParametersRequest 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 .

Specified by:

updateScalingParameters in interface AmazonCloudSearch

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

public ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

Lists all search domains owned by an account.

Specified by:

listDomainNames in interface AmazonCloudSearch

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

public DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest 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 .

Specified by:

defineIndexField in interface AmazonCloudSearch

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

public CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)

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

Specified by:

createDomain in interface AmazonCloudSearch

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

public DeleteSuggesterResult deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)

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

Specified by:

deleteSuggester in interface AmazonCloudSearch

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

public DeleteExpressionResult deleteExpression(DeleteExpressionRequest deleteExpressionRequest)

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

Specified by:

deleteExpression in interface AmazonCloudSearch

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

public DescribeAvailabilityOptionsResult describeAvailabilityOptions(DescribeAvailabilityOptionsRequest 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 .

Specified by:

describeAvailabilityOptions in interface AmazonCloudSearch

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

public 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. For more information, see Configuring Analysis Schemes in the Amazon CloudSearch Developer Guide .

Specified by:

defineAnalysisScheme in interface AmazonCloudSearch

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

public BuildSuggestersResult buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)

Indexes the search suggestions.

Specified by:

buildSuggesters in interface AmazonCloudSearch

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

public DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest 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 .

Specified by:

describeServiceAccessPolicies in interface AmazonCloudSearch

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

public DeleteDomainResult deleteDomain(DeleteDomainRequest 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 .

Specified by:

deleteDomain in interface AmazonCloudSearch

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

public DescribeExpressionsResult describeExpressions(DescribeExpressionsRequest 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 .

Specified by:

describeExpressions in interface AmazonCloudSearch

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

public DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)

Gets information about the search domains owned by this account. Can be limited to specific domains. Shows all domains by default. To get the number of searchable documents in a domain, use the console or submit a matchall request to your domain's search endpoint: q=matchall&q.parser=structured&size=0. For more information, see Getting Information about a Search Domain in the Amazon CloudSearch Developer Guide.

Specified by:

describeDomains in interface AmazonCloudSearch

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

public DescribeScalingParametersResult describeScalingParameters(DescribeScalingParametersRequest 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 .

Specified by:

describeScalingParameters in interface AmazonCloudSearch

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

public ListDomainNamesResult listDomainNames()
                                      throws AmazonServiceException,
                                             AmazonClientException

Lists all search domains owned by an account.

Specified by:

listDomainNames in interface AmazonCloudSearch

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

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

Specified by:

describeDomains in interface AmazonCloudSearch

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.

getCachedResponseMetadata

public 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 the request.

Specified by:

getCachedResponseMetadata in interface AmazonCloudSearch

Parameters:

request - The originally executed request

Returns:

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