com.amazonaws.services.cloudsearch

クラス AmazonCloudSearchClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.cloudsearch.AmazonCloudSearchClient

すべての実装されたインタフェース:

AmazonCloudSearch

直系の既知のサブクラス:

AmazonCloudSearchAsyncClient

public class AmazonCloudSearchClient
extends AmazonWebServiceClient
implements AmazonCloudSearch

Client for accessing AmazonCloudSearch. 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 Configuration Service to create, configure, and manage search domains. Amazon CloudSearch configuration requests are submitted to cloudsearch.us-east-1.amazonaws.com using the AWS Query protocol.

フィールドの概要

フィールド

修飾子とタイプ	フィールドと説明
protected java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>>	exceptionUnmarshallers List of exception unmarshallers for all AmazonCloudSearch exceptions.

クラスから継承されたフィールド com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, requestHandlers, timeOffset, version

コンストラクタの概要

コンストラクタ

コンストラクタと説明
AmazonCloudSearchClient() Constructs a new client to invoke service methods on AmazonCloudSearch.
AmazonCloudSearchClient(AWSCredentials awsCredentials) Constructs a new client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials.
AmazonCloudSearchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials and client configuration options.
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider) Constructs a new client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials provider.
AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearch using the specified AWS account credentials provider and client configuration options.
AmazonCloudSearchClient(ClientConfiguration clientConfiguration) Constructs a new client to invoke service methods on AmazonCloudSearch.

メソッドの概要

メソッド

修飾子とタイプ	メソッドと説明
CreateDomainResult	createDomain(CreateDomainRequest createDomainRequest) Creates a new search domain.
DefineIndexFieldResult	defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest) Configures an IndexField for the search domain.
DefineRankExpressionResult	defineRankExpression(DefineRankExpressionRequest defineRankExpressionRequest) Configures a RankExpression for the search domain.
DeleteDomainResult	deleteDomain(DeleteDomainRequest deleteDomainRequest) Permanently deletes a search domain and all of its data.
DeleteIndexFieldResult	deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest) Removes an IndexField from the search domain.
DeleteRankExpressionResult	deleteRankExpression(DeleteRankExpressionRequest deleteRankExpressionRequest) Removes a RankExpression from the search domain.
DescribeDefaultSearchFieldResult	describeDefaultSearchField(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest) Gets the default search field configured for the search 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.
DescribeIndexFieldsResult	describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest) Gets information about the index fields configured for the search domain.
DescribeRankExpressionsResult	describeRankExpressions(DescribeRankExpressionsRequest describeRankExpressionsRequest) Gets the rank expressions configured for the search domain.
DescribeServiceAccessPoliciesResult	describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest) Gets information about the resource-based policies that control access to the domain's document and search services.
DescribeStemmingOptionsResult	describeStemmingOptions(DescribeStemmingOptionsRequest describeStemmingOptionsRequest) Gets the stemming dictionary configured for the search domain.
DescribeStopwordOptionsResult	describeStopwordOptions(DescribeStopwordOptionsRequest describeStopwordOptionsRequest) Gets the stopwords configured for the search domain.
DescribeSynonymOptionsResult	describeSynonymOptions(DescribeSynonymOptionsRequest describeSynonymOptionsRequest) Gets the synonym dictionary configured for the search 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.
protected java.lang.String	getServiceAbbreviation() リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します
IndexDocumentsResult	indexDocuments(IndexDocumentsRequest indexDocumentsRequest) Tells the search domain to start indexing its documents using the latest text processing options and IndexFields .
void	setEndpoint(java.lang.String endpoint, java.lang.String serviceName, java.lang.String regionId) Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests.
UpdateDefaultSearchFieldResult	updateDefaultSearchField(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest) Configures the default search field for the search domain.
UpdateServiceAccessPoliciesResult	updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest) Configures the policies that control access to the domain's document and search services.
UpdateStemmingOptionsResult	updateStemmingOptions(UpdateStemmingOptionsRequest updateStemmingOptionsRequest) Configures a stemming dictionary for the search domain.
UpdateStopwordOptionsResult	updateStopwordOptions(UpdateStopwordOptionsRequest updateStopwordOptionsRequest) Configures stopwords for the search domain.
UpdateSynonymOptionsResult	updateSynonymOptions(UpdateSynonymOptionsRequest updateSynonymOptionsRequest) Configures a synonym dictionary for the search domain.

クラスから継承されたメソッド com.amazonaws.AmazonWebServiceClient

addRequestHandler, convertToHttpRequest, createExecutionContext, getTimeOffset, getVersion, removeRequestHandler, setConfiguration, setEndpoint, setRegion, setTimeOffset, setVersion, shutdown, withTimeOffset

クラスから継承されたメソッド java.lang.Object

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

インタフェースから継承されたメソッド com.amazonaws.services.cloudsearch.AmazonCloudSearch

setEndpoint, setRegion, shutdown

フィールドの詳細

exceptionUnmarshallers

protected final java.util.List<com.amazonaws.transform.Unmarshaller<AmazonServiceException,org.w3c.dom.Node>> exceptionUnmarshallers

List of exception unmarshallers for all AmazonCloudSearch exceptions.

コンストラクタの詳細

AmazonCloudSearchClient

public AmazonCloudSearchClient()

Constructs a new client to invoke service methods on AmazonCloudSearch. 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.

関連項目:

DefaultAWSCredentialsProvider

AmazonCloudSearchClient

public AmazonCloudSearchClient(ClientConfiguration clientConfiguration)

Constructs a new client to invoke service methods on AmazonCloudSearch. 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.

パラメータ:

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

関連項目:

DefaultAWSCredentialsProvider

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentials awsCredentials)

Constructs a new client to invoke service methods on AmazonCloudSearch 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.

パラメータ:

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

パラメータ:

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 AmazonCloudSearch (ex: proxy settings, retry counts, etc.).

AmazonCloudSearchClient

public AmazonCloudSearchClient(AWSCredentialsProvider awsCredentialsProvider)

Constructs a new client to invoke service methods on AmazonCloudSearch 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.

パラメータ:

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

パラメータ:

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 AmazonCloudSearch (ex: proxy settings, retry counts, etc.).

メソッドの詳細

updateDefaultSearchField

public UpdateDefaultSearchFieldResult updateDefaultSearchField(UpdateDefaultSearchFieldRequest updateDefaultSearchFieldRequest)
                                                        throws AmazonServiceException,
                                                               AmazonClientException

Configures the default search field for the search domain. The default search field is used when a search request does not specify which fields to search. By default, it is configured to include the contents of all of the domain's text fields.

定義:

updateDefaultSearchField インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

InvalidTypeException

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

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

deleteRankExpression

public DeleteRankExpressionResult deleteRankExpression(DeleteRankExpressionRequest deleteRankExpressionRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Removes a RankExpression from the search domain.

定義:

deleteRankExpression インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

describeRankExpressions

public DescribeRankExpressionsResult describeRankExpressions(DescribeRankExpressionsRequest describeRankExpressionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

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

定義:

describeRankExpressions インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

createDomain

public CreateDomainResult createDomain(CreateDomainRequest createDomainRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Creates a new search domain.

定義:

createDomain インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

LimitExceededException

InternalException

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

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

updateServiceAccessPolicies

public UpdateServiceAccessPoliciesResult updateServiceAccessPolicies(UpdateServiceAccessPoliciesRequest updateServiceAccessPoliciesRequest)
                                                              throws AmazonServiceException,
                                                                     AmazonClientException

Configures the policies that control access to the domain's document and search services. The maximum size of an access policy document is 100KB.

定義:

updateServiceAccessPolicies インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

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

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

defineIndexField

public DefineIndexFieldResult defineIndexField(DefineIndexFieldRequest defineIndexFieldRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Configures an IndexField for the search domain. Used to create new fields and modify existing ones. If the field exists, the new configuration replaces the old one. You can configure a maximum of 200 index fields.

定義:

defineIndexField インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

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

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

defineRankExpression

public DefineRankExpressionResult defineRankExpression(DefineRankExpressionRequest defineRankExpressionRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Configures a RankExpression for the search domain. Used to create new rank expressions and modify existing ones. If the expression exists, the new configuration replaces the old one. You can configure a maximum of 50 rank expressions.

定義:

defineRankExpression インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

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

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

describeSynonymOptions

public DescribeSynonymOptionsResult describeSynonymOptions(DescribeSynonymOptionsRequest describeSynonymOptionsRequest)
                                                    throws AmazonServiceException,
                                                           AmazonClientException

Gets the synonym dictionary configured for the search domain.

定義:

describeSynonymOptions インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

describeStopwordOptions

public DescribeStopwordOptionsResult describeStopwordOptions(DescribeStopwordOptionsRequest describeStopwordOptionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Gets the stopwords configured for the search domain.

定義:

describeStopwordOptions インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

deleteDomain

public DeleteDomainResult deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                throws AmazonServiceException,
                                       AmazonClientException

Permanently deletes a search domain and all of its data.

定義:

deleteDomain インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

InternalException

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

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

describeServiceAccessPolicies

public DescribeServiceAccessPoliciesResult describeServiceAccessPolicies(DescribeServiceAccessPoliciesRequest describeServiceAccessPoliciesRequest)
                                                                  throws AmazonServiceException,
                                                                         AmazonClientException

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

定義:

describeServiceAccessPolicies インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

describeDefaultSearchField

public DescribeDefaultSearchFieldResult describeDefaultSearchField(DescribeDefaultSearchFieldRequest describeDefaultSearchFieldRequest)
                                                            throws AmazonServiceException,
                                                                   AmazonClientException

Gets the default search field configured for the search domain.

定義:

describeDefaultSearchField インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

updateStopwordOptions

public UpdateStopwordOptionsResult updateStopwordOptions(UpdateStopwordOptionsRequest updateStopwordOptionsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Configures stopwords for the search domain. Stopwords are used during indexing and when processing search requests. The maximum size of the stopwords dictionary is 10KB.

定義:

updateStopwordOptions インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

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

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

updateSynonymOptions

public UpdateSynonymOptionsResult updateSynonymOptions(UpdateSynonymOptionsRequest updateSynonymOptionsRequest)
                                                throws AmazonServiceException,
                                                       AmazonClientException

Configures a synonym dictionary for the search domain. The synonym dictionary is used during indexing to configure mappings for terms that occur in text fields. The maximum size of the synonym dictionary is 100KB.

定義:

updateSynonymOptions インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

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

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

updateStemmingOptions

public UpdateStemmingOptionsResult updateStemmingOptions(UpdateStemmingOptionsRequest updateStemmingOptionsRequest)
                                                  throws AmazonServiceException,
                                                         AmazonClientException

Configures a stemming dictionary for the search domain. The stemming dictionary is used during indexing and when processing search requests. The maximum size of the stemming dictionary is 500KB.

定義:

updateStemmingOptions インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

LimitExceededException

InternalException

InvalidTypeException

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

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

describeStemmingOptions

public DescribeStemmingOptionsResult describeStemmingOptions(DescribeStemmingOptionsRequest describeStemmingOptionsRequest)
                                                      throws AmazonServiceException,
                                                             AmazonClientException

Gets the stemming dictionary configured for the search domain.

定義:

describeStemmingOptions インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

describeDomains

public DescribeDomainsResult describeDomains(DescribeDomainsRequest describeDomainsRequest)
                                      throws AmazonServiceException,
                                             AmazonClientException

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

定義:

describeDomains インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

InternalException

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

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

indexDocuments

public IndexDocumentsResult indexDocuments(IndexDocumentsRequest indexDocumentsRequest)
                                    throws AmazonServiceException,
                                           AmazonClientException

Tells the search domain to start indexing its documents using the latest text processing options and IndexFields . This operation must be invoked to make options whose OptionStatus has OptionState of RequiresIndexDocuments visible in search results.

定義:

indexDocuments インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

describeIndexFields

public DescribeIndexFieldsResult describeIndexFields(DescribeIndexFieldsRequest describeIndexFieldsRequest)
                                              throws AmazonServiceException,
                                                     AmazonClientException

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

定義:

describeIndexFields インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

deleteIndexField

public DeleteIndexFieldResult deleteIndexField(DeleteIndexFieldRequest deleteIndexFieldRequest)
                                        throws AmazonServiceException,
                                               AmazonClientException

Removes an IndexField from the search domain.

定義:

deleteIndexField インタフェース内 AmazonCloudSearch

パラメータ:

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

戻り値:

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

例外:

BaseException

ResourceNotFoundException

InternalException

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

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

describeDomains

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.

定義:

describeDomains インタフェース内 AmazonCloudSearch

戻り値:

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

例外:

BaseException

InternalException

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

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

setEndpoint

public void setEndpoint(java.lang.String endpoint,
               java.lang.String serviceName,
               java.lang.String regionId)
                 throws java.lang.IllegalArgumentException

Overrides the default endpoint for this client ("https://cloudsearch.us-east-1.amazonaws.com/") and explicitly provides an AWS region ID and AWS service name to use when the client calculates a signature for requests. In almost all cases, this region ID and service name are automatically determined from the endpoint, and callers should use the simpler one-argument form of setEndpoint instead of this method.

This method is not threadsafe. Endpoints 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.

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

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

パラメータ:

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.

serviceName - The name of the AWS service to use when signing requests.

regionId - The ID of the region in which this service resides.

例外:

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

getServiceAbbreviation

protected java.lang.String getServiceAbbreviation()

クラスからコピーされた説明: AmazonWebServiceClient

リージョンによるサービスエンドポイントを特定するために、このサービスに対する 略称を返します

オーバーライド:

getServiceAbbreviation クラス内 AmazonWebServiceClient

関連項目:

ServiceAbbreviations

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.

定義:

getCachedResponseMetadata インタフェース内 AmazonCloudSearch

パラメータ:

request - The originally executed request

戻り値:

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