AbstractAWSElasticsearch (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.elasticsearch.AbstractAWSElasticsearch

All Implemented Interfaces:

AWSElasticsearch

Direct Known Subclasses:

AbstractAWSElasticsearchAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSElasticsearch
extends Object
implements AWSElasticsearch
```
Abstract implementation of AWSElasticsearch. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.elasticsearch.AWSElasticsearch
  ENDPOINT_PREFIX

Method Summary

All Methods Instance Methods Concrete Methods
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.
`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`	`setEndpoint(String endpoint)` Overrides the default endpoint for this client ("https://es.us-east-1.amazonaws.com").
`void`	`setRegion(Region region)` An alternative to `AWSElasticsearch.setEndpoint(String)`, sets the regional endpoint for this client's service calls.
`void`	`shutdown()` Shuts down this client object, releasing any resources that might be held open.
`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.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - setEndpoint
```
public void setEndpoint(String endpoint)
```
    Description copied from interface: AWSElasticsearch
    
    Overrides the default endpoint for this client ("https://es.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.
    Callers can pass in just the endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's ClientConfiguration will be used, which by default is HTTPS.
    For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: 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.
    
    Specified by:
    
    setEndpoint in interface AWSElasticsearch
    
    Parameters:
    
    endpoint - The endpoint (ex: "es.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://es.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
  - setRegion
```
public void setRegion(Region region)
```
    Description copied from interface: AWSElasticsearch
    
    An alternative to 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 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.
    
    Specified by:
    
    setRegion in interface AWSElasticsearch
    
    Parameters:
    
    region - The region this client will communicate with. See Region.getRegion(com.amazonaws.regions.Regions) for accessing a given region. Must not be null and must be a region where the service is available.
    
    See Also:
    
    Region.getRegion(com.amazonaws.regions.Regions), Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration), Region.isServiceSupported(String)
  - acceptInboundCrossClusterSearchConnection
```
public AcceptInboundCrossClusterSearchConnectionResult acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Allows the destination domain owner to accept an inbound cross-cluster search connection request.
    
    Specified by:
    
    acceptInboundCrossClusterSearchConnection in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.
    
    Returns:
    
    Result of the AcceptInboundCrossClusterSearchConnection operation returned by the service.
  - addTags
```
public AddTagsResult addTags(AddTagsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    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.
    
    Specified by:
    
    addTags in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the AddTags operation. Specify the tags that you want to attach to the Elasticsearch domain.
    
    Returns:
    
    Result of the AddTags operation returned by the service.
  - associatePackage
```
public AssociatePackageResult associatePackage(AssociatePackageRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Associates a package with an Amazon ES domain.
    
    Specified by:
    
    associatePackage in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to AssociatePackage operation.
    
    Returns:
    
    Result of the AssociatePackage operation returned by the service.
  - authorizeVpcEndpointAccess
```
public AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
    
    Specified by:
    
    authorizeVpcEndpointAccess in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to the AuthorizeVpcEndpointAccess operation. Specifies the account to be permitted to manage VPC endpoints against the domain.
    
    Returns:
    
    Result of the AuthorizeVpcEndpointAccess operation returned by the service.
  - cancelDomainConfigChange
```
public CancelDomainConfigChangeResult cancelDomainConfigChange(CancelDomainConfigChangeRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Cancels a pending configuration change on an Amazon OpenSearch Service domain.
    
    Specified by:
    
    cancelDomainConfigChange in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for parameters of the CancelDomainConfigChange operation.
    
    Returns:
    
    Result of the CancelDomainConfigChange operation returned by the service.
  - cancelElasticsearchServiceSoftwareUpdate
```
public CancelElasticsearchServiceSoftwareUpdateResult cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    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.
    
    Specified by:
    
    cancelElasticsearchServiceSoftwareUpdate in interface AWSElasticsearch
    
    Parameters:
    
    request - 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.
    
    Returns:
    
    Result of the CancelElasticsearchServiceSoftwareUpdate operation returned by the service.
  - createElasticsearchDomain
```
public CreateElasticsearchDomainResult createElasticsearchDomain(CreateElasticsearchDomainRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
    
    Specified by:
    
    createElasticsearchDomain in interface AWSElasticsearch
    
    Returns:
    
    Result of the CreateElasticsearchDomain operation returned by the service.
  - createOutboundCrossClusterSearchConnection
```
public CreateOutboundCrossClusterSearchConnectionResult createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Creates a new cross-cluster search connection from a source domain to a destination domain.
    
    Specified by:
    
    createOutboundCrossClusterSearchConnection in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.
    
    Returns:
    
    Result of the CreateOutboundCrossClusterSearchConnection operation returned by the service.
  - createPackage
```
public CreatePackageResult createPackage(CreatePackageRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Create a package for use with Amazon ES domains.
    
    Specified by:
    
    createPackage in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to CreatePackage operation.
    
    Returns:
    
    Result of the CreatePackage operation returned by the service.
  - createVpcEndpoint
```
public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Creates an Amazon OpenSearch Service-managed VPC endpoint.
    
    Specified by:
    
    createVpcEndpoint in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the CreateVpcEndpointRequest operation.
    
    Returns:
    
    Result of the CreateVpcEndpoint operation returned by the service.
  - deleteElasticsearchDomain
```
public DeleteElasticsearchDomainResult deleteElasticsearchDomain(DeleteElasticsearchDomainRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
    
    Specified by:
    
    deleteElasticsearchDomain in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DeleteElasticsearchDomain operation. Specifies the name of the Elasticsearch domain that you want to delete.
    
    Returns:
    
    Result of the DeleteElasticsearchDomain operation returned by the service.
  - deleteElasticsearchServiceRole
```
public DeleteElasticsearchServiceRoleResult deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    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.
    
    Specified by:
    
    deleteElasticsearchServiceRole in interface AWSElasticsearch
    
    Returns:
    
    Result of the DeleteElasticsearchServiceRole operation returned by the service.
  - deleteInboundCrossClusterSearchConnection
```
public DeleteInboundCrossClusterSearchConnectionResult deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
    
    Specified by:
    
    deleteInboundCrossClusterSearchConnection in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.
    
    Returns:
    
    Result of the DeleteInboundCrossClusterSearchConnection operation returned by the service.
  - deleteOutboundCrossClusterSearchConnection
```
public DeleteOutboundCrossClusterSearchConnectionResult deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Allows the source domain owner to delete an existing outbound cross-cluster search connection.
    
    Specified by:
    
    deleteOutboundCrossClusterSearchConnection in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.
    
    Returns:
    
    Result of the DeleteOutboundCrossClusterSearchConnection operation returned by the service.
  - deletePackage
```
public DeletePackageResult deletePackage(DeletePackageRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Delete the package.
    
    Specified by:
    
    deletePackage in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to DeletePackage operation.
    
    Returns:
    
    Result of the DeletePackage operation returned by the service.
  - deleteVpcEndpoint
```
public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Specified by:
    
    deleteVpcEndpoint in interface AWSElasticsearch
    
    Parameters:
    
    request - Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Returns:
    
    Result of the DeleteVpcEndpoint operation returned by the service.
  - describeDomainAutoTunes
```
public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
    
    Specified by:
    
    describeDomainAutoTunes in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeDomainAutoTunes operation.
    
    Returns:
    
    Result of the DescribeDomainAutoTunes operation returned by the service.
  - describeDomainChangeProgress
```
public DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
    
    Specified by:
    
    describeDomainChangeProgress in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeDomainChangeProgress operation. Specifies the domain name and optional change specific identity for which you want progress information.
    
    Returns:
    
    Result of the DescribeDomainChangeProgress operation returned by the service.
  - describeElasticsearchDomain
```
public DescribeElasticsearchDomainResult describeElasticsearchDomain(DescribeElasticsearchDomainRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
    
    Specified by:
    
    describeElasticsearchDomain in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeElasticsearchDomain operation.
    
    Returns:
    
    Result of the DescribeElasticsearchDomain operation returned by the service.
  - describeElasticsearchDomainConfig
```
public DescribeElasticsearchDomainConfigResult describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
    
    Specified by:
    
    describeElasticsearchDomainConfig in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.
    
    Returns:
    
    Result of the DescribeElasticsearchDomainConfig operation returned by the service.
  - describeElasticsearchDomains
```
public DescribeElasticsearchDomainsResult describeElasticsearchDomains(DescribeElasticsearchDomainsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
    
    Specified by:
    
    describeElasticsearchDomains in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.
    
    Returns:
    
    Result of the DescribeElasticsearchDomains operation returned by the service.
  - describeElasticsearchInstanceTypeLimits
```
public DescribeElasticsearchInstanceTypeLimitsResult describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
    
    Specified by:
    
    describeElasticsearchInstanceTypeLimits in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.
    
    Returns:
    
    Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.
  - describeInboundCrossClusterSearchConnections
```
public DescribeInboundCrossClusterSearchConnectionsResult describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Lists all the inbound cross-cluster search connections for a destination domain.
    
    Specified by:
    
    describeInboundCrossClusterSearchConnections in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.
    
    Returns:
    
    Result of the DescribeInboundCrossClusterSearchConnections operation returned by the service.
  - describeOutboundCrossClusterSearchConnections
```
public DescribeOutboundCrossClusterSearchConnectionsResult describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Lists all the outbound cross-cluster search connections for a source domain.
    
    Specified by:
    
    describeOutboundCrossClusterSearchConnections in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.
    
    Returns:
    
    Result of the DescribeOutboundCrossClusterSearchConnections operation returned by the service.
  - describePackages
```
public DescribePackagesResult describePackages(DescribePackagesRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
    
    Specified by:
    
    describePackages in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to DescribePackage operation.
    
    Returns:
    
    Result of the DescribePackages operation returned by the service.
  - describeReservedElasticsearchInstanceOfferings
```
public DescribeReservedElasticsearchInstanceOfferingsResult describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Lists available reserved Elasticsearch instance offerings.
    
    Specified by:
    
    describeReservedElasticsearchInstanceOfferings in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for parameters to DescribeReservedElasticsearchInstanceOfferings
    
    Returns:
    
    Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.
  - describeReservedElasticsearchInstances
```
public DescribeReservedElasticsearchInstancesResult describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns information about reserved Elasticsearch instances for this account.
    
    Specified by:
    
    describeReservedElasticsearchInstances in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for parameters to DescribeReservedElasticsearchInstances
    
    Returns:
    
    Result of the DescribeReservedElasticsearchInstances operation returned by the service.
  - describeVpcEndpoints
```
public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
    
    Specified by:
    
    describeVpcEndpoints in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to the DescribeVpcEndpoints operation. Specifies the list of VPC endpoints to be described.
    
    Returns:
    
    Result of the DescribeVpcEndpoints operation returned by the service.
  - dissociatePackage
```
public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Dissociates a package from the Amazon ES domain.
    
    Specified by:
    
    dissociatePackage in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to DissociatePackage operation.
    
    Returns:
    
    Result of the DissociatePackage operation returned by the service.
  - getCompatibleElasticsearchVersions
```
public GetCompatibleElasticsearchVersionsResult getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    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.
    
    Specified by:
    
    getCompatibleElasticsearchVersions in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to GetCompatibleElasticsearchVersions operation.
    
    Returns:
    
    Result of the GetCompatibleElasticsearchVersions operation returned by the service.
  - getPackageVersionHistory
```
public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns a list of versions of the package, along with their creation time and commit message.
    
    Specified by:
    
    getPackageVersionHistory in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to GetPackageVersionHistory operation.
    
    Returns:
    
    Result of the GetPackageVersionHistory operation returned by the service.
  - getUpgradeHistory
```
public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Retrieves the complete history of the last 10 upgrades that were performed on the domain.
    
    Specified by:
    
    getUpgradeHistory in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to GetUpgradeHistory operation.
    
    Returns:
    
    Result of the GetUpgradeHistory operation returned by the service.
  - getUpgradeStatus
```
public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
    
    Specified by:
    
    getUpgradeStatus in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to GetUpgradeStatus operation.
    
    Returns:
    
    Result of the GetUpgradeStatus operation returned by the service.
  - listDomainNames
```
public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns the name of all Elasticsearch domains owned by the current user's account.
    
    Specified by:
    
    listDomainNames in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the ListDomainNames operation.
    
    Returns:
    
    Result of the ListDomainNames operation returned by the service.
  - listDomainsForPackage
```
public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Lists all Amazon ES domains associated with the package.
    
    Specified by:
    
    listDomainsForPackage in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to ListDomainsForPackage operation.
    
    Returns:
    
    Result of the ListDomainsForPackage operation returned by the service.
  - listElasticsearchInstanceTypes
```
public ListElasticsearchInstanceTypesResult listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    List all Elasticsearch instance types that are supported for given ElasticsearchVersion
    
    Specified by:
    
    listElasticsearchInstanceTypes in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the ListElasticsearchInstanceTypes operation.
    
    Returns:
    
    Result of the ListElasticsearchInstanceTypes operation returned by the service.
  - listElasticsearchVersions
```
public ListElasticsearchVersionsResult listElasticsearchVersions(ListElasticsearchVersionsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    List all supported Elasticsearch versions
    
    Specified by:
    
    listElasticsearchVersions in interface AWSElasticsearch
    
    Parameters:
    
    request - 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.
    
    Returns:
    
    Result of the ListElasticsearchVersions operation returned by the service.
  - listPackagesForDomain
```
public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Lists all packages associated with the Amazon ES domain.
    
    Specified by:
    
    listPackagesForDomain in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to ListPackagesForDomain operation.
    
    Returns:
    
    Result of the ListPackagesForDomain operation returned by the service.
  - listTags
```
public ListTagsResult listTags(ListTagsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Returns all tags for the given Elasticsearch domain.
    
    Specified by:
    
    listTags in interface AWSElasticsearch
    
    Parameters:
    
    request - 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.
    
    Returns:
    
    Result of the ListTags operation returned by the service.
  - listVpcEndpointAccess
```
public ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
    
    Specified by:
    
    listVpcEndpointAccess in interface AWSElasticsearch
    
    Parameters:
    
    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
    
    Returns:
    
    Result of the ListVpcEndpointAccess operation returned by the service.
  - listVpcEndpoints
```
public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
    
    Specified by:
    
    listVpcEndpoints in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to the ListVpcEndpoints operation.
    
    Returns:
    
    Result of the ListVpcEndpoints operation returned by the service.
  - listVpcEndpointsForDomain
```
public ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
    
    Specified by:
    
    listVpcEndpointsForDomain in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to the ListVpcEndpointsForDomain operation. Specifies the domain whose VPC endpoints will be listed.
    
    Returns:
    
    Result of the ListVpcEndpointsForDomain operation returned by the service.
  - purchaseReservedElasticsearchInstanceOffering
```
public PurchaseReservedElasticsearchInstanceOfferingResult purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Allows you to purchase reserved Elasticsearch instances.
    
    Specified by:
    
    purchaseReservedElasticsearchInstanceOffering in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for parameters to PurchaseReservedElasticsearchInstanceOffering
    
    Returns:
    
    Result of the PurchaseReservedElasticsearchInstanceOffering operation returned by the service.
  - rejectInboundCrossClusterSearchConnection
```
public RejectInboundCrossClusterSearchConnectionResult rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Allows the destination domain owner to reject an inbound cross-cluster search connection request.
    
    Specified by:
    
    rejectInboundCrossClusterSearchConnection in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.
    
    Returns:
    
    Result of the RejectInboundCrossClusterSearchConnection operation returned by the service.
  - removeTags
```
public RemoveTagsResult removeTags(RemoveTagsRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Removes the specified set of tags from the specified Elasticsearch domain.
    
    Specified by:
    
    removeTags in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the RemoveTags operation. Specify the ARN for the Elasticsearch domain from which you want to remove the specified TagKey.
    
    Returns:
    
    Result of the RemoveTags operation returned by the service.
  - revokeVpcEndpointAccess
```
public RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
    
    Specified by:
    
    revokeVpcEndpointAccess in interface AWSElasticsearch
    
    Parameters:
    
    request - Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
    
    Returns:
    
    Result of the RevokeVpcEndpointAccess operation returned by the service.
  - startElasticsearchServiceSoftwareUpdate
```
public StartElasticsearchServiceSoftwareUpdateResult startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Schedules a service software update for an Amazon ES domain.
    
    Specified by:
    
    startElasticsearchServiceSoftwareUpdate in interface AWSElasticsearch
    
    Parameters:
    
    request - 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.
    
    Returns:
    
    Result of the StartElasticsearchServiceSoftwareUpdate operation returned by the service.
  - updateElasticsearchDomainConfig
```
public UpdateElasticsearchDomainConfigResult updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
    
    Specified by:
    
    updateElasticsearchDomainConfig in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.
    
    Returns:
    
    Result of the UpdateElasticsearchDomainConfig operation returned by the service.
  - updatePackage
```
public UpdatePackageResult updatePackage(UpdatePackageRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Updates a package for use with Amazon ES domains.
    
    Specified by:
    
    updatePackage in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to UpdatePackage operation.
    
    Returns:
    
    Result of the UpdatePackage operation returned by the service.
  - updateVpcEndpoint
```
public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Specified by:
    
    updateVpcEndpoint in interface AWSElasticsearch
    
    Parameters:
    
    request - Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Returns:
    
    Result of the UpdateVpcEndpoint operation returned by the service.
  - upgradeElasticsearchDomain
```
public UpgradeElasticsearchDomainResult upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
    
    Specified by:
    
    upgradeElasticsearchDomain in interface AWSElasticsearch
    
    Parameters:
    
    request - Container for request parameters to UpgradeElasticsearchDomain operation.
    
    Returns:
    
    Result of the UpgradeElasticsearchDomain operation returned by the service.
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSElasticsearch
    
    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.
    
    Specified by:
    
    shutdown in interface AWSElasticsearch
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSElasticsearch
    
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSElasticsearch
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

AWS SDK for Java 1.x API Reference - 1.12.779

Class AbstractAWSElasticsearch

Field Summary

Fields inherited from interface com.amazonaws.services.elasticsearch.AWSElasticsearch

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setEndpoint

setRegion

acceptInboundCrossClusterSearchConnection

addTags

associatePackage

authorizeVpcEndpointAccess

cancelDomainConfigChange

cancelElasticsearchServiceSoftwareUpdate

createElasticsearchDomain

createOutboundCrossClusterSearchConnection

createPackage

createVpcEndpoint

deleteElasticsearchDomain

deleteElasticsearchServiceRole

deleteInboundCrossClusterSearchConnection

deleteOutboundCrossClusterSearchConnection

deletePackage

deleteVpcEndpoint

describeDomainAutoTunes

describeDomainChangeProgress

describeElasticsearchDomain

describeElasticsearchDomainConfig

describeElasticsearchDomains

describeElasticsearchInstanceTypeLimits

describeInboundCrossClusterSearchConnections

describeOutboundCrossClusterSearchConnections

describePackages

describeReservedElasticsearchInstanceOfferings

describeReservedElasticsearchInstances

describeVpcEndpoints

dissociatePackage

getCompatibleElasticsearchVersions

getPackageVersionHistory

getUpgradeHistory

getUpgradeStatus

listDomainNames

listDomainsForPackage

listElasticsearchInstanceTypes

listElasticsearchVersions

listPackagesForDomain

listTags

listVpcEndpointAccess

listVpcEndpoints

listVpcEndpointsForDomain

purchaseReservedElasticsearchInstanceOffering

rejectInboundCrossClusterSearchConnection

removeTags

revokeVpcEndpointAccess

startElasticsearchServiceSoftwareUpdate

updateElasticsearchDomainConfig

updatePackage

updateVpcEndpoint

upgradeElasticsearchDomain

shutdown

getCachedResponseMetadata