@ThreadSafe @Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AWSElasticsearchClient extends AmazonWebServiceClient implements AWSElasticsearch
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.
LOGGING_AWS_REQUEST_METRIC ENDPOINT_PREFIX | Constructor and Description |
|---|
AWSElasticsearchClient ()
Deprecated.
|
AWSElasticsearchClient (AWSCredentials awsCredentials)
Deprecated.
use
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSElasticsearchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build(); |
AWSElasticsearchClient (AWSCredentials awsCredentials,
ClientConfiguration clientConfiguration)
|
AWSElasticsearchClient (AWSCredentialsProvider awsCredentialsProvider)
Deprecated.
|
AWSElasticsearchClient (AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration)
|
AWSElasticsearchClient (AWSCredentialsProvider awsCredentialsProvider,
ClientConfiguration clientConfiguration,
RequestMetricCollector requestMetricCollector)
|
AWSElasticsearchClient (ClientConfiguration clientConfiguration)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
AcceptInboundCrossClusterSearchConnectionResult |
acceptInboundCrossClusterSearchConnection (AcceptInboundCrossClusterSearchConnectionRequest request)
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
|
AddTagsResult |
addTags (AddTagsRequest request)
Attaches tags to an existing Elasticsearch domain.
|
AssociatePackageResult |
associatePackage (AssociatePackageRequest request)
Associates a package with an Amazon ES domain.
|
AuthorizeVpcEndpointAccessResult |
authorizeVpcEndpointAccess (AuthorizeVpcEndpointAccessRequest request)
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
|
static AWSElasticsearchClientBuilder |
builder () |
CancelDomainConfigChangeResult |
cancelDomainConfigChange (CancelDomainConfigChangeRequest request)
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
|
CancelElasticsearchServiceSoftwareUpdateResult |
cancelElasticsearchServiceSoftwareUpdate (CancelElasticsearchServiceSoftwareUpdateRequest request)
Cancels a scheduled service software update for an Amazon ES domain.
|
CreateElasticsearchDomainResult |
createElasticsearchDomain (CreateElasticsearchDomainRequest request)
Creates a new Elasticsearch domain.
|
CreateOutboundCrossClusterSearchConnectionResult |
createOutboundCrossClusterSearchConnection (CreateOutboundCrossClusterSearchConnectionRequest request)
Creates a new cross-cluster search connection from a source domain to a destination domain.
|
CreatePackageResult |
createPackage (CreatePackageRequest request)
Create a package for use with Amazon ES domains.
|
CreateVpcEndpointResult |
createVpcEndpoint (CreateVpcEndpointRequest request)
Creates an Amazon OpenSearch Service-managed VPC endpoint.
|
DeleteElasticsearchDomainResult |
deleteElasticsearchDomain (DeleteElasticsearchDomainRequest request)
Permanently deletes the specified Elasticsearch domain and all of its data.
|
DeleteElasticsearchServiceRoleResult |
deleteElasticsearchServiceRole (DeleteElasticsearchServiceRoleRequest request)
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
|
DeleteInboundCrossClusterSearchConnectionResult |
deleteInboundCrossClusterSearchConnection (DeleteInboundCrossClusterSearchConnectionRequest request)
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
|
DeleteOutboundCrossClusterSearchConnectionResult |
deleteOutboundCrossClusterSearchConnection (DeleteOutboundCrossClusterSearchConnectionRequest request)
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
|
DeletePackageResult |
deletePackage (DeletePackageRequest request)
Delete the package.
|
DeleteVpcEndpointResult |
deleteVpcEndpoint (DeleteVpcEndpointRequest request)
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
|
DescribeDomainAutoTunesResult |
describeDomainAutoTunes (DescribeDomainAutoTunesRequest request)
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type,
description, severity, and scheduled date.
|
DescribeDomainChangeProgressResult |
describeDomainChangeProgress (DescribeDomainChangeProgressRequest request)
Returns information about the current blue/green deployment happening on a domain, including a change ID, status,
and progress stages.
|
DescribeElasticsearchDomainResult |
describeElasticsearchDomain (DescribeElasticsearchDomainRequest request)
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID,
domain endpoint, and domain ARN.
|
DescribeElasticsearchDomainConfigResult |
describeElasticsearchDomainConfig (DescribeElasticsearchDomainConfigRequest request)
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation
date, update version, and update date for cluster options.
|
DescribeElasticsearchDomainsResult |
describeElasticsearchDomains (DescribeElasticsearchDomainsRequest request)
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID,
domain endpoint, and domain ARN.
|
DescribeElasticsearchInstanceTypeLimitsResult |
describeElasticsearchInstanceTypeLimits (DescribeElasticsearchInstanceTypeLimitsRequest request)
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
|
DescribeInboundCrossClusterSearchConnectionsResult |
describeInboundCrossClusterSearchConnections (DescribeInboundCrossClusterSearchConnectionsRequest request)
Lists all the inbound cross-cluster search connections for a destination domain.
|
DescribeOutboundCrossClusterSearchConnectionsResult |
describeOutboundCrossClusterSearchConnections (DescribeOutboundCrossClusterSearchConnectionsRequest request)
Lists all the outbound cross-cluster search connections for a source domain.
|
DescribePackagesResult |
describePackages (DescribePackagesRequest request)
Describes all packages available to Amazon ES.
|
DescribeReservedElasticsearchInstanceOfferingsResult |
describeReservedElasticsearchInstanceOfferings (DescribeReservedElasticsearchInstanceOfferingsRequest request)
Lists available reserved Elasticsearch instance offerings.
|
DescribeReservedElasticsearchInstancesResult |
describeReservedElasticsearchInstances (DescribeReservedElasticsearchInstancesRequest request)
Returns information about reserved Elasticsearch instances for this account.
|
DescribeVpcEndpointsResult |
describeVpcEndpoints (DescribeVpcEndpointsRequest request)
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
|
DissociatePackageResult |
dissociatePackage (DissociatePackageRequest request)
Dissociates a package from the Amazon ES 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.
|
GetCompatibleElasticsearchVersionsResult |
getCompatibleElasticsearchVersions (GetCompatibleElasticsearchVersionsRequest request)
Returns a list of upgrade compatible Elastisearch versions.
|
GetPackageVersionHistoryResult |
getPackageVersionHistory (GetPackageVersionHistoryRequest request)
Returns a list of versions of the package, along with their creation time and commit message.
|
GetUpgradeHistoryResult |
getUpgradeHistory (GetUpgradeHistoryRequest request)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
|
GetUpgradeStatusResult |
getUpgradeStatus (GetUpgradeStatusRequest request)
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
|
ListDomainNamesResult |
listDomainNames (ListDomainNamesRequest request)
Returns the name of all Elasticsearch domains owned by the current user's account.
|
ListDomainsForPackageResult |
listDomainsForPackage (ListDomainsForPackageRequest request)
Lists all Amazon ES domains associated with the package.
|
ListElasticsearchInstanceTypesResult |
listElasticsearchInstanceTypes (ListElasticsearchInstanceTypesRequest request)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
|
ListElasticsearchVersionsResult |
listElasticsearchVersions (ListElasticsearchVersionsRequest request)
List all supported Elasticsearch versions
|
ListPackagesForDomainResult |
listPackagesForDomain (ListPackagesForDomainRequest request)
Lists all packages associated with the Amazon ES domain.
|
ListTagsResult |
listTags (ListTagsRequest request)
Returns all tags for the given Elasticsearch domain.
|
ListVpcEndpointAccessResult |
listVpcEndpointAccess (ListVpcEndpointAccessRequest request)
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain
through the use of an interface VPC endpoint.
|
ListVpcEndpointsResult |
listVpcEndpoints (ListVpcEndpointsRequest request)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
|
ListVpcEndpointsForDomainResult |
listVpcEndpointsForDomain (ListVpcEndpointsForDomainRequest request)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
|
PurchaseReservedElasticsearchInstanceOfferingResult |
purchaseReservedElasticsearchInstanceOffering (PurchaseReservedElasticsearchInstanceOfferingRequest request)
Allows you to purchase reserved Elasticsearch instances.
|
RejectInboundCrossClusterSearchConnectionResult |
rejectInboundCrossClusterSearchConnection (RejectInboundCrossClusterSearchConnectionRequest request)
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
|
RemoveTagsResult |
removeTags (RemoveTagsRequest request)
Removes the specified set of tags from the specified Elasticsearch domain.
|
RevokeVpcEndpointAccessResult |
revokeVpcEndpointAccess (RevokeVpcEndpointAccessRequest request)
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
|
void |
shutdown ()
Shuts down this client object, releasing any resources that might be held
open.
|
StartElasticsearchServiceSoftwareUpdateResult |
startElasticsearchServiceSoftwareUpdate (StartElasticsearchServiceSoftwareUpdateRequest request)
Schedules a service software update for an Amazon ES domain.
|
UpdateElasticsearchDomainConfigResult |
updateElasticsearchDomainConfig (UpdateElasticsearchDomainConfigRequest request)
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type
and the number of instances.
|
UpdatePackageResult |
updatePackage (UpdatePackageRequest request)
Updates a package for use with Amazon ES domains.
|
UpdateVpcEndpointResult |
updateVpcEndpoint (UpdateVpcEndpointRequest request)
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
|
UpgradeElasticsearchDomainResult |
upgradeElasticsearchDomain (UpgradeElasticsearchDomainRequest request)
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch
version.
|
addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait setEndpoint, setRegion @Deprecated public AWSElasticsearchClient()
AWSElasticsearchClientBuilder.defaultClient() All service calls made using this new client object are blocking, and will not return until the service call completes.
DefaultAWSCredentialsProviderChain @Deprecated public AWSElasticsearchClient(ClientConfiguration clientConfiguration)
AwsClientBuilder.withClientConfiguration(ClientConfiguration) 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 Amazon Elasticsearch Service (ex:
proxy settings, retry counts, etc.).DefaultAWSCredentialsProviderChain @Deprecated public AWSElasticsearchClient(AWSCredentials awsCredentials)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) for example:
AWSElasticsearchClientBuilder.standard().withCredentials(new AWSStaticCredentialsProvider(awsCredentials)).build();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.@Deprecated public AWSElasticsearchClient(AWSCredentials awsCredentials, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) 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 Amazon Elasticsearch Service (ex:
proxy settings, retry counts, etc.).@Deprecated public AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) 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.@Deprecated public AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) 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 Amazon Elasticsearch Service (ex:
proxy settings, retry counts, etc.).@Deprecated public AWSElasticsearchClient(AWSCredentialsProvider awsCredentialsProvider, ClientConfiguration clientConfiguration, RequestMetricCollector requestMetricCollector)
AwsClientBuilder.withCredentials(AWSCredentialsProvider) and
AwsClientBuilder.withClientConfiguration(ClientConfiguration) and
AwsClientBuilder.withMetricsCollector(RequestMetricCollector) 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 Amazon Elasticsearch Service (ex:
proxy settings, retry counts, etc.).requestMetricCollector - optional request metric collectorpublic static AWSElasticsearchClientBuilder builder()
public AcceptInboundCrossClusterSearchConnectionResult acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest request)
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
acceptInboundCrossClusterSearchConnection in interface AWSElasticsearch acceptInboundCrossClusterSearchConnectionRequest - Container for the parameters to the AcceptInboundCrossClusterSearchConnection
operation.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public AddTagsResult addTags(AddTagsRequest request)
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.
addTags in interface AWSElasticsearch addTagsRequest - Container for the parameters to the AddTags operation. Specify the tags that you want
to attach to the Elasticsearch domain.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.public AssociatePackageResult associatePackage(AssociatePackageRequest request)
Associates a package with an Amazon ES domain.
associatePackage in interface AWSElasticsearch associatePackageRequest - Container for request parameters to AssociatePackage operation.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
status code 409.public AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request)
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
authorizeVpcEndpointAccess in interface AWSElasticsearch authorizeVpcEndpointAccessRequest - Container for request parameters to the AuthorizeVpcEndpointAccess operation.
Specifies the account to be permitted to manage VPC endpoints against the domain.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.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.BaseException - An error occurred while processing the request.public CancelDomainConfigChangeResult cancelDomainConfigChange(CancelDomainConfigChangeRequest request)
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
cancelDomainConfigChange in interface AWSElasticsearch cancelDomainConfigChangeRequest - Container for parameters of the CancelDomainConfigChange operation.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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public CancelElasticsearchServiceSoftwareUpdateResult cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest request)
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.
cancelElasticsearchServiceSoftwareUpdate in interface AWSElasticsearch 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.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.public CreateElasticsearchDomainResult createElasticsearchDomain(CreateElasticsearchDomainRequest request)
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
createElasticsearchDomain in interface AWSElasticsearch createElasticsearchDomainRequest - 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.public CreateOutboundCrossClusterSearchConnectionResult createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest request)
Creates a new cross-cluster search connection from a source domain to a destination domain.
createOutboundCrossClusterSearchConnection in interface AWSElasticsearch createOutboundCrossClusterSearchConnectionRequest - Container for the parameters to the CreateOutboundCrossClusterSearchConnection
operation.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. 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.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public CreatePackageResult createPackage(CreatePackageRequest request)
Create a package for use with Amazon ES domains.
createPackage in interface AWSElasticsearch createPackageRequest - Container for request parameters to CreatePackage operation.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.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives
http status code of 409.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
Creates an Amazon OpenSearch Service-managed VPC endpoint.
createVpcEndpoint in interface AWSElasticsearch createVpcEndpointRequest - Container for the parameters to the CreateVpcEndpointRequest operation.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
status code 409.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. 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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.BaseException - An error occurred while processing the request.public DeleteElasticsearchDomainResult deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request)
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
deleteElasticsearchDomain in interface AWSElasticsearch deleteElasticsearchDomainRequest - Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the
name of the Elasticsearch domain that you want to delete.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.public DeleteElasticsearchServiceRoleResult deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request)
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.
deleteElasticsearchServiceRole in interface AWSElasticsearch deleteElasticsearchServiceRoleRequest - 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.public DeleteInboundCrossClusterSearchConnectionResult deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest request)
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
deleteInboundCrossClusterSearchConnection in interface AWSElasticsearch deleteInboundCrossClusterSearchConnectionRequest - Container for the parameters to the DeleteInboundCrossClusterSearchConnection
operation.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public DeleteOutboundCrossClusterSearchConnectionResult deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest request)
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
deleteOutboundCrossClusterSearchConnection in interface AWSElasticsearch deleteOutboundCrossClusterSearchConnectionRequest - Container for the parameters to the DeleteOutboundCrossClusterSearchConnection
operation.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public DeletePackageResult deletePackage(DeletePackageRequest request)
Delete the package.
deletePackage in interface AWSElasticsearch deletePackageRequest - Container for request parameters to DeletePackage operation.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
status code 409.public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
deleteVpcEndpoint in interface AWSElasticsearch deleteVpcEndpointRequest - Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.BaseException - An error occurred while processing the request.public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
describeDomainAutoTunes in interface AWSElasticsearch describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.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.public DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
describeDomainChangeProgress in interface AWSElasticsearch describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the
domain name and optional change specific identity for which you want progress information.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.public DescribeElasticsearchDomainResult describeElasticsearchDomain(DescribeElasticsearchDomainRequest request)
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
describeElasticsearchDomain in interface AWSElasticsearch describeElasticsearchDomainRequest - Container for the parameters to the DescribeElasticsearchDomain operation.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.public DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request)
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
describeElasticsearchDomainConfig in interface AWSElasticsearch describeElasticsearchDomainConfigRequest - Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies
the domain name for which you want configuration information.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.public DescribeElasticsearchDomainsResult describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request)
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
describeElasticsearchDomains in interface AWSElasticsearch describeElasticsearchDomainsRequest - Container for the parameters to the DescribeElasticsearchDomains operation. By
default, the API returns the status of all Elasticsearch domains.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.public DescribeElasticsearchInstanceTypeLimitsResult describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request)
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain,
specify the DomainName to know what Limits are supported for modifying.
describeElasticsearchInstanceTypeLimits in interface AWSElasticsearch describeElasticsearchInstanceTypeLimitsRequest - Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.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.public DescribeInboundCrossClusterSearchConnectionsResult describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest request)
Lists all the inbound cross-cluster search connections for a destination domain.
describeInboundCrossClusterSearchConnections in interface AWSElasticsearch describeInboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeInboundCrossClusterSearchConnections
operation.InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an
HTTP status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public DescribeOutboundCrossClusterSearchConnectionsResult describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest request)
Lists all the outbound cross-cluster search connections for a source domain.
describeOutboundCrossClusterSearchConnections in interface AWSElasticsearch describeOutboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeOutboundCrossClusterSearchConnections
operation.InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an
HTTP status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public DescribePackagesResult describePackages(DescribePackagesRequest request)
Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
describePackages in interface AWSElasticsearch describePackagesRequest - Container for request parameters to DescribePackage operation.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.public DescribeReservedElasticsearchInstanceOfferingsResult describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest request)
Lists available reserved Elasticsearch instance offerings.
describeReservedElasticsearchInstanceOfferings in interface AWSElasticsearch describeReservedElasticsearchInstanceOfferingsRequest - Container for parameters to DescribeReservedElasticsearchInstanceOfferingsResourceNotFoundException - 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.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.public DescribeReservedElasticsearchInstancesResult describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest request)
Returns information about reserved Elasticsearch instances for this account.
describeReservedElasticsearchInstances in interface AWSElasticsearch describeReservedElasticsearchInstancesRequest - Container for parameters to DescribeReservedElasticsearchInstancesResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. 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.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
describeVpcEndpoints in interface AWSElasticsearch describeVpcEndpointsRequest - Container for request parameters to the DescribeVpcEndpoints operation. Specifies the
list of VPC endpoints to be described.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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.BaseException - An error occurred while processing the request.public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)
Dissociates a package from the Amazon ES domain.
dissociatePackage in interface AWSElasticsearch dissociatePackageRequest - Container for request parameters to DissociatePackage operation.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
status code 409.public GetCompatibleElasticsearchVersionsResult getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest request)
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.
getCompatibleElasticsearchVersions in interface AWSElasticsearch getCompatibleElasticsearchVersionsRequest - Container for request parameters to GetCompatibleElasticsearchVersions operation.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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)
Returns a list of versions of the package, along with their creation time and commit message.
getPackageVersionHistory in interface AWSElasticsearch getPackageVersionHistoryRequest - Container for request parameters to GetPackageVersionHistory operation.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
getUpgradeHistory in interface AWSElasticsearch getUpgradeHistoryRequest - Container for request parameters to GetUpgradeHistory operation.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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
getUpgradeStatus in interface AWSElasticsearch getUpgradeStatusRequest - Container for request parameters to GetUpgradeStatus operation.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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
Returns the name of all Elasticsearch domains owned by the current user's account.
listDomainNames in interface AWSElasticsearch listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.BaseException - An error occurred while processing the request.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)
Lists all Amazon ES domains associated with the package.
listDomainsForPackage in interface AWSElasticsearch listDomainsForPackageRequest - Container for request parameters to ListDomainsForPackage operation.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.public ListElasticsearchInstanceTypesResult listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request)
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
listElasticsearchInstanceTypes in interface AWSElasticsearch listElasticsearchInstanceTypesRequest - Container for the parameters to the ListElasticsearchInstanceTypes operation.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.public ListElasticsearchVersionsResult listElasticsearchVersions(ListElasticsearchVersionsRequest request)
List all supported Elasticsearch versions
listElasticsearchVersions in interface AWSElasticsearch 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.
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.public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)
Lists all packages associated with the Amazon ES domain.
listPackagesForDomain in interface AWSElasticsearch listPackagesForDomainRequest - Container for request parameters to ListPackagesForDomain operation.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.public ListTagsResult listTags(ListTagsRequest request)
Returns all tags for the given Elasticsearch domain.
listTags in interface AWSElasticsearch 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.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.public ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest request)
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
listVpcEndpointAccess in interface AWSElasticsearch listVpcEndpointAccessRequest - Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service
domain through the use of an interface VPC endpointResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.BaseException - An error occurred while processing the request.public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
listVpcEndpoints in interface AWSElasticsearch listVpcEndpointsRequest - Container for request parameters to the ListVpcEndpoints operation.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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.BaseException - An error occurred while processing the request.public ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
listVpcEndpointsForDomain in interface AWSElasticsearch listVpcEndpointsForDomainRequest - Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies
the domain whose VPC endpoints will be listed.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.DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.BaseException - An error occurred while processing the request.public PurchaseReservedElasticsearchInstanceOfferingResult purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest request)
Allows you to purchase reserved Elasticsearch instances.
purchaseReservedElasticsearchInstanceOffering in interface AWSElasticsearch purchaseReservedElasticsearchInstanceOfferingRequest - Container for parameters to PurchaseReservedElasticsearchInstanceOfferingResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of
409.DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.public RejectInboundCrossClusterSearchConnectionResult rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest request)
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
rejectInboundCrossClusterSearchConnection in interface AWSElasticsearch rejectInboundCrossClusterSearchConnectionRequest - Container for the parameters to the RejectInboundCrossClusterSearchConnection
operation.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of
409.public RemoveTagsResult removeTags(RemoveTagsRequest request)
Removes the specified set of tags from the specified Elasticsearch domain.
removeTags in interface AWSElasticsearch 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.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.public RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request)
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
revokeVpcEndpointAccess in interface AWSElasticsearch revokeVpcEndpointAccessRequest - Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.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.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.BaseException - An error occurred while processing the request.public StartElasticsearchServiceSoftwareUpdateResult startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest request)
Schedules a service software update for an Amazon ES domain.
startElasticsearchServiceSoftwareUpdate in interface AWSElasticsearch 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.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.public UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request)
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
updateElasticsearchDomainConfig in interface AWSElasticsearch updateElasticsearchDomainConfigRequest - Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the
type and number of instances in the domain cluster.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.public UpdatePackageResult updatePackage(UpdatePackageRequest request)
Updates a package for use with Amazon ES domains.
updatePackage in interface AWSElasticsearch updatePackageRequest - Container for request parameters to UpdatePackage operation.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.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.AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code
403.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
updateVpcEndpoint in interface AWSElasticsearch updateVpcEndpointRequest - Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP
status code 409.BaseException - An error occurred while processing the request.public UpgradeElasticsearchDomainResult upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest request)
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
upgradeElasticsearchDomain in interface AWSElasticsearch upgradeElasticsearchDomainRequest - Container for request parameters to UpgradeElasticsearchDomain operation.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.ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.DisabledOperationException - An error occured because the client wanted to access a not supported operation. 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.public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 in interface AWSElasticsearch request - The originally executed requestpublic void shutdown()
AmazonWebServiceClient shutdown in interface AWSElasticsearch shutdown in class AmazonWebServiceClient