com.amazonaws.services.cloudsearchv2

Interface AmazonCloudSearch

All Known Subinterfaces:

AmazonCloudSearchAsync

All Known Implementing Classes:

AbstractAmazonCloudSearch, AbstractAmazonCloudSearchAsync, AmazonCloudSearchAsyncClient, AmazonCloudSearchClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonCloudSearch

Interface for accessing Amazon CloudSearch.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonCloudSearch instead.

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
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

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.
DescribeDomainEndpointOptionsResult	describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest describeDomainEndpointOptionsRequest) Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
DescribeDomainsResult	describeDomains() Simplified method form for invoking the DescribeDomains operation.
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() Simplified method form for invoking the ListDomainNames operation.
ListDomainNamesResult	listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Lists all search domains owned by an account.
void	setEndpoint(String endpoint) Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));
void	setRegion(Region region) Deprecated. use AwsClientBuilder#setRegion(String)
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.
UpdateDomainEndpointOptionsResult	updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest updateDomainEndpointOptionsRequest) Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

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 Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

setEndpoint

@Deprecated
void setEndpoint(String endpoint)

Deprecated. use AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration) for example: builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));

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: https://docs.aws.amazon.com/sdk-for-java/v1/developer-guide/java-dg-region-selection.html#region-selection- choose-endpoint

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.

setRegion

@Deprecated
void setRegion(Region region)

Deprecated. use AwsClientBuilder#setRegion(String)

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. Must not be null and must be a region where the service is available.

See Also:

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

buildSuggesters

BuildSuggestersResult buildSuggesters(BuildSuggestersRequest buildSuggestersRequest)

Indexes the search suggestions. For more information, see Configuring Suggesters in the Amazon CloudSearch Developer Guide.

Parameters:

buildSuggestersRequest - Container for the parameters to the BuildSuggester operation. Specifies the name of the domain you want to update.

Returns:

Result of the BuildSuggesters operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

createDomain

CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)

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

Parameters:

createDomainRequest - Container for the parameters to the CreateDomain operation. Specifies a name for the new search domain.

Returns:

Result of the CreateDomain operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

ResourceAlreadyExistsException - The request was rejected because it attempted to create a resource that already exists.

ValidationException - The request was rejected because it has invalid parameters.

defineAnalysisScheme

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.

Parameters:

defineAnalysisSchemeRequest - Container for the parameters to the DefineAnalysisScheme operation. Specifies the name of the domain you want to update and the analysis scheme configuration.

Returns:

Result of the DefineAnalysisScheme operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

defineExpression

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.

Parameters:

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.

Returns:

Result of the DefineExpression operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

defineIndexField

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.

Parameters:

defineIndexFieldRequest - Container for the parameters to the DefineIndexField operation. Specifies the name of the domain you want to update and the index field configuration.

Returns:

Result of the DefineIndexField operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

defineSuggester

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.

Parameters:

defineSuggesterRequest - Container for the parameters to the DefineSuggester operation. Specifies the name of the domain you want to update and the suggester configuration.

Returns:

Result of the DefineSuggester operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

deleteAnalysisScheme

DeleteAnalysisSchemeResult deleteAnalysisScheme(DeleteAnalysisSchemeRequest deleteAnalysisSchemeRequest)

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

Parameters:

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.

Returns:

Result of the DeleteAnalysisScheme operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

deleteDomain

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.

Parameters:

deleteDomainRequest - Container for the parameters to the DeleteDomain operation. Specifies the name of the domain you want to delete.

Returns:

Result of the DeleteDomain operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

deleteExpression

DeleteExpressionResult deleteExpression(DeleteExpressionRequest deleteExpressionRequest)

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

Parameters:

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.

Returns:

Result of the DeleteExpression operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

deleteIndexField

DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)

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

Returns:

Result of the DeleteIndexField operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

deleteSuggester

DeleteSuggesterResult deleteSuggester(DeleteSuggesterRequest deleteSuggesterRequest)

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

Parameters:

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.

Returns:

Result of the DeleteSuggester operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

describeAnalysisSchemes

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.

Parameters:

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.

Returns:

Result of the DescribeAnalysisSchemes operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

describeAvailabilityOptions

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.

Parameters:

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.

Returns:

Result of the DescribeAvailabilityOptions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

LimitExceededException - The request was rejected because a resource limit has already been met.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

DisabledOperationException - The request was rejected because it attempted an operation which is not enabled.

describeDomainEndpointOptions

DescribeDomainEndpointOptionsResult describeDomainEndpointOptions(DescribeDomainEndpointOptionsRequest describeDomainEndpointOptionsRequest)

Returns the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Parameters:

describeDomainEndpointOptionsRequest - Container for the parameters to the DescribeDomainEndpointOptions operation. Specify 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.

Returns:

Result of the DescribeDomainEndpointOptions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

DisabledOperationException - The request was rejected because it attempted an operation which is not enabled.

describeDomains

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.

Parameters:

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.

Returns:

Result of the DescribeDomains operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

describeDomains

DescribeDomainsResult describeDomains()

Simplified method form for invoking the DescribeDomains operation.

See Also:

describeDomains(DescribeDomainsRequest)

describeExpressions

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.

Parameters:

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.

Returns:

Result of the DescribeExpressions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

describeIndexFields

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.

Parameters:

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.

Returns:

Result of the DescribeIndexFields operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

describeScalingParameters

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.

Parameters:

describeScalingParametersRequest - Container for the parameters to the DescribeScalingParameters operation. Specifies the name of the domain you want to describe.

Returns:

Result of the DescribeScalingParameters operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

describeServiceAccessPolicies

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.

Parameters:

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.

Returns:

Result of the DescribeServiceAccessPolicies operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

describeSuggesters

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.

Parameters:

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.

Returns:

Result of the DescribeSuggesters operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

indexDocuments

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.

Parameters:

indexDocumentsRequest - Container for the parameters to the IndexDocuments operation. Specifies the name of the domain you want to re-index.

Returns:

Result of the IndexDocuments operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

listDomainNames

ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest)

Lists all search domains owned by an account.

Parameters:

listDomainNamesRequest -

Returns:

Result of the ListDomainNames operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

listDomainNames

ListDomainNamesResult listDomainNames()

Simplified method form for invoking the ListDomainNames operation.

See Also:

listDomainNames(ListDomainNamesRequest)

updateAvailabilityOptions

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.

Parameters:

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.

Returns:

Result of the UpdateAvailabilityOptions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

LimitExceededException - The request was rejected because a resource limit has already been met.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

DisabledOperationException - The request was rejected because it attempted an operation which is not enabled.

ValidationException - The request was rejected because it has invalid parameters.

updateDomainEndpointOptions

UpdateDomainEndpointOptionsResult updateDomainEndpointOptions(UpdateDomainEndpointOptionsRequest updateDomainEndpointOptionsRequest)

Updates the domain's endpoint options, specifically whether all requests to the domain must arrive over HTTPS. For more information, see Configuring Domain Endpoint Options in the Amazon CloudSearch Developer Guide.

Parameters:

updateDomainEndpointOptionsRequest - Container for the parameters to the UpdateDomainEndpointOptions operation. Specifies the name of the domain you want to update and the domain endpoint options.

Returns:

Result of the UpdateDomainEndpointOptions operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

LimitExceededException - The request was rejected because a resource limit has already been met.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

DisabledOperationException - The request was rejected because it attempted an operation which is not enabled.

ValidationException - The request was rejected because it has invalid parameters.

updateScalingParameters

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.

Parameters:

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.

Returns:

Result of the UpdateScalingParameters operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

updateServiceAccessPolicies

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.

Parameters:

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.

Returns:

Result of the UpdateServiceAccessPolicies operation returned by the service.

Throws:

BaseException - An error occurred while processing the request.

InternalException - An internal error occurred while processing the request. If this problem persists, report an issue from the Service Health Dashboard.

LimitExceededException - The request was rejected because a resource limit has already been met.

ResourceNotFoundException - The request was rejected because it attempted to reference a resource that does not exist.

InvalidTypeException - The request was rejected because it specified an invalid type definition.

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.