Interface AWSElasticsearch
- All Known Subinterfaces:
AWSElasticsearchAsync
- All Known Implementing Classes:
AbstractAWSElasticsearch
,AbstractAWSElasticsearchAsync
,AWSElasticsearchAsyncClient
,AWSElasticsearchClient
Use the Amazon Elasticsearch configuration API to create, configure, and manage Elasticsearch domains.
The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
-
Method Summary
Modifier and TypeMethodDescriptionaddTags
(AddTagsRequest addTagsRequest) Attaches tags to an existing Elasticsearch domain.createElasticsearchDomain
(CreateElasticsearchDomainRequest createElasticsearchDomainRequest) Creates a new Elasticsearch domain.deleteElasticsearchDomain
(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest) Permanently deletes the specified Elasticsearch domain and all of its data.describeElasticsearchDomain
(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest) Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.describeElasticsearchDomainConfig
(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest) Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.describeElasticsearchDomains
(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest) Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.listDomainNames
(ListDomainNamesRequest listDomainNamesRequest) Returns the name of all Elasticsearch domains owned by the current user's account.listTags
(ListTagsRequest listTagsRequest) Returns all tags for the given Elasticsearch domain.removeTags
(RemoveTagsRequest removeTagsRequest) Removes the specified set of tags from the specified Elasticsearch domain.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://es.us-east-1.amazonaws.com").void
An alternative tosetEndpoint(String)
, sets the regional endpoint for this client's service calls.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.updateElasticsearchDomainConfig
(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest) Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
-
Method Details
-
setEndpoint
Overrides the default endpoint for this client ("https://es.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: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Parameters:
endpoint
- The endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
An alternative tosetEndpoint(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. SeeRegion.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:
-
addTags
Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
- Parameters:
addTagsRequest
- Container for the parameters to theAddTags
operation. Specify the tags that you want to attach to the Elasticsearch domain.- Returns:
- Result of the AddTags operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.LimitExceededException
- An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
-
createElasticsearchDomain
CreateElasticsearchDomainResult createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest) Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
- Parameters:
createElasticsearchDomainRequest
-- Returns:
- Result of the CreateElasticsearchDomain operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.DisabledOperationException
- An error occured because the client wanted to access a not supported operation. Gives http status code of 409.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.InvalidTypeException
- An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.LimitExceededException
- An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.ResourceAlreadyExistsException
- An exception for creating a resource that already exists. Gives http status code of 400.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.
-
deleteElasticsearchDomain
DeleteElasticsearchDomainResult deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest) Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
- Parameters:
deleteElasticsearchDomainRequest
- Container for the parameters to theDeleteElasticsearchDomain
operation. Specifies the name of the Elasticsearch domain that you want to delete.- Returns:
- Result of the DeleteElasticsearchDomain operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.ResourceNotFoundException
- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.
-
describeElasticsearchDomain
DescribeElasticsearchDomainResult describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest) Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
- Parameters:
describeElasticsearchDomainRequest
- Container for the parameters to theDescribeElasticsearchDomain
operation.- Returns:
- Result of the DescribeElasticsearchDomain operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.ResourceNotFoundException
- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.
-
describeElasticsearchDomainConfig
DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest) Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
- Parameters:
describeElasticsearchDomainConfigRequest
- Container for the parameters to theDescribeElasticsearchDomainConfig
operation. Specifies the domain name for which you want configuration information.- Returns:
- Result of the DescribeElasticsearchDomainConfig operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.ResourceNotFoundException
- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.
-
describeElasticsearchDomains
DescribeElasticsearchDomainsResult describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest) Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
- Parameters:
describeElasticsearchDomainsRequest
- Container for the parameters to theDescribeElasticsearchDomains
operation. By default, the API returns the status of all Elasticsearch domains.- Returns:
- Result of the DescribeElasticsearchDomains operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.
-
listDomainNames
Returns the name of all Elasticsearch domains owned by the current user's account.
- Parameters:
listDomainNamesRequest
-- Returns:
- Result of the ListDomainNames operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.
-
listTags
Returns all tags for the given Elasticsearch domain.
- Parameters:
listTagsRequest
- Container for the parameters to theListTags
operation. Specify theARN
for the Elasticsearch domain to which the tags are attached that you want to view are attached.- Returns:
- Result of the ListTags operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.ResourceNotFoundException
- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
-
removeTags
Removes the specified set of tags from the specified Elasticsearch domain.
- Parameters:
removeTagsRequest
- Container for the parameters to theRemoveTags
operation. Specify theARN
for the Elasticsearch domain from which you want to remove the specifiedTagKey
.- Returns:
- Result of the RemoveTags operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
-
updateElasticsearchDomainConfig
UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest) Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
- Parameters:
updateElasticsearchDomainConfigRequest
- Container for the parameters to theUpdateElasticsearchDomain
operation. Specifies the type and number of instances in the domain cluster.- Returns:
- Result of the UpdateElasticsearchDomainConfig operation returned by the service.
- Throws:
BaseException
- An error occurred while processing the request.InternalException
- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.InvalidTypeException
- An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.LimitExceededException
- An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.ResourceNotFoundException
- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ValidationException
- An exception for missing / invalid input fields. Gives http status code of 400.
-
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
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.
-