com.amazonaws.services.elasticsearch.AWSElasticsearch Maven / Gradle / Ivy
Show all versions of aws-java-sdk-elasticsearch Show documentation
/*
* Copyright 2015-2020 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.elasticsearch;
import javax.annotation.Generated;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.elasticsearch.model.*;
/**
* Interface for accessing Amazon Elasticsearch Service.
*
* Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
* {@link com.amazonaws.services.elasticsearch.AbstractAWSElasticsearch} instead.
*
*
* Amazon Elasticsearch Configuration Service
*
* Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.
*
*
* For sample code that uses the Configuration API, see the Amazon
* Elasticsearch Service Developer Guide. The guide also contains sample code
* for sending signed HTTP requests to the Elasticsearch APIs.
*
*
* 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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSElasticsearch {
/**
* The region metadata service name for computing region endpoints. You can use this value to retrieve metadata
* (such as supported regions) of the service.
*
* @see RegionUtils#getRegionsForService(String)
*/
String ENDPOINT_PREFIX = "es";
/**
* 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 {@link ClientConfiguration} will be used, which by default is HTTPS.
*
* For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available
* endpoints for all AWS services, see: 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.
*
* @param 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.
* @deprecated use {@link AwsClientBuilder#setEndpointConfiguration(AwsClientBuilder.EndpointConfiguration)} for
* example:
* {@code builder.setEndpointConfiguration(new EndpointConfiguration(endpoint, signingRegion));}
*/
@Deprecated
void setEndpoint(String endpoint);
/**
* An alternative to {@link AWSElasticsearch#setEndpoint(String)}, sets the regional endpoint for this client's
* service calls. Callers can use this method to control which AWS region they want to work with.
*
* By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
* {@link ClientConfiguration} supplied at construction.
*
* This method is not threadsafe. A region should be configured when the client is created and before any service
* requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit
* or retrying.
*
* @param region
* The region this client will communicate with. See {@link Region#getRegion(com.amazonaws.regions.Regions)}
* for accessing a given region. Must not be null and must be a region where the service is available.
*
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
* @see Region#isServiceSupported(String)
* @deprecated use {@link AwsClientBuilder#setRegion(String)}
*/
@Deprecated
void setRegion(Region region);
/**
*
* 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.
*
*
* @param addTagsRequest
* Container for the parameters to the AddTags operation. Specify the tags that you want
* to attach to the Elasticsearch domain.
* @return Result of the AddTags operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws LimitExceededException
* An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
* 409.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.AddTags
*/
AddTagsResult addTags(AddTagsRequest addTagsRequest);
/**
*
* Associates a package with an Amazon ES domain.
*
*
* @param associatePackageRequest
* Container for request parameters to AssociatePackage operation.
* @return Result of the AssociatePackage operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws AccessDeniedException
* An error occurred because user does not have permissions to access the resource. Returns HTTP status code
* 403.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws ConflictException
* An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
* status code 409.
* @sample AWSElasticsearch.AssociatePackage
*/
AssociatePackageResult associatePackage(AssociatePackageRequest associatePackageRequest);
/**
*
* Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before
* the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE
* state.
*
*
* @param cancelElasticsearchServiceSoftwareUpdateRequest
* Container for the parameters to the CancelElasticsearchServiceSoftwareUpdate
* operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software
* update on.
* @return Result of the CancelElasticsearchServiceSoftwareUpdate operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.CancelElasticsearchServiceSoftwareUpdate
*/
CancelElasticsearchServiceSoftwareUpdateResult cancelElasticsearchServiceSoftwareUpdate(
CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest);
/**
*
* Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
*
*
* @param createElasticsearchDomainRequest
* @return Result of the CreateElasticsearchDomain operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @throws 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.
* @throws InvalidTypeException
* An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
* http status code of 409.
* @throws LimitExceededException
* An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
* 409.
* @throws ResourceAlreadyExistsException
* An exception for creating a resource that already exists. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.CreateElasticsearchDomain
*/
CreateElasticsearchDomainResult createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest);
/**
*
* Create a package for use with Amazon ES domains.
*
*
* @param createPackageRequest
* Container for request parameters to CreatePackage operation.
* @return Result of the CreatePackage operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws LimitExceededException
* An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
* 409.
* @throws InvalidTypeException
* An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
* http status code of 409.
* @throws ResourceAlreadyExistsException
* An exception for creating a resource that already exists. Gives http status code of 400.
* @throws AccessDeniedException
* An error occurred because user does not have permissions to access the resource. Returns HTTP status code
* 403.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.CreatePackage
*/
CreatePackageResult createPackage(CreatePackageRequest createPackageRequest);
/**
*
* Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot
* be recovered.
*
*
* @param deleteElasticsearchDomainRequest
* Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the
* name of the Elasticsearch domain that you want to delete.
* @return Result of the DeleteElasticsearchDomain operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.DeleteElasticsearchDomain
*/
DeleteElasticsearchDomainResult deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest);
/**
*
* Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion
* will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before
* deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service
* Domains.
*
*
* @param deleteElasticsearchServiceRoleRequest
* @return Result of the DeleteElasticsearchServiceRole operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.DeleteElasticsearchServiceRole
*/
DeleteElasticsearchServiceRoleResult deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest);
/**
*
* Delete the package.
*
*
* @param deletePackageRequest
* Container for request parameters to DeletePackage operation.
* @return Result of the DeletePackage operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws AccessDeniedException
* An error occurred because user does not have permissions to access the resource. Returns HTTP status code
* 403.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws ConflictException
* An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
* status code 409.
* @sample AWSElasticsearch.DeletePackage
*/
DeletePackageResult deletePackage(DeletePackageRequest deletePackageRequest);
/**
*
* Returns domain configuration information about the specified Elasticsearch domain, including the domain ID,
* domain endpoint, and domain ARN.
*
*
* @param describeElasticsearchDomainRequest
* Container for the parameters to the DescribeElasticsearchDomain operation.
* @return Result of the DescribeElasticsearchDomain operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.DescribeElasticsearchDomain
*/
DescribeElasticsearchDomainResult describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest);
/**
*
* Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation
* date, update version, and update date for cluster options.
*
*
* @param describeElasticsearchDomainConfigRequest
* Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies
* the domain name for which you want configuration information.
* @return Result of the DescribeElasticsearchDomainConfig operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.DescribeElasticsearchDomainConfig
*/
DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest);
/**
*
* Returns domain configuration information about the specified Elasticsearch domains, including the domain ID,
* domain endpoint, and domain ARN.
*
*
* @param describeElasticsearchDomainsRequest
* Container for the parameters to the DescribeElasticsearchDomains operation. By
* default, the API returns the status of all Elasticsearch domains.
* @return Result of the DescribeElasticsearchDomains operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.DescribeElasticsearchDomains
*/
DescribeElasticsearchDomainsResult describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest);
/**
*
* Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain,
* specify the DomainName to know what Limits are supported for modifying.
*
*
* @param describeElasticsearchInstanceTypeLimitsRequest
* Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.
* @return Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws InvalidTypeException
* An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
* http status code of 409.
* @throws LimitExceededException
* An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
* 409.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.DescribeElasticsearchInstanceTypeLimits
*/
DescribeElasticsearchInstanceTypeLimitsResult describeElasticsearchInstanceTypeLimits(
DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest);
/**
*
* Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results,
* and pagination.
*
*
* @param describePackagesRequest
* Container for request parameters to DescribePackage operation.
* @return Result of the DescribePackages operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws AccessDeniedException
* An error occurred because user does not have permissions to access the resource. Returns HTTP status code
* 403.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.DescribePackages
*/
DescribePackagesResult describePackages(DescribePackagesRequest describePackagesRequest);
/**
*
* Lists available reserved Elasticsearch instance offerings.
*
*
* @param describeReservedElasticsearchInstanceOfferingsRequest
* Container for parameters to DescribeReservedElasticsearchInstanceOfferings
* @return Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @throws 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.
* @sample AWSElasticsearch.DescribeReservedElasticsearchInstanceOfferings
*/
DescribeReservedElasticsearchInstanceOfferingsResult describeReservedElasticsearchInstanceOfferings(
DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest);
/**
*
* Returns information about reserved Elasticsearch instances for this account.
*
*
* @param describeReservedElasticsearchInstancesRequest
* Container for parameters to DescribeReservedElasticsearchInstances
* @return Result of the DescribeReservedElasticsearchInstances operation returned by the service.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws 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.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @sample AWSElasticsearch.DescribeReservedElasticsearchInstances
*/
DescribeReservedElasticsearchInstancesResult describeReservedElasticsearchInstances(
DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest);
/**
*
* Dissociates a package from the Amazon ES domain.
*
*
* @param dissociatePackageRequest
* Container for request parameters to DissociatePackage operation.
* @return Result of the DissociatePackage operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws AccessDeniedException
* An error occurred because user does not have permissions to access the resource. Returns HTTP status code
* 403.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws ConflictException
* An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
* status code 409.
* @sample AWSElasticsearch.DissociatePackage
*/
DissociatePackageResult dissociatePackage(DissociatePackageRequest dissociatePackageRequest);
/**
*
* Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
* DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
*
*
* @param getCompatibleElasticsearchVersionsRequest
* Container for request parameters to GetCompatibleElasticsearchVersions operation.
* @return Result of the GetCompatibleElasticsearchVersions operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.GetCompatibleElasticsearchVersions
*/
GetCompatibleElasticsearchVersionsResult getCompatibleElasticsearchVersions(
GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest);
/**
*
* Retrieves the complete history of the last 10 upgrades that were performed on the domain.
*
*
* @param getUpgradeHistoryRequest
* Container for request parameters to GetUpgradeHistory operation.
* @return Result of the GetUpgradeHistory operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.GetUpgradeHistory
*/
GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest);
/**
*
* Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
*
*
* @param getUpgradeStatusRequest
* Container for request parameters to GetUpgradeStatus operation.
* @return Result of the GetUpgradeStatus operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.GetUpgradeStatus
*/
GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest);
/**
*
* Returns the name of all Elasticsearch domains owned by the current user's account.
*
*
* @param listDomainNamesRequest
* @return Result of the ListDomainNames operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.ListDomainNames
*/
ListDomainNamesResult listDomainNames(ListDomainNamesRequest listDomainNamesRequest);
/**
*
* Lists all Amazon ES domains associated with the package.
*
*
* @param listDomainsForPackageRequest
* Container for request parameters to ListDomainsForPackage operation.
* @return Result of the ListDomainsForPackage operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws AccessDeniedException
* An error occurred because user does not have permissions to access the resource. Returns HTTP status code
* 403.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.ListDomainsForPackage
*/
ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest);
/**
*
* List all Elasticsearch instance types that are supported for given ElasticsearchVersion
*
*
* @param listElasticsearchInstanceTypesRequest
* Container for the parameters to the ListElasticsearchInstanceTypes operation.
* @return Result of the ListElasticsearchInstanceTypes operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.ListElasticsearchInstanceTypes
*/
ListElasticsearchInstanceTypesResult listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest);
/**
*
* List all supported Elasticsearch versions
*
*
* @param listElasticsearchVersionsRequest
* Container for the parameters to the ListElasticsearchVersions operation.
*
* Use MaxResults to control the maximum number of results to retrieve in a single
* call.
*
*
* Use NextToken in response to retrieve more results. If the received response does
* not contain a NextToken, then there are no more results to retrieve.
*
* @return Result of the ListElasticsearchVersions operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.ListElasticsearchVersions
*/
ListElasticsearchVersionsResult listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest);
/**
*
* Lists all packages associated with the Amazon ES domain.
*
*
* @param listPackagesForDomainRequest
* Container for request parameters to ListPackagesForDomain operation.
* @return Result of the ListPackagesForDomain operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws AccessDeniedException
* An error occurred because user does not have permissions to access the resource. Returns HTTP status code
* 403.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.ListPackagesForDomain
*/
ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest);
/**
*
* Returns all tags for the given Elasticsearch domain.
*
*
* @param listTagsRequest
* Container for the parameters to the ListTags operation. Specify the ARN
* for the Elasticsearch domain to which the tags are attached that you want to view are attached.
* @return Result of the ListTags operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.ListTags
*/
ListTagsResult listTags(ListTagsRequest listTagsRequest);
/**
*
* Allows you to purchase reserved Elasticsearch instances.
*
*
* @param purchaseReservedElasticsearchInstanceOfferingRequest
* Container for parameters to PurchaseReservedElasticsearchInstanceOffering
* @return Result of the PurchaseReservedElasticsearchInstanceOffering operation returned by the service.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ResourceAlreadyExistsException
* An exception for creating a resource that already exists. Gives http status code of 400.
* @throws LimitExceededException
* An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
* 409.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.PurchaseReservedElasticsearchInstanceOffering
*/
PurchaseReservedElasticsearchInstanceOfferingResult purchaseReservedElasticsearchInstanceOffering(
PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest);
/**
*
* Removes the specified set of tags from the specified Elasticsearch domain.
*
*
* @param removeTagsRequest
* Container for the parameters to the RemoveTags operation. Specify the ARN
* for the Elasticsearch domain from which you want to remove the specified TagKey.
* @return Result of the RemoveTags operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.RemoveTags
*/
RemoveTagsResult removeTags(RemoveTagsRequest removeTagsRequest);
/**
*
* Schedules a service software update for an Amazon ES domain.
*
*
* @param startElasticsearchServiceSoftwareUpdateRequest
* Container for the parameters to the StartElasticsearchServiceSoftwareUpdate operation.
* Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.
* @return Result of the StartElasticsearchServiceSoftwareUpdate operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.StartElasticsearchServiceSoftwareUpdate
*/
StartElasticsearchServiceSoftwareUpdateResult startElasticsearchServiceSoftwareUpdate(
StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest);
/**
*
* Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type
* and the number of instances.
*
*
* @param updateElasticsearchDomainConfigRequest
* Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the
* type and number of instances in the domain cluster.
* @return Result of the UpdateElasticsearchDomainConfig operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws 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.
* @throws InvalidTypeException
* An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
* http status code of 409.
* @throws LimitExceededException
* An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
* 409.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @sample AWSElasticsearch.UpdateElasticsearchDomainConfig
*/
UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest);
/**
*
* Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch
* version.
*
*
* @param upgradeElasticsearchDomainRequest
* Container for request parameters to UpgradeElasticsearchDomain operation.
* @return Result of the UpgradeElasticsearchDomain operation returned by the service.
* @throws BaseException
* An error occurred while processing the request.
* @throws ResourceNotFoundException
* An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
* @throws ResourceAlreadyExistsException
* An exception for creating a resource that already exists. Gives http status code of 400.
* @throws DisabledOperationException
* An error occured because the client wanted to access a not supported operation. Gives http status code of
* 409.
* @throws ValidationException
* An exception for missing / invalid input fields. Gives http status code of 400.
* @throws 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.
* @sample AWSElasticsearch.UpgradeElasticsearchDomain
*/
UpgradeElasticsearchDomainResult upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest);
/**
* Shuts down this client object, releasing any resources that might be held open. This is an optional method, and
* callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client
* has been shutdown, it should not be used to make any more requests.
*/
void shutdown();
/**
* Returns additional metadata for a previously executed successful request, typically used for debugging issues
* where a service isn't acting as expected. This data isn't considered part of the result data returned by an
* operation, so it's available through this separate, diagnostic interface.
*
* Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic
* information for an executed request, you should use this method to retrieve it as soon as possible after
* executing a request.
*
* @param request
* The originally executed request.
*
* @return The response metadata for the specified request, or null if none is available.
*/
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request);
}