com.amazonaws.services.cloudsearchv2.AmazonCloudSearch Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudsearch Show documentation
/*
* Copyright 2011-2016 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not
* use this file except in compliance with the License. A copy of the License is
* located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.cloudsearchv2;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.cloudsearchv2.model.*;
/**
* Interface for accessing Amazon CloudSearch.
*
* 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.
*
*/
public interface AmazonCloudSearch {
/**
* The region metadata service name for computing region endpoints. You can
* use this value to retrieve metadata (such as supported regions) of the
* service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "cloudsearch";
/**
* 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
* {@link 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.
*
* @param 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.
*/
void setEndpoint(String endpoint);
/**
* An alternative to {@link AmazonCloudSearch#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 {@link 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.
*
* @param region
* The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region. Must not be null and must be a region
* where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
*/
void setRegion(Region region);
/**
*
* Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer
* Guide.
*
*
* @param buildSuggestersRequest
* Container for the parameters to the
* BuildSuggester operation. Specifies the name
* of the domain you want to update.
* @return Result of the BuildSuggesters operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.BuildSuggesters
*/
BuildSuggestersResult buildSuggesters(
BuildSuggestersRequest buildSuggestersRequest);
/**
*
* Creates a new search domain. For more information, see Creating a Search Domain in the Amazon CloudSearch
* Developer Guide.
*
*
* @param createDomainRequest
* Container for the parameters to the
* CreateDomain operation. Specifies a name for
* the new search domain.
* @return Result of the CreateDomain operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @sample AmazonCloudSearch.CreateDomain
*/
CreateDomainResult createDomain(CreateDomainRequest createDomainRequest);
/**
*
* 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.
*
*
* @param defineAnalysisSchemeRequest
* Container for the parameters to the
* DefineAnalysisScheme operation. Specifies the
* name of the domain you want to update and the analysis scheme
* configuration.
* @return Result of the DefineAnalysisScheme operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DefineAnalysisScheme
*/
DefineAnalysisSchemeResult defineAnalysisScheme(
DefineAnalysisSchemeRequest defineAnalysisSchemeRequest);
/**
*
* 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.
*
*
* @param defineExpressionRequest
* Container for the parameters to the
* DefineExpression operation. Specifies the name
* of the domain you want to update and the expression you want to
* configure.
* @return Result of the DefineExpression operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DefineExpression
*/
DefineExpressionResult defineExpression(
DefineExpressionRequest defineExpressionRequest);
/**
*
* 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.
*
*
* @param defineIndexFieldRequest
* Container for the parameters to the
* DefineIndexField operation. Specifies the name
* of the domain you want to update and the index field
* configuration.
* @return Result of the DefineIndexField operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DefineIndexField
*/
DefineIndexFieldResult defineIndexField(
DefineIndexFieldRequest defineIndexFieldRequest);
/**
*
* 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.
*
*
* @param defineSuggesterRequest
* Container for the parameters to the
* DefineSuggester operation. Specifies the name
* of the domain you want to update and the suggester configuration.
* @return Result of the DefineSuggester operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DefineSuggester
*/
DefineSuggesterResult defineSuggester(
DefineSuggesterRequest defineSuggesterRequest);
/**
*
* Deletes an analysis scheme. For more information, see Configuring Analysis Schemes in the Amazon
* CloudSearch Developer Guide.
*
*
* @param deleteAnalysisSchemeRequest
* Container for the parameters to the
* DeleteAnalysisScheme operation. Specifies the
* name of the domain you want to update and the analysis scheme you
* want to delete.
* @return Result of the DeleteAnalysisScheme operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DeleteAnalysisScheme
*/
DeleteAnalysisSchemeResult deleteAnalysisScheme(
DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest);
/**
*
* 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.
*
*
* @param deleteDomainRequest
* Container for the parameters to the
* DeleteDomain operation. Specifies the name of
* the domain you want to delete.
* @return Result of the DeleteDomain operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @sample AmazonCloudSearch.DeleteDomain
*/
DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest);
/**
*
* Removes an Expression from the search domain. For
* more information, see Configuring Expressions in the Amazon CloudSearch
* Developer Guide.
*
*
* @param deleteExpressionRequest
* Container for the parameters to the
* DeleteExpression operation. Specifies the name
* of the domain you want to update and the name of the expression
* you want to delete.
* @return Result of the DeleteExpression operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DeleteExpression
*/
DeleteExpressionResult deleteExpression(
DeleteExpressionRequest deleteExpressionRequest);
/**
*
* Removes an IndexField from the search domain. For
* more information, see Configuring Index Fields in the Amazon CloudSearch
* Developer Guide.
*
*
* @param deleteIndexFieldRequest
* Container for the parameters to the
* DeleteIndexField operation. Specifies the name
* of the domain you want to update and the name of the index field
* you want to delete.
* @return Result of the DeleteIndexField operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DeleteIndexField
*/
DeleteIndexFieldResult deleteIndexField(
DeleteIndexFieldRequest deleteIndexFieldRequest);
/**
*
* Deletes a suggester. For more information, see Getting Search Suggestions in the Amazon
* CloudSearch Developer Guide.
*
*
* @param deleteSuggesterRequest
* Container for the parameters to the
* DeleteSuggester operation. Specifies the name
* of the domain you want to update and name of the suggester you
* want to delete.
* @return Result of the DeleteSuggester operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DeleteSuggester
*/
DeleteSuggesterResult deleteSuggester(
DeleteSuggesterRequest deleteSuggesterRequest);
/**
*
* 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.
*
*
* @param describeAnalysisSchemesRequest
* Container for the parameters to the
* DescribeAnalysisSchemes operation. Specifies
* the name of the domain you want to describe. To limit the response
* to particular analysis schemes, specify the names of the analysis
* schemes you want to describe. To show the active configuration and
* exclude any pending changes, set the Deployed option
* to true.
* @return Result of the DescribeAnalysisSchemes operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DescribeAnalysisSchemes
*/
DescribeAnalysisSchemesResult describeAnalysisSchemes(
DescribeAnalysisSchemesRequest describeAnalysisSchemesRequest);
/**
*
* 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.
*
*
* @param describeAvailabilityOptionsRequest
* Container for the parameters to the
* DescribeAvailabilityOptions operation.
* Specifies the name of the domain you want to describe. To show the
* active configuration and exclude any pending changes, set the
* Deployed option to true.
* @return Result of the DescribeAvailabilityOptions operation returned by
* the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @throws DisabledOperationException
* The request was rejected because it attempted an operation which
* is not enabled.
* @sample AmazonCloudSearch.DescribeAvailabilityOptions
*/
DescribeAvailabilityOptionsResult describeAvailabilityOptions(
DescribeAvailabilityOptionsRequest describeAvailabilityOptionsRequest);
/**
*
* 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.
*
*
* @param describeDomainsRequest
* Container for the parameters to the
* DescribeDomains operation. By default shows
* the status of all domains. To restrict the response to particular
* domains, specify the names of the domains you want to describe.
* @return Result of the DescribeDomains operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @sample AmazonCloudSearch.DescribeDomains
*/
DescribeDomainsResult describeDomains(
DescribeDomainsRequest describeDomainsRequest);
/**
* Simplified method form for invoking the DescribeDomains operation.
*
* @see #describeDomains(DescribeDomainsRequest)
*/
DescribeDomainsResult describeDomains();
/**
*
* 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.
*
*
* @param describeExpressionsRequest
* Container for the parameters to the
* DescribeDomains operation. Specifies the name
* of the domain you want to describe. To restrict the response to
* particular expressions, specify the names of the expressions you
* want to describe. To show the active configuration and exclude any
* pending changes, set the Deployed option to
* true.
* @return Result of the DescribeExpressions operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DescribeExpressions
*/
DescribeExpressionsResult describeExpressions(
DescribeExpressionsRequest describeExpressionsRequest);
/**
*
* 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.
*
*
* @param describeIndexFieldsRequest
* Container for the parameters to the
* DescribeIndexFields operation. Specifies the
* name of the domain you want to describe. To restrict the response
* to particular index fields, specify the names of the index fields
* you want to describe. To show the active configuration and exclude
* any pending changes, set the Deployed option to
* true.
* @return Result of the DescribeIndexFields operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DescribeIndexFields
*/
DescribeIndexFieldsResult describeIndexFields(
DescribeIndexFieldsRequest describeIndexFieldsRequest);
/**
*
* 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.
*
*
* @param describeScalingParametersRequest
* Container for the parameters to the
* DescribeScalingParameters operation. Specifies
* the name of the domain you want to describe.
* @return Result of the DescribeScalingParameters operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DescribeScalingParameters
*/
DescribeScalingParametersResult describeScalingParameters(
DescribeScalingParametersRequest describeScalingParametersRequest);
/**
*
* 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.
*
*
* @param describeServiceAccessPoliciesRequest
* Container for the parameters to the
* DescribeServiceAccessPolicies operation.
* Specifies the name of the domain you want to describe. To show the
* active configuration and exclude any pending changes, set the
* Deployed option to true.
* @return Result of the DescribeServiceAccessPolicies operation returned by
* the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DescribeServiceAccessPolicies
*/
DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(
DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest);
/**
*
* 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.
*
*
* @param describeSuggestersRequest
* Container for the parameters to the
* DescribeSuggester operation. Specifies the
* name of the domain you want to describe. To restrict the response
* to particular suggesters, specify the names of the suggesters you
* want to describe. To show the active configuration and exclude any
* pending changes, set the Deployed option to
* true.
* @return Result of the DescribeSuggesters operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.DescribeSuggesters
*/
DescribeSuggestersResult describeSuggesters(
DescribeSuggestersRequest describeSuggestersRequest);
/**
*
* 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.
*
*
* @param indexDocumentsRequest
* Container for the parameters to the
* IndexDocuments operation. Specifies the name
* of the domain you want to re-index.
* @return Result of the IndexDocuments operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @sample AmazonCloudSearch.IndexDocuments
*/
IndexDocumentsResult indexDocuments(
IndexDocumentsRequest indexDocumentsRequest);
/**
*
* Lists all search domains owned by an account.
*
*
* @param listDomainNamesRequest
* @return Result of the ListDomainNames operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @sample AmazonCloudSearch.ListDomainNames
*/
ListDomainNamesResult listDomainNames(
ListDomainNamesRequest listDomainNamesRequest);
/**
* Simplified method form for invoking the ListDomainNames operation.
*
* @see #listDomainNames(ListDomainNamesRequest)
*/
ListDomainNamesResult listDomainNames();
/**
*
* 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.
*
*
* @param updateAvailabilityOptionsRequest
* Container for the parameters to the
* UpdateAvailabilityOptions operation. Specifies
* the name of the domain you want to update and the Multi-AZ
* availability option.
* @return Result of the UpdateAvailabilityOptions operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @throws DisabledOperationException
* The request was rejected because it attempted an operation which
* is not enabled.
* @sample AmazonCloudSearch.UpdateAvailabilityOptions
*/
UpdateAvailabilityOptionsResult updateAvailabilityOptions(
UpdateAvailabilityOptionsRequest updateAvailabilityOptionsRequest);
/**
*
* 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.
*
*
* @param updateScalingParametersRequest
* Container for the parameters to the
* UpdateScalingParameters operation. Specifies
* the name of the domain you want to update and the scaling
* parameters you want to configure.
* @return Result of the UpdateScalingParameters operation returned by the
* service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @sample AmazonCloudSearch.UpdateScalingParameters
*/
UpdateScalingParametersResult updateScalingParameters(
UpdateScalingParametersRequest updateScalingParametersRequest);
/**
*
* 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.
*
*
* @param updateServiceAccessPoliciesRequest
* Container for the parameters to the
* UpdateServiceAccessPolicies operation.
* Specifies the name of the domain you want to update and the access
* rules you want to configure.
* @return Result of the UpdateServiceAccessPolicies operation returned by
* the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws InternalException
* An internal error occurred while processing the request. If this
* problem persists, report an issue from the Service
* Health Dashboard.
* @throws LimitExceededException
* The request was rejected because a resource limit has already
* been met.
* @throws ResourceNotFoundException
* The request was rejected because it attempted to reference a
* resource that does not exist.
* @throws InvalidTypeException
* The request was rejected because it specified an invalid type
* definition.
* @sample AmazonCloudSearch.UpdateServiceAccessPolicies
*/
UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(
UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest);
/**
* 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.
*/
void shutdown();
/**
* 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.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none
* is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}