Package software.amazon.awssdk.services.elasticsearch

Interface ElasticsearchClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface ElasticsearchClient
extends AwsClient

Service client for accessing Amazon Elasticsearch Service. This can be created using the static builder() method. Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.

The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
default AcceptInboundCrossClusterSearchConnectionResponse	acceptInboundCrossClusterSearchConnection(Consumer<AcceptInboundCrossClusterSearchConnectionRequest.Builder> acceptInboundCrossClusterSearchConnectionRequest)	Allows the destination domain owner to accept an inbound cross-cluster search connection request.
default AcceptInboundCrossClusterSearchConnectionResponse	acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest acceptInboundCrossClusterSearchConnectionRequest)	Allows the destination domain owner to accept an inbound cross-cluster search connection request.
default AddTagsResponse	addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)	Attaches tags to an existing Elasticsearch domain.
default AddTagsResponse	addTags(AddTagsRequest addTagsRequest)	Attaches tags to an existing Elasticsearch domain.
default AssociatePackageResponse	associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest)	Associates a package with an Amazon ES domain.
default AssociatePackageResponse	associatePackage(AssociatePackageRequest associatePackageRequest)	Associates a package with an Amazon ES domain.
default AuthorizeVpcEndpointAccessResponse	authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest)	Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
default AuthorizeVpcEndpointAccessResponse	authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)	Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
static ElasticsearchClientBuilder	builder()	Create a builder that can be used to configure and create a ElasticsearchClient.
default CancelDomainConfigChangeResponse	cancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest)	Cancels a pending configuration change on an Amazon OpenSearch Service domain.
default CancelDomainConfigChangeResponse	cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest)	Cancels a pending configuration change on an Amazon OpenSearch Service domain.
default CancelElasticsearchServiceSoftwareUpdateResponse	cancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest)	Cancels a scheduled service software update for an Amazon ES domain.
default CancelElasticsearchServiceSoftwareUpdateResponse	cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest)	Cancels a scheduled service software update for an Amazon ES domain.
static ElasticsearchClient	create()	Create a ElasticsearchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateElasticsearchDomainResponse	createElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest)	Creates a new Elasticsearch domain.
default CreateElasticsearchDomainResponse	createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest)	Creates a new Elasticsearch domain.
default CreateOutboundCrossClusterSearchConnectionResponse	createOutboundCrossClusterSearchConnection(Consumer<CreateOutboundCrossClusterSearchConnectionRequest.Builder> createOutboundCrossClusterSearchConnectionRequest)	Creates a new cross-cluster search connection from a source domain to a destination domain.
default CreateOutboundCrossClusterSearchConnectionResponse	createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest createOutboundCrossClusterSearchConnectionRequest)	Creates a new cross-cluster search connection from a source domain to a destination domain.
default CreatePackageResponse	createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest)	Create a package for use with Amazon ES domains.
default CreatePackageResponse	createPackage(CreatePackageRequest createPackageRequest)	Create a package for use with Amazon ES domains.
default CreateVpcEndpointResponse	createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)	Creates an Amazon OpenSearch Service-managed VPC endpoint.
default CreateVpcEndpointResponse	createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)	Creates an Amazon OpenSearch Service-managed VPC endpoint.
default DeleteElasticsearchDomainResponse	deleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest)	Permanently deletes the specified Elasticsearch domain and all of its data.
default DeleteElasticsearchDomainResponse	deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest)	Permanently deletes the specified Elasticsearch domain and all of its data.
default DeleteElasticsearchServiceRoleResponse	deleteElasticsearchServiceRole()	Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
default DeleteElasticsearchServiceRoleResponse	deleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest)	Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
default DeleteElasticsearchServiceRoleResponse	deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest)	Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.
default DeleteInboundCrossClusterSearchConnectionResponse	deleteInboundCrossClusterSearchConnection(Consumer<DeleteInboundCrossClusterSearchConnectionRequest.Builder> deleteInboundCrossClusterSearchConnectionRequest)	Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
default DeleteInboundCrossClusterSearchConnectionResponse	deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest deleteInboundCrossClusterSearchConnectionRequest)	Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
default DeleteOutboundCrossClusterSearchConnectionResponse	deleteOutboundCrossClusterSearchConnection(Consumer<DeleteOutboundCrossClusterSearchConnectionRequest.Builder> deleteOutboundCrossClusterSearchConnectionRequest)	Allows the source domain owner to delete an existing outbound cross-cluster search connection.
default DeleteOutboundCrossClusterSearchConnectionResponse	deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest deleteOutboundCrossClusterSearchConnectionRequest)	Allows the source domain owner to delete an existing outbound cross-cluster search connection.
default DeletePackageResponse	deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest)	Delete the package.
default DeletePackageResponse	deletePackage(DeletePackageRequest deletePackageRequest)	Delete the package.
default DeleteVpcEndpointResponse	deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)	Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
default DeleteVpcEndpointResponse	deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)	Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
default DescribeDomainAutoTunesResponse	describeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)	Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
default DescribeDomainAutoTunesResponse	describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)	Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
default DescribeDomainAutoTunesIterable	describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)	This is a variant of describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest) operation.
default DescribeDomainAutoTunesIterable	describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)	This is a variant of describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest) operation.
default DescribeDomainChangeProgressResponse	describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest)	Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
default DescribeDomainChangeProgressResponse	describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)	Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
default DescribeElasticsearchDomainResponse	describeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest)	Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
default DescribeElasticsearchDomainResponse	describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest)	Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
default DescribeElasticsearchDomainConfigResponse	describeElasticsearchDomainConfig(Consumer<DescribeElasticsearchDomainConfigRequest.Builder> describeElasticsearchDomainConfigRequest)	Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
default DescribeElasticsearchDomainConfigResponse	describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest)	Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
default DescribeElasticsearchDomainsResponse	describeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest)	Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
default DescribeElasticsearchDomainsResponse	describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest)	Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
default DescribeElasticsearchInstanceTypeLimitsResponse	describeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest)	Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
default DescribeElasticsearchInstanceTypeLimitsResponse	describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest)	Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.
default DescribeInboundCrossClusterSearchConnectionsResponse	describeInboundCrossClusterSearchConnections(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest)	Lists all the inbound cross-cluster search connections for a destination domain.
default DescribeInboundCrossClusterSearchConnectionsResponse	describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest)	Lists all the inbound cross-cluster search connections for a destination domain.
default DescribeInboundCrossClusterSearchConnectionsIterable	describeInboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest)	This is a variant of describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest) operation.
default DescribeInboundCrossClusterSearchConnectionsIterable	describeInboundCrossClusterSearchConnectionsPaginator(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest)	This is a variant of describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest) operation.
default DescribeOutboundCrossClusterSearchConnectionsResponse	describeOutboundCrossClusterSearchConnections(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest)	Lists all the outbound cross-cluster search connections for a source domain.
default DescribeOutboundCrossClusterSearchConnectionsResponse	describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest)	Lists all the outbound cross-cluster search connections for a source domain.
default DescribeOutboundCrossClusterSearchConnectionsIterable	describeOutboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest)	This is a variant of describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest) operation.
default DescribeOutboundCrossClusterSearchConnectionsIterable	describeOutboundCrossClusterSearchConnectionsPaginator(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest)	This is a variant of describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest) operation.
default DescribePackagesResponse	describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)	Describes all packages available to Amazon ES.
default DescribePackagesResponse	describePackages(DescribePackagesRequest describePackagesRequest)	Describes all packages available to Amazon ES.
default DescribePackagesIterable	describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)	This is a variant of describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest) operation.
default DescribePackagesIterable	describePackagesPaginator(DescribePackagesRequest describePackagesRequest)	This is a variant of describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest) operation.
default DescribeReservedElasticsearchInstanceOfferingsResponse	describeReservedElasticsearchInstanceOfferings()	Lists available reserved Elasticsearch instance offerings.
default DescribeReservedElasticsearchInstanceOfferingsResponse	describeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)	Lists available reserved Elasticsearch instance offerings.
default DescribeReservedElasticsearchInstanceOfferingsResponse	describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)	Lists available reserved Elasticsearch instance offerings.
default DescribeReservedElasticsearchInstanceOfferingsIterable	describeReservedElasticsearchInstanceOfferingsPaginator()	This is a variant of describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation.
default DescribeReservedElasticsearchInstanceOfferingsIterable	describeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)	This is a variant of describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation.
default DescribeReservedElasticsearchInstanceOfferingsIterable	describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)	This is a variant of describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation.
default DescribeReservedElasticsearchInstancesResponse	describeReservedElasticsearchInstances()	Returns information about reserved Elasticsearch instances for this account.
default DescribeReservedElasticsearchInstancesResponse	describeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)	Returns information about reserved Elasticsearch instances for this account.
default DescribeReservedElasticsearchInstancesResponse	describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)	Returns information about reserved Elasticsearch instances for this account.
default DescribeReservedElasticsearchInstancesIterable	describeReservedElasticsearchInstancesPaginator()	This is a variant of describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation.
default DescribeReservedElasticsearchInstancesIterable	describeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)	This is a variant of describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation.
default DescribeReservedElasticsearchInstancesIterable	describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)	This is a variant of describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation.
default DescribeVpcEndpointsResponse	describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest)	Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
default DescribeVpcEndpointsResponse	describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)	Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
default DissociatePackageResponse	dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest)	Dissociates a package from the Amazon ES domain.
default DissociatePackageResponse	dissociatePackage(DissociatePackageRequest dissociatePackageRequest)	Dissociates a package from the Amazon ES domain.
default GetCompatibleElasticsearchVersionsResponse	getCompatibleElasticsearchVersions()	Returns a list of upgrade compatible Elastisearch versions.
default GetCompatibleElasticsearchVersionsResponse	getCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest)	Returns a list of upgrade compatible Elastisearch versions.
default GetCompatibleElasticsearchVersionsResponse	getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest)	Returns a list of upgrade compatible Elastisearch versions.
default GetPackageVersionHistoryResponse	getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)	Returns a list of versions of the package, along with their creation time and commit message.
default GetPackageVersionHistoryResponse	getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)	Returns a list of versions of the package, along with their creation time and commit message.
default GetPackageVersionHistoryIterable	getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)	This is a variant of getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest) operation.
default GetPackageVersionHistoryIterable	getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)	This is a variant of getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest) operation.
default GetUpgradeHistoryResponse	getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)	Retrieves the complete history of the last 10 upgrades that were performed on the domain.
default GetUpgradeHistoryResponse	getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)	Retrieves the complete history of the last 10 upgrades that were performed on the domain.
default GetUpgradeHistoryIterable	getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)	This is a variant of getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest) operation.
default GetUpgradeHistoryIterable	getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest)	This is a variant of getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest) operation.
default GetUpgradeStatusResponse	getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest)	Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
default GetUpgradeStatusResponse	getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)	Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
default ListDomainNamesResponse	listDomainNames()	Returns the name of all Elasticsearch domains owned by the current user's account.
default ListDomainNamesResponse	listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)	Returns the name of all Elasticsearch domains owned by the current user's account.
default ListDomainNamesResponse	listDomainNames(ListDomainNamesRequest listDomainNamesRequest)	Returns the name of all Elasticsearch domains owned by the current user's account.
default ListDomainsForPackageResponse	listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)	Lists all Amazon ES domains associated with the package.
default ListDomainsForPackageResponse	listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)	Lists all Amazon ES domains associated with the package.
default ListDomainsForPackageIterable	listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)	This is a variant of listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest) operation.
default ListDomainsForPackageIterable	listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest)	This is a variant of listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest) operation.
default ListElasticsearchInstanceTypesResponse	listElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)	List all Elasticsearch instance types that are supported for given ElasticsearchVersion
default ListElasticsearchInstanceTypesResponse	listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)	List all Elasticsearch instance types that are supported for given ElasticsearchVersion
default ListElasticsearchInstanceTypesIterable	listElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)	This is a variant of listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest) operation.
default ListElasticsearchInstanceTypesIterable	listElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)	This is a variant of listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest) operation.
default ListElasticsearchVersionsResponse	listElasticsearchVersions()	List all supported Elasticsearch versions
default ListElasticsearchVersionsResponse	listElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)	List all supported Elasticsearch versions
default ListElasticsearchVersionsResponse	listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)	List all supported Elasticsearch versions
default ListElasticsearchVersionsIterable	listElasticsearchVersionsPaginator()	This is a variant of listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation.
default ListElasticsearchVersionsIterable	listElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)	This is a variant of listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation.
default ListElasticsearchVersionsIterable	listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)	This is a variant of listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation.
default ListPackagesForDomainResponse	listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)	Lists all packages associated with the Amazon ES domain.
default ListPackagesForDomainResponse	listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)	Lists all packages associated with the Amazon ES domain.
default ListPackagesForDomainIterable	listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)	This is a variant of listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest) operation.
default ListPackagesForDomainIterable	listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest)	This is a variant of listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest) operation.
default ListTagsResponse	listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)	Returns all tags for the given Elasticsearch domain.
default ListTagsResponse	listTags(ListTagsRequest listTagsRequest)	Returns all tags for the given Elasticsearch domain.
default ListVpcEndpointAccessResponse	listVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest)	Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
default ListVpcEndpointAccessResponse	listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest)	Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
default ListVpcEndpointsResponse	listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)	Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
default ListVpcEndpointsResponse	listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)	Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
default ListVpcEndpointsForDomainResponse	listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest)	Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
default ListVpcEndpointsForDomainResponse	listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)	Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
default PurchaseReservedElasticsearchInstanceOfferingResponse	purchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest)	Allows you to purchase reserved Elasticsearch instances.
default PurchaseReservedElasticsearchInstanceOfferingResponse	purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest)	Allows you to purchase reserved Elasticsearch instances.
default RejectInboundCrossClusterSearchConnectionResponse	rejectInboundCrossClusterSearchConnection(Consumer<RejectInboundCrossClusterSearchConnectionRequest.Builder> rejectInboundCrossClusterSearchConnectionRequest)	Allows the destination domain owner to reject an inbound cross-cluster search connection request.
default RejectInboundCrossClusterSearchConnectionResponse	rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest rejectInboundCrossClusterSearchConnectionRequest)	Allows the destination domain owner to reject an inbound cross-cluster search connection request.
default RemoveTagsResponse	removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)	Removes the specified set of tags from the specified Elasticsearch domain.
default RemoveTagsResponse	removeTags(RemoveTagsRequest removeTagsRequest)	Removes the specified set of tags from the specified Elasticsearch domain.
default RevokeVpcEndpointAccessResponse	revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest)	Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
default RevokeVpcEndpointAccessResponse	revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)	Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
default ElasticsearchServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartElasticsearchServiceSoftwareUpdateResponse	startElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest)	Schedules a service software update for an Amazon ES domain.
default StartElasticsearchServiceSoftwareUpdateResponse	startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest)	Schedules a service software update for an Amazon ES domain.
default UpdateElasticsearchDomainConfigResponse	updateElasticsearchDomainConfig(Consumer<UpdateElasticsearchDomainConfigRequest.Builder> updateElasticsearchDomainConfigRequest)	Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
default UpdateElasticsearchDomainConfigResponse	updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest)	Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
default UpdatePackageResponse	updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest)	Updates a package for use with Amazon ES domains.
default UpdatePackageResponse	updatePackage(UpdatePackageRequest updatePackageRequest)	Updates a package for use with Amazon ES domains.
default UpdateVpcEndpointResponse	updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)	Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
default UpdateVpcEndpointResponse	updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)	Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
default UpgradeElasticsearchDomainResponse	upgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest)	Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
default UpgradeElasticsearchDomainResponse	upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest)	Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

acceptInboundCrossClusterSearchConnection

default AcceptInboundCrossClusterSearchConnectionResponse acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest acceptInboundCrossClusterSearchConnectionRequest)
                                                                                             throws ResourceNotFoundException,
LimitExceededException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

Parameters:

acceptInboundCrossClusterSearchConnectionRequest - Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

Returns:

Result of the AcceptInboundCrossClusterSearchConnection operation returned by the service.

acceptInboundCrossClusterSearchConnection

default AcceptInboundCrossClusterSearchConnectionResponse acceptInboundCrossClusterSearchConnection(Consumer<AcceptInboundCrossClusterSearchConnectionRequest.Builder> acceptInboundCrossClusterSearchConnectionRequest)
                                                                                             throws ResourceNotFoundException,
LimitExceededException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

This is a convenience which creates an instance of the AcceptInboundCrossClusterSearchConnectionRequest.Builder avoiding the need to create one manually via AcceptInboundCrossClusterSearchConnectionRequest.builder()

Parameters:

acceptInboundCrossClusterSearchConnectionRequest - A Consumer that will call methods on AcceptInboundCrossClusterSearchConnectionRequest.Builder to create a request. Container for the parameters to the AcceptInboundCrossClusterSearchConnection operation.

Returns:

Result of the AcceptInboundCrossClusterSearchConnection operation returned by the service.

addTags

default AddTagsResponse addTags(AddTagsRequest addTagsRequest)
                         throws BaseException,
LimitExceededException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

Parameters:

addTagsRequest - Container for the parameters to 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.

addTags

default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
                         throws BaseException,
LimitExceededException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

This is a convenience which creates an instance of the AddTagsRequest.Builder avoiding the need to create one manually via AddTagsRequest.builder()

Parameters:

addTagsRequest - A Consumer that will call methods on AddTagsRequest.Builder to create a 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

default AssociatePackageResponse associatePackage(AssociatePackageRequest associatePackageRequest)
                                           throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Associates a package with an Amazon ES domain.

Parameters:

associatePackageRequest - Container for request parameters to AssociatePackage operation.

Returns:

Result of the AssociatePackage operation returned by the service.

associatePackage

default AssociatePackageResponse associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest)
                                           throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Associates a package with an Amazon ES domain.

This is a convenience which creates an instance of the AssociatePackageRequest.Builder avoiding the need to create one manually via AssociatePackageRequest.builder()

Parameters:

associatePackageRequest - A Consumer that will call methods on AssociatePackageRequest.Builder to create a request. Container for request parameters to AssociatePackage operation.

Returns:

Result of the AssociatePackage operation returned by the service.

authorizeVpcEndpointAccess

default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)
                                                               throws ResourceNotFoundException,
DisabledOperationException,
LimitExceededException,
ValidationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Parameters:

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

authorizeVpcEndpointAccess

default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest)
                                                               throws ResourceNotFoundException,
DisabledOperationException,
LimitExceededException,
ValidationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

This is a convenience which creates an instance of the AuthorizeVpcEndpointAccessRequest.Builder avoiding the need to create one manually via AuthorizeVpcEndpointAccessRequest.builder()

Parameters:

authorizeVpcEndpointAccessRequest - A Consumer that will call methods on AuthorizeVpcEndpointAccessRequest.Builder to create a 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

default CancelDomainConfigChangeResponse cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest)
                                                           throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Parameters:

cancelDomainConfigChangeRequest - Container for parameters of the CancelDomainConfigChange operation.

Returns:

Result of the CancelDomainConfigChange operation returned by the service.

cancelDomainConfigChange

default CancelDomainConfigChangeResponse cancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest)
                                                           throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

This is a convenience which creates an instance of the CancelDomainConfigChangeRequest.Builder avoiding the need to create one manually via CancelDomainConfigChangeRequest.builder()

Parameters:

cancelDomainConfigChangeRequest - A Consumer that will call methods on CancelDomainConfigChangeRequest.Builder to create a request. Container for parameters of the CancelDomainConfigChange operation.

Returns:

Result of the CancelDomainConfigChange operation returned by the service.

cancelElasticsearchServiceSoftwareUpdate

default CancelElasticsearchServiceSoftwareUpdateResponse cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest)
                                                                                           throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

Parameters:

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.

Returns:

Result of the CancelElasticsearchServiceSoftwareUpdate operation returned by the service.

cancelElasticsearchServiceSoftwareUpdate

default CancelElasticsearchServiceSoftwareUpdateResponse cancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest)
                                                                                           throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

This is a convenience which creates an instance of the CancelElasticsearchServiceSoftwareUpdateRequest.Builder avoiding the need to create one manually via CancelElasticsearchServiceSoftwareUpdateRequest.builder()

Parameters:

cancelElasticsearchServiceSoftwareUpdateRequest - A Consumer that will call methods on CancelElasticsearchServiceSoftwareUpdateRequest.Builder to create a 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

default CreateElasticsearchDomainResponse createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest)
                                                             throws BaseException,
DisabledOperationException,
InternalException,
InvalidTypeException,
LimitExceededException,
ResourceAlreadyExistsException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Parameters:

createElasticsearchDomainRequest -

Returns:

Result of the CreateElasticsearchDomain operation returned by the service.

createElasticsearchDomain

default CreateElasticsearchDomainResponse createElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest)
                                                             throws BaseException,
DisabledOperationException,
InternalException,
InvalidTypeException,
LimitExceededException,
ResourceAlreadyExistsException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

This is a convenience which creates an instance of the CreateElasticsearchDomainRequest.Builder avoiding the need to create one manually via CreateElasticsearchDomainRequest.builder()

Parameters:

createElasticsearchDomainRequest - A Consumer that will call methods on CreateElasticsearchDomainRequest.Builder to create a request.

Returns:

Result of the CreateElasticsearchDomain operation returned by the service.

createOutboundCrossClusterSearchConnection

default CreateOutboundCrossClusterSearchConnectionResponse createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest createOutboundCrossClusterSearchConnectionRequest)
                                                                                               throws LimitExceededException,
InternalException,
ResourceAlreadyExistsException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Creates a new cross-cluster search connection from a source domain to a destination domain.

Parameters:

createOutboundCrossClusterSearchConnectionRequest - Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.

Returns:

Result of the CreateOutboundCrossClusterSearchConnection operation returned by the service.

createOutboundCrossClusterSearchConnection

default CreateOutboundCrossClusterSearchConnectionResponse createOutboundCrossClusterSearchConnection(Consumer<CreateOutboundCrossClusterSearchConnectionRequest.Builder> createOutboundCrossClusterSearchConnectionRequest)
                                                                                               throws LimitExceededException,
InternalException,
ResourceAlreadyExistsException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Creates a new cross-cluster search connection from a source domain to a destination domain.

This is a convenience which creates an instance of the CreateOutboundCrossClusterSearchConnectionRequest.Builder avoiding the need to create one manually via CreateOutboundCrossClusterSearchConnectionRequest.builder()

Parameters:

createOutboundCrossClusterSearchConnectionRequest - A Consumer that will call methods on CreateOutboundCrossClusterSearchConnectionRequest.Builder to create a request. Container for the parameters to the CreateOutboundCrossClusterSearchConnection operation.

Returns:

Result of the CreateOutboundCrossClusterSearchConnection operation returned by the service.

createPackage

default CreatePackageResponse createPackage(CreatePackageRequest createPackageRequest)
                                     throws BaseException,
InternalException,
LimitExceededException,
InvalidTypeException,
ResourceAlreadyExistsException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Create a package for use with Amazon ES domains.

Parameters:

createPackageRequest - Container for request parameters to CreatePackage operation.

Returns:

Result of the CreatePackage operation returned by the service.

createPackage

default CreatePackageResponse createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest)
                                     throws BaseException,
InternalException,
LimitExceededException,
InvalidTypeException,
ResourceAlreadyExistsException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Create a package for use with Amazon ES domains.

This is a convenience which creates an instance of the CreatePackageRequest.Builder avoiding the need to create one manually via CreatePackageRequest.builder()

Parameters:

createPackageRequest - A Consumer that will call methods on CreatePackageRequest.Builder to create a request. Container for request parameters to CreatePackage operation.

Returns:

Result of the CreatePackage operation returned by the service.

createVpcEndpoint

default CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
                                             throws ConflictException,
ValidationException,
LimitExceededException,
InternalException,
DisabledOperationException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Parameters:

createVpcEndpointRequest - Container for the parameters to the CreateVpcEndpointRequest operation.

Returns:

Result of the CreateVpcEndpoint operation returned by the service.

createVpcEndpoint

default CreateVpcEndpointResponse createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)
                                             throws ConflictException,
ValidationException,
LimitExceededException,
InternalException,
DisabledOperationException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Creates an Amazon OpenSearch Service-managed VPC endpoint.

This is a convenience which creates an instance of the CreateVpcEndpointRequest.Builder avoiding the need to create one manually via CreateVpcEndpointRequest.builder()

Parameters:

createVpcEndpointRequest - A Consumer that will call methods on CreateVpcEndpointRequest.Builder to create a request. Container for the parameters to the CreateVpcEndpointRequest operation.

Returns:

Result of the CreateVpcEndpoint operation returned by the service.

deleteElasticsearchDomain

default DeleteElasticsearchDomainResponse deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest)
                                                             throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

Parameters:

deleteElasticsearchDomainRequest - Container for the parameters to 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.

deleteElasticsearchDomain

default DeleteElasticsearchDomainResponse deleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest)
                                                             throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

This is a convenience which creates an instance of the DeleteElasticsearchDomainRequest.Builder avoiding the need to create one manually via DeleteElasticsearchDomainRequest.builder()

Parameters:

deleteElasticsearchDomainRequest - A Consumer that will call methods on DeleteElasticsearchDomainRequest.Builder to create a 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

default DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest)
                                                                       throws BaseException,
InternalException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

Parameters:

deleteElasticsearchServiceRoleRequest -

Returns:

Result of the DeleteElasticsearchServiceRole operation returned by the service.

deleteElasticsearchServiceRole

default DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest)
                                                                       throws BaseException,
InternalException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

This is a convenience which creates an instance of the DeleteElasticsearchServiceRoleRequest.Builder avoiding the need to create one manually via DeleteElasticsearchServiceRoleRequest.builder()

Parameters:

deleteElasticsearchServiceRoleRequest - A Consumer that will call methods on DeleteElasticsearchServiceRoleRequest.Builder to create a request.

Returns:

Result of the DeleteElasticsearchServiceRole operation returned by the service.

deleteElasticsearchServiceRole

default DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole()
                                                                       throws BaseException,
InternalException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

Returns:

Result of the DeleteElasticsearchServiceRole operation returned by the service.

See Also:

• deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest)

deleteInboundCrossClusterSearchConnection

default DeleteInboundCrossClusterSearchConnectionResponse deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest deleteInboundCrossClusterSearchConnectionRequest)
                                                                                             throws ResourceNotFoundException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

Parameters:

deleteInboundCrossClusterSearchConnectionRequest - Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

Returns:

Result of the DeleteInboundCrossClusterSearchConnection operation returned by the service.

deleteInboundCrossClusterSearchConnection

default DeleteInboundCrossClusterSearchConnectionResponse deleteInboundCrossClusterSearchConnection(Consumer<DeleteInboundCrossClusterSearchConnectionRequest.Builder> deleteInboundCrossClusterSearchConnectionRequest)
                                                                                             throws ResourceNotFoundException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

This is a convenience which creates an instance of the DeleteInboundCrossClusterSearchConnectionRequest.Builder avoiding the need to create one manually via DeleteInboundCrossClusterSearchConnectionRequest.builder()

Parameters:

deleteInboundCrossClusterSearchConnectionRequest - A Consumer that will call methods on DeleteInboundCrossClusterSearchConnectionRequest.Builder to create a request. Container for the parameters to the DeleteInboundCrossClusterSearchConnection operation.

Returns:

Result of the DeleteInboundCrossClusterSearchConnection operation returned by the service.

deleteOutboundCrossClusterSearchConnection

default DeleteOutboundCrossClusterSearchConnectionResponse deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest deleteOutboundCrossClusterSearchConnectionRequest)
                                                                                               throws ResourceNotFoundException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

Parameters:

deleteOutboundCrossClusterSearchConnectionRequest - Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

Returns:

Result of the DeleteOutboundCrossClusterSearchConnection operation returned by the service.

deleteOutboundCrossClusterSearchConnection

default DeleteOutboundCrossClusterSearchConnectionResponse deleteOutboundCrossClusterSearchConnection(Consumer<DeleteOutboundCrossClusterSearchConnectionRequest.Builder> deleteOutboundCrossClusterSearchConnectionRequest)
                                                                                               throws ResourceNotFoundException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

This is a convenience which creates an instance of the DeleteOutboundCrossClusterSearchConnectionRequest.Builder avoiding the need to create one manually via DeleteOutboundCrossClusterSearchConnectionRequest.builder()

Parameters:

deleteOutboundCrossClusterSearchConnectionRequest - A Consumer that will call methods on DeleteOutboundCrossClusterSearchConnectionRequest.Builder to create a request. Container for the parameters to the DeleteOutboundCrossClusterSearchConnection operation.

Returns:

Result of the DeleteOutboundCrossClusterSearchConnection operation returned by the service.

deletePackage

default DeletePackageResponse deletePackage(DeletePackageRequest deletePackageRequest)
                                     throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Delete the package.

Parameters:

deletePackageRequest - Container for request parameters to DeletePackage operation.

Returns:

Result of the DeletePackage operation returned by the service.

deletePackage

default DeletePackageResponse deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest)
                                     throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Delete the package.

This is a convenience which creates an instance of the DeletePackageRequest.Builder avoiding the need to create one manually via DeletePackageRequest.builder()

Parameters:

deletePackageRequest - A Consumer that will call methods on DeletePackageRequest.Builder to create a request. Container for request parameters to DeletePackage operation.

Returns:

Result of the DeletePackage operation returned by the service.

deleteVpcEndpoint

default DeleteVpcEndpointResponse deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)
                                             throws ResourceNotFoundException,
DisabledOperationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Parameters:

deleteVpcEndpointRequest - Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Returns:

Result of the DeleteVpcEndpoint operation returned by the service.

deleteVpcEndpoint

default DeleteVpcEndpointResponse deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)
                                             throws ResourceNotFoundException,
DisabledOperationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

This is a convenience which creates an instance of the DeleteVpcEndpointRequest.Builder avoiding the need to create one manually via DeleteVpcEndpointRequest.builder()

Parameters:

deleteVpcEndpointRequest - A Consumer that will call methods on DeleteVpcEndpointRequest.Builder to create a request. Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Returns:

Result of the DeleteVpcEndpoint operation returned by the service.

describeDomainAutoTunes

default DescribeDomainAutoTunesResponse describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)
                                                         throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

Parameters:

describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

Result of the DescribeDomainAutoTunes operation returned by the service.

describeDomainAutoTunes

default DescribeDomainAutoTunesResponse describeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)
                                                         throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

This is a convenience which creates an instance of the DescribeDomainAutoTunesRequest.Builder avoiding the need to create one manually via DescribeDomainAutoTunesRequest.builder()

Parameters:

describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a request. Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

Result of the DescribeDomainAutoTunes operation returned by the service.

describeDomainAutoTunesPaginator

default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)
                                                                  throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client
             .describeDomainAutoTunesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest) operation.

Parameters:

describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeDomainAutoTunesPaginator

default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)
                                                                  throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client
             .describeDomainAutoTunesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest) operation.

This is a convenience which creates an instance of the DescribeDomainAutoTunesRequest.Builder avoiding the need to create one manually via DescribeDomainAutoTunesRequest.builder()

Parameters:

describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a request. Container for the parameters to the DescribeDomainAutoTunes operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeDomainChangeProgress

default DescribeDomainChangeProgressResponse describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)
                                                                   throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

Parameters:

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

describeDomainChangeProgress

default DescribeDomainChangeProgressResponse describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest)
                                                                   throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

This is a convenience which creates an instance of the DescribeDomainChangeProgressRequest.Builder avoiding the need to create one manually via DescribeDomainChangeProgressRequest.builder()

Parameters:

describeDomainChangeProgressRequest - A Consumer that will call methods on DescribeDomainChangeProgressRequest.Builder to create a 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

default DescribeElasticsearchDomainResponse describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest)
                                                                 throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Parameters:

describeElasticsearchDomainRequest - Container for the parameters to the DescribeElasticsearchDomain operation.

Returns:

Result of the DescribeElasticsearchDomain operation returned by the service.

describeElasticsearchDomain

default DescribeElasticsearchDomainResponse describeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest)
                                                                 throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

This is a convenience which creates an instance of the DescribeElasticsearchDomainRequest.Builder avoiding the need to create one manually via DescribeElasticsearchDomainRequest.builder()

Parameters:

describeElasticsearchDomainRequest - A Consumer that will call methods on DescribeElasticsearchDomainRequest.Builder to create a request. Container for the parameters to the DescribeElasticsearchDomain operation.

Returns:

Result of the DescribeElasticsearchDomain operation returned by the service.

describeElasticsearchDomainConfig

default DescribeElasticsearchDomainConfigResponse describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest)
                                                                             throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

Parameters:

describeElasticsearchDomainConfigRequest - Container for the parameters to the DescribeElasticsearchDomainConfig operation. Specifies the domain name for which you want configuration information.

Returns:

Result of the DescribeElasticsearchDomainConfig operation returned by the service.

describeElasticsearchDomainConfig

default DescribeElasticsearchDomainConfigResponse describeElasticsearchDomainConfig(Consumer<DescribeElasticsearchDomainConfigRequest.Builder> describeElasticsearchDomainConfigRequest)
                                                                             throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

This is a convenience which creates an instance of the DescribeElasticsearchDomainConfigRequest.Builder avoiding the need to create one manually via DescribeElasticsearchDomainConfigRequest.builder()

Parameters:

describeElasticsearchDomainConfigRequest - A Consumer that will call methods on DescribeElasticsearchDomainConfigRequest.Builder to create a 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

default DescribeElasticsearchDomainsResponse describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest)
                                                                   throws BaseException,
InternalException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Parameters:

describeElasticsearchDomainsRequest - Container for the parameters to the DescribeElasticsearchDomains operation. By default, the API returns the status of all Elasticsearch domains.

Returns:

Result of the DescribeElasticsearchDomains operation returned by the service.

describeElasticsearchDomains

default DescribeElasticsearchDomainsResponse describeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest)
                                                                   throws BaseException,
InternalException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

This is a convenience which creates an instance of the DescribeElasticsearchDomainsRequest.Builder avoiding the need to create one manually via DescribeElasticsearchDomainsRequest.builder()

Parameters:

describeElasticsearchDomainsRequest - A Consumer that will call methods on DescribeElasticsearchDomainsRequest.Builder to create a 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

default DescribeElasticsearchInstanceTypeLimitsResponse describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest)
                                                                                         throws BaseException,
InternalException,
InvalidTypeException,
LimitExceededException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

Parameters:

describeElasticsearchInstanceTypeLimitsRequest - Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

Returns:

Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.

describeElasticsearchInstanceTypeLimits

default DescribeElasticsearchInstanceTypeLimitsResponse describeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest)
                                                                                         throws BaseException,
InternalException,
InvalidTypeException,
LimitExceededException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

This is a convenience which creates an instance of the DescribeElasticsearchInstanceTypeLimitsRequest.Builder avoiding the need to create one manually via DescribeElasticsearchInstanceTypeLimitsRequest.builder()

Parameters:

describeElasticsearchInstanceTypeLimitsRequest - A Consumer that will call methods on DescribeElasticsearchInstanceTypeLimitsRequest.Builder to create a request. Container for the parameters to DescribeElasticsearchInstanceTypeLimits operation.

Returns:

Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.

describeInboundCrossClusterSearchConnections

default DescribeInboundCrossClusterSearchConnectionsResponse describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest)
                                                                                                   throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all the inbound cross-cluster search connections for a destination domain.

Parameters:

describeInboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

Returns:

Result of the DescribeInboundCrossClusterSearchConnections operation returned by the service.

describeInboundCrossClusterSearchConnections

default DescribeInboundCrossClusterSearchConnectionsResponse describeInboundCrossClusterSearchConnections(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest)
                                                                                                   throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all the inbound cross-cluster search connections for a destination domain.

This is a convenience which creates an instance of the DescribeInboundCrossClusterSearchConnectionsRequest.Builder avoiding the need to create one manually via DescribeInboundCrossClusterSearchConnectionsRequest.builder()

Parameters:

describeInboundCrossClusterSearchConnectionsRequest - A Consumer that will call methods on DescribeInboundCrossClusterSearchConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

Returns:

Result of the DescribeInboundCrossClusterSearchConnections operation returned by the service.

describeInboundCrossClusterSearchConnectionsPaginator

default DescribeInboundCrossClusterSearchConnectionsIterable describeInboundCrossClusterSearchConnectionsPaginator(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest)
                                                                                                            throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client
             .describeInboundCrossClusterSearchConnectionsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest) operation.

Parameters:

describeInboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeInboundCrossClusterSearchConnectionsPaginator

default DescribeInboundCrossClusterSearchConnectionsIterable describeInboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest)
                                                                                                            throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client
             .describeInboundCrossClusterSearchConnectionsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest) operation.

This is a convenience which creates an instance of the DescribeInboundCrossClusterSearchConnectionsRequest.Builder avoiding the need to create one manually via DescribeInboundCrossClusterSearchConnectionsRequest.builder()

Parameters:

describeInboundCrossClusterSearchConnectionsRequest - A Consumer that will call methods on DescribeInboundCrossClusterSearchConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeInboundCrossClusterSearchConnections operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeOutboundCrossClusterSearchConnections

default DescribeOutboundCrossClusterSearchConnectionsResponse describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest)
                                                                                                     throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all the outbound cross-cluster search connections for a source domain.

Parameters:

describeOutboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

Returns:

Result of the DescribeOutboundCrossClusterSearchConnections operation returned by the service.

describeOutboundCrossClusterSearchConnections

default DescribeOutboundCrossClusterSearchConnectionsResponse describeOutboundCrossClusterSearchConnections(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest)
                                                                                                     throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all the outbound cross-cluster search connections for a source domain.

This is a convenience which creates an instance of the DescribeOutboundCrossClusterSearchConnectionsRequest.Builder avoiding the need to create one manually via DescribeOutboundCrossClusterSearchConnectionsRequest.builder()

Parameters:

describeOutboundCrossClusterSearchConnectionsRequest - A Consumer that will call methods on DescribeOutboundCrossClusterSearchConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

Returns:

Result of the DescribeOutboundCrossClusterSearchConnections operation returned by the service.

describeOutboundCrossClusterSearchConnectionsPaginator

default DescribeOutboundCrossClusterSearchConnectionsIterable describeOutboundCrossClusterSearchConnectionsPaginator(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest)
                                                                                                              throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client
             .describeOutboundCrossClusterSearchConnectionsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest) operation.

Parameters:

describeOutboundCrossClusterSearchConnectionsRequest - Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeOutboundCrossClusterSearchConnectionsPaginator

default DescribeOutboundCrossClusterSearchConnectionsIterable describeOutboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest)
                                                                                                              throws InvalidPaginationTokenException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client
             .describeOutboundCrossClusterSearchConnectionsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest) operation.

This is a convenience which creates an instance of the DescribeOutboundCrossClusterSearchConnectionsRequest.Builder avoiding the need to create one manually via DescribeOutboundCrossClusterSearchConnectionsRequest.builder()

Parameters:

describeOutboundCrossClusterSearchConnectionsRequest - A Consumer that will call methods on DescribeOutboundCrossClusterSearchConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeOutboundCrossClusterSearchConnections operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describePackages

default DescribePackagesResponse describePackages(DescribePackagesRequest describePackagesRequest)
                                           throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

Parameters:

describePackagesRequest - Container for request parameters to DescribePackage operation.

Returns:

Result of the DescribePackages operation returned by the service.

describePackages

default DescribePackagesResponse describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)
                                           throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

This is a convenience which creates an instance of the DescribePackagesRequest.Builder avoiding the need to create one manually via DescribePackagesRequest.builder()

Parameters:

describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request. Container for request parameters to DescribePackage operation.

Returns:

Result of the DescribePackages operation returned by the service.

describePackagesPaginator

default DescribePackagesIterable describePackagesPaginator(DescribePackagesRequest describePackagesRequest)
                                                    throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client
             .describePackagesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest) operation.

Parameters:

describePackagesRequest - Container for request parameters to DescribePackage operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describePackagesPaginator

default DescribePackagesIterable describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)
                                                    throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client
             .describePackagesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest) operation.

This is a convenience which creates an instance of the DescribePackagesRequest.Builder avoiding the need to create one manually via DescribePackagesRequest.builder()

Parameters:

describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request. Container for request parameters to DescribePackage operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeReservedElasticsearchInstanceOfferings

default DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)
                                                                                                       throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists available reserved Elasticsearch instance offerings.

Parameters:

describeReservedElasticsearchInstanceOfferingsRequest - Container for parameters to DescribeReservedElasticsearchInstanceOfferings

Returns:

Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.

describeReservedElasticsearchInstanceOfferings

default DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)
                                                                                                       throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists available reserved Elasticsearch instance offerings.

This is a convenience which creates an instance of the DescribeReservedElasticsearchInstanceOfferingsRequest.Builder avoiding the need to create one manually via DescribeReservedElasticsearchInstanceOfferingsRequest.builder()

Parameters:

describeReservedElasticsearchInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedElasticsearchInstanceOfferingsRequest.Builder to create a request. Container for parameters to DescribeReservedElasticsearchInstanceOfferings

Returns:

Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.

describeReservedElasticsearchInstanceOfferings

default DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings()
                                                                                                       throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists available reserved Elasticsearch instance offerings.

Returns:

Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.

See Also:

• describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest)

describeReservedElasticsearchInstanceOfferingsPaginator

default DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator()
                                                                                                                throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client
             .describeReservedElasticsearchInstanceOfferingsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest)

describeReservedElasticsearchInstanceOfferingsPaginator

default DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)
                                                                                                                throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client
             .describeReservedElasticsearchInstanceOfferingsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation.

Parameters:

describeReservedElasticsearchInstanceOfferingsRequest - Container for parameters to DescribeReservedElasticsearchInstanceOfferings

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeReservedElasticsearchInstanceOfferingsPaginator

default DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)
                                                                                                                throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client
             .describeReservedElasticsearchInstanceOfferingsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest) operation.

This is a convenience which creates an instance of the DescribeReservedElasticsearchInstanceOfferingsRequest.Builder avoiding the need to create one manually via DescribeReservedElasticsearchInstanceOfferingsRequest.builder()

Parameters:

describeReservedElasticsearchInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedElasticsearchInstanceOfferingsRequest.Builder to create a request. Container for parameters to DescribeReservedElasticsearchInstanceOfferings

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeReservedElasticsearchInstances

default DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)
                                                                                       throws ResourceNotFoundException,
InternalException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns information about reserved Elasticsearch instances for this account.

Parameters:

describeReservedElasticsearchInstancesRequest - Container for parameters to DescribeReservedElasticsearchInstances

Returns:

Result of the DescribeReservedElasticsearchInstances operation returned by the service.

describeReservedElasticsearchInstances

default DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)
                                                                                       throws ResourceNotFoundException,
InternalException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns information about reserved Elasticsearch instances for this account.

This is a convenience which creates an instance of the DescribeReservedElasticsearchInstancesRequest.Builder avoiding the need to create one manually via DescribeReservedElasticsearchInstancesRequest.builder()

Parameters:

describeReservedElasticsearchInstancesRequest - A Consumer that will call methods on DescribeReservedElasticsearchInstancesRequest.Builder to create a request. Container for parameters to DescribeReservedElasticsearchInstances

Returns:

Result of the DescribeReservedElasticsearchInstances operation returned by the service.

describeReservedElasticsearchInstances

default DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances()
                                                                                       throws ResourceNotFoundException,
InternalException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns information about reserved Elasticsearch instances for this account.

Returns:

Result of the DescribeReservedElasticsearchInstances operation returned by the service.

See Also:

• describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest)

describeReservedElasticsearchInstancesPaginator

default DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator()
                                                                                                throws ResourceNotFoundException,
InternalException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client
             .describeReservedElasticsearchInstancesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest)

describeReservedElasticsearchInstancesPaginator

default DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)
                                                                                                throws ResourceNotFoundException,
InternalException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client
             .describeReservedElasticsearchInstancesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation.

Parameters:

describeReservedElasticsearchInstancesRequest - Container for parameters to DescribeReservedElasticsearchInstances

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeReservedElasticsearchInstancesPaginator

default DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)
                                                                                                throws ResourceNotFoundException,
InternalException,
ValidationException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client
             .describeReservedElasticsearchInstancesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest) operation.

This is a convenience which creates an instance of the DescribeReservedElasticsearchInstancesRequest.Builder avoiding the need to create one manually via DescribeReservedElasticsearchInstancesRequest.builder()

Parameters:

describeReservedElasticsearchInstancesRequest - A Consumer that will call methods on DescribeReservedElasticsearchInstancesRequest.Builder to create a request. Container for parameters to DescribeReservedElasticsearchInstances

Returns:

A custom iterable that can be used to iterate through all the response pages.

describeVpcEndpoints

default DescribeVpcEndpointsResponse describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)
                                                   throws ValidationException,
InternalException,
DisabledOperationException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Parameters:

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

describeVpcEndpoints

default DescribeVpcEndpointsResponse describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest)
                                                   throws ValidationException,
InternalException,
DisabledOperationException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

This is a convenience which creates an instance of the DescribeVpcEndpointsRequest.Builder avoiding the need to create one manually via DescribeVpcEndpointsRequest.builder()

Parameters:

describeVpcEndpointsRequest - A Consumer that will call methods on DescribeVpcEndpointsRequest.Builder to create a 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

default DissociatePackageResponse dissociatePackage(DissociatePackageRequest dissociatePackageRequest)
                                             throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Dissociates a package from the Amazon ES domain.

Parameters:

dissociatePackageRequest - Container for request parameters to DissociatePackage operation.

Returns:

Result of the DissociatePackage operation returned by the service.

dissociatePackage

default DissociatePackageResponse dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest)
                                             throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
ConflictException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Dissociates a package from the Amazon ES domain.

This is a convenience which creates an instance of the DissociatePackageRequest.Builder avoiding the need to create one manually via DissociatePackageRequest.builder()

Parameters:

dissociatePackageRequest - A Consumer that will call methods on DissociatePackageRequest.Builder to create a request. Container for request parameters to DissociatePackage operation.

Returns:

Result of the DissociatePackage operation returned by the service.

getCompatibleElasticsearchVersions

default GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest)
                                                                               throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

Parameters:

getCompatibleElasticsearchVersionsRequest - Container for request parameters to GetCompatibleElasticsearchVersions operation.

Returns:

Result of the GetCompatibleElasticsearchVersions operation returned by the service.

getCompatibleElasticsearchVersions

default GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest)
                                                                               throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

This is a convenience which creates an instance of the GetCompatibleElasticsearchVersionsRequest.Builder avoiding the need to create one manually via GetCompatibleElasticsearchVersionsRequest.builder()

Parameters:

getCompatibleElasticsearchVersionsRequest - A Consumer that will call methods on GetCompatibleElasticsearchVersionsRequest.Builder to create a request. Container for request parameters to GetCompatibleElasticsearchVersions operation.

Returns:

Result of the GetCompatibleElasticsearchVersions operation returned by the service.

getCompatibleElasticsearchVersions

default GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions()
                                                                               throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

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.

Returns:

Result of the GetCompatibleElasticsearchVersions operation returned by the service.

See Also:

• getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest)

getPackageVersionHistory

default GetPackageVersionHistoryResponse getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)
                                                           throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns a list of versions of the package, along with their creation time and commit message.

Parameters:

getPackageVersionHistoryRequest - Container for request parameters to GetPackageVersionHistory operation.

Returns:

Result of the GetPackageVersionHistory operation returned by the service.

getPackageVersionHistory

default GetPackageVersionHistoryResponse getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)
                                                           throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns a list of versions of the package, along with their creation time and commit message.

This is a convenience which creates an instance of the GetPackageVersionHistoryRequest.Builder avoiding the need to create one manually via GetPackageVersionHistoryRequest.builder()

Parameters:

getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a request. Container for request parameters to GetPackageVersionHistory operation.

Returns:

Result of the GetPackageVersionHistory operation returned by the service.

getPackageVersionHistoryPaginator

default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)
                                                                    throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client
             .getPackageVersionHistoryPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest) operation.

Parameters:

getPackageVersionHistoryRequest - Container for request parameters to GetPackageVersionHistory operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getPackageVersionHistoryPaginator

default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)
                                                                    throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client
             .getPackageVersionHistoryPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest) operation.

This is a convenience which creates an instance of the GetPackageVersionHistoryRequest.Builder avoiding the need to create one manually via GetPackageVersionHistoryRequest.builder()

Parameters:

getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a request. Container for request parameters to GetPackageVersionHistory operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUpgradeHistory

default GetUpgradeHistoryResponse getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
                                             throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

Parameters:

getUpgradeHistoryRequest - Container for request parameters to GetUpgradeHistory operation.

Returns:

Result of the GetUpgradeHistory operation returned by the service.

getUpgradeHistory

default GetUpgradeHistoryResponse getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
                                             throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

This is a convenience which creates an instance of the GetUpgradeHistoryRequest.Builder avoiding the need to create one manually via GetUpgradeHistoryRequest.builder()

Parameters:

getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request. Container for request parameters to GetUpgradeHistory operation.

Returns:

Result of the GetUpgradeHistory operation returned by the service.

getUpgradeHistoryPaginator

default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
                                                      throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client
             .getUpgradeHistoryPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest) operation.

Parameters:

getUpgradeHistoryRequest - Container for request parameters to GetUpgradeHistory operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUpgradeHistoryPaginator

default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
                                                      throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client
             .getUpgradeHistoryPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest) operation.

This is a convenience which creates an instance of the GetUpgradeHistoryRequest.Builder avoiding the need to create one manually via GetUpgradeHistoryRequest.builder()

Parameters:

getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request. Container for request parameters to GetUpgradeHistory operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

getUpgradeStatus

default GetUpgradeStatusResponse getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)
                                           throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

Parameters:

getUpgradeStatusRequest - Container for request parameters to GetUpgradeStatus operation.

Returns:

Result of the GetUpgradeStatus operation returned by the service.

getUpgradeStatus

default GetUpgradeStatusResponse getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest)
                                           throws BaseException,
ResourceNotFoundException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

This is a convenience which creates an instance of the GetUpgradeStatusRequest.Builder avoiding the need to create one manually via GetUpgradeStatusRequest.builder()

Parameters:

getUpgradeStatusRequest - A Consumer that will call methods on GetUpgradeStatusRequest.Builder to create a request. Container for request parameters to GetUpgradeStatus operation.

Returns:

Result of the GetUpgradeStatus operation returned by the service.

listDomainNames

default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
                                         throws BaseException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns the name of all Elasticsearch domains owned by the current user's account.

Parameters:

listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.

Returns:

Result of the ListDomainNames operation returned by the service.

listDomainNames

default ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)
                                         throws BaseException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns the name of all Elasticsearch domains owned by the current user's account.

This is a convenience which creates an instance of the ListDomainNamesRequest.Builder avoiding the need to create one manually via ListDomainNamesRequest.builder()

Parameters:

listDomainNamesRequest - A Consumer that will call methods on ListDomainNamesRequest.Builder to create a request. Container for the parameters to the ListDomainNames operation.

Returns:

Result of the ListDomainNames operation returned by the service.

listDomainNames

default ListDomainNamesResponse listDomainNames()
                                         throws BaseException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns the name of all Elasticsearch domains owned by the current user's account.

Returns:

Result of the ListDomainNames operation returned by the service.

See Also:

• listDomainNames(ListDomainNamesRequest)

listDomainsForPackage

default ListDomainsForPackageResponse listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)
                                                     throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all Amazon ES domains associated with the package.

Parameters:

listDomainsForPackageRequest - Container for request parameters to ListDomainsForPackage operation.

Returns:

Result of the ListDomainsForPackage operation returned by the service.

listDomainsForPackage

default ListDomainsForPackageResponse listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)
                                                     throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all Amazon ES domains associated with the package.

This is a convenience which creates an instance of the ListDomainsForPackageRequest.Builder avoiding the need to create one manually via ListDomainsForPackageRequest.builder()

Parameters:

listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a request. Container for request parameters to ListDomainsForPackage operation.

Returns:

Result of the ListDomainsForPackage operation returned by the service.

listDomainsForPackagePaginator

default ListDomainsForPackageIterable listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest)
                                                              throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client
             .listDomainsForPackagePaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest) operation.

Parameters:

listDomainsForPackageRequest - Container for request parameters to ListDomainsForPackage operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listDomainsForPackagePaginator

default ListDomainsForPackageIterable listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)
                                                              throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client
             .listDomainsForPackagePaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest) operation.

This is a convenience which creates an instance of the ListDomainsForPackageRequest.Builder avoiding the need to create one manually via ListDomainsForPackageRequest.builder()

Parameters:

listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a request. Container for request parameters to ListDomainsForPackage operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listElasticsearchInstanceTypes

default ListElasticsearchInstanceTypesResponse listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)
                                                                       throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Parameters:

listElasticsearchInstanceTypesRequest - Container for the parameters to the ListElasticsearchInstanceTypes operation.

Returns:

Result of the ListElasticsearchInstanceTypes operation returned by the service.

listElasticsearchInstanceTypes

default ListElasticsearchInstanceTypesResponse listElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)
                                                                       throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

This is a convenience which creates an instance of the ListElasticsearchInstanceTypesRequest.Builder avoiding the need to create one manually via ListElasticsearchInstanceTypesRequest.builder()

Parameters:

listElasticsearchInstanceTypesRequest - A Consumer that will call methods on ListElasticsearchInstanceTypesRequest.Builder to create a request. Container for the parameters to the ListElasticsearchInstanceTypes operation.

Returns:

Result of the ListElasticsearchInstanceTypes operation returned by the service.

listElasticsearchInstanceTypesPaginator

default ListElasticsearchInstanceTypesIterable listElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)
                                                                                throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client
             .listElasticsearchInstanceTypesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest) operation.

Parameters:

listElasticsearchInstanceTypesRequest - Container for the parameters to the ListElasticsearchInstanceTypes operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listElasticsearchInstanceTypesPaginator

default ListElasticsearchInstanceTypesIterable listElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)
                                                                                throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client
             .listElasticsearchInstanceTypesPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest) operation.

This is a convenience which creates an instance of the ListElasticsearchInstanceTypesRequest.Builder avoiding the need to create one manually via ListElasticsearchInstanceTypesRequest.builder()

Parameters:

listElasticsearchInstanceTypesRequest - A Consumer that will call methods on ListElasticsearchInstanceTypesRequest.Builder to create a request. Container for the parameters to the ListElasticsearchInstanceTypes operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listElasticsearchVersions

default ListElasticsearchVersionsResponse listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)
                                                             throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

List all supported Elasticsearch versions

Parameters:

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.

Returns:

Result of the ListElasticsearchVersions operation returned by the service.

listElasticsearchVersions

default ListElasticsearchVersionsResponse listElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)
                                                             throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

List all supported Elasticsearch versions

This is a convenience which creates an instance of the ListElasticsearchVersionsRequest.Builder avoiding the need to create one manually via ListElasticsearchVersionsRequest.builder()

Parameters:

listElasticsearchVersionsRequest - A Consumer that will call methods on ListElasticsearchVersionsRequest.Builder to create a 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.

listElasticsearchVersions

default ListElasticsearchVersionsResponse listElasticsearchVersions()
                                                             throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

List all supported Elasticsearch versions

Returns:

Result of the ListElasticsearchVersions operation returned by the service.

See Also:

• listElasticsearchVersions(ListElasticsearchVersionsRequest)

listElasticsearchVersionsPaginator

default ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator()
                                                                      throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client
             .listElasticsearchVersionsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest)

listElasticsearchVersionsPaginator

default ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)
                                                                      throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client
             .listElasticsearchVersionsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation.

Parameters:

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.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listElasticsearchVersionsPaginator

default ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)
                                                                      throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client
             .listElasticsearchVersionsPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest) operation.

This is a convenience which creates an instance of the ListElasticsearchVersionsRequest.Builder avoiding the need to create one manually via ListElasticsearchVersionsRequest.builder()

Parameters:

listElasticsearchVersionsRequest - A Consumer that will call methods on ListElasticsearchVersionsRequest.Builder to create a 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:

A custom iterable that can be used to iterate through all the response pages.

listPackagesForDomain

default ListPackagesForDomainResponse listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)
                                                     throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all packages associated with the Amazon ES domain.

Parameters:

listPackagesForDomainRequest - Container for request parameters to ListPackagesForDomain operation.

Returns:

Result of the ListPackagesForDomain operation returned by the service.

listPackagesForDomain

default ListPackagesForDomainResponse listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)
                                                     throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Lists all packages associated with the Amazon ES domain.

This is a convenience which creates an instance of the ListPackagesForDomainRequest.Builder avoiding the need to create one manually via ListPackagesForDomainRequest.builder()

Parameters:

listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a request. Container for request parameters to ListPackagesForDomain operation.

Returns:

Result of the ListPackagesForDomain operation returned by the service.

listPackagesForDomainPaginator

default ListPackagesForDomainIterable listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest)
                                                              throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client
             .listPackagesForDomainPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest) operation.

Parameters:

listPackagesForDomainRequest - Container for request parameters to ListPackagesForDomain operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listPackagesForDomainPaginator

default ListPackagesForDomainIterable listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)
                                                              throws BaseException,
InternalException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

This is a variant of listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client
             .listPackagesForDomainPaginator(request);
     for (software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest) operation.

This is a convenience which creates an instance of the ListPackagesForDomainRequest.Builder avoiding the need to create one manually via ListPackagesForDomainRequest.builder()

Parameters:

listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a request. Container for request parameters to ListPackagesForDomain operation.

Returns:

A custom iterable that can be used to iterate through all the response pages.

listTags

default ListTagsResponse listTags(ListTagsRequest listTagsRequest)
                           throws BaseException,
ResourceNotFoundException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns all tags for the given Elasticsearch domain.

Parameters:

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.

Returns:

Result of the ListTags operation returned by the service.

listTags

default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
                           throws BaseException,
ResourceNotFoundException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Returns all tags for the given Elasticsearch domain.

This is a convenience which creates an instance of the ListTagsRequest.Builder avoiding the need to create one manually via ListTagsRequest.builder()

Parameters:

listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a 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

default ListVpcEndpointAccessResponse listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest)
                                                     throws ResourceNotFoundException,
DisabledOperationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Parameters:

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

listVpcEndpointAccess

default ListVpcEndpointAccessResponse listVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest)
                                                     throws ResourceNotFoundException,
DisabledOperationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

This is a convenience which creates an instance of the ListVpcEndpointAccessRequest.Builder avoiding the need to create one manually via ListVpcEndpointAccessRequest.builder()

Parameters:

listVpcEndpointAccessRequest - A Consumer that will call methods on ListVpcEndpointAccessRequest.Builder to create a 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

default ListVpcEndpointsResponse listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)
                                           throws InternalException,
DisabledOperationException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

Parameters:

listVpcEndpointsRequest - Container for request parameters to the ListVpcEndpoints operation.

Returns:

Result of the ListVpcEndpoints operation returned by the service.

listVpcEndpoints

default ListVpcEndpointsResponse listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
                                           throws InternalException,
DisabledOperationException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

This is a convenience which creates an instance of the ListVpcEndpointsRequest.Builder avoiding the need to create one manually via ListVpcEndpointsRequest.builder()

Parameters:

listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request. Container for request parameters to the ListVpcEndpoints operation.

Returns:

Result of the ListVpcEndpoints operation returned by the service.

listVpcEndpointsForDomain

default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)
                                                             throws InternalException,
DisabledOperationException,
ResourceNotFoundException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Parameters:

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

listVpcEndpointsForDomain

default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest)
                                                             throws InternalException,
DisabledOperationException,
ResourceNotFoundException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

This is a convenience which creates an instance of the ListVpcEndpointsForDomainRequest.Builder avoiding the need to create one manually via ListVpcEndpointsForDomainRequest.builder()

Parameters:

listVpcEndpointsForDomainRequest - A Consumer that will call methods on ListVpcEndpointsForDomainRequest.Builder to create a 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

default PurchaseReservedElasticsearchInstanceOfferingResponse purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest)
                                                                                                     throws ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows you to purchase reserved Elasticsearch instances.

Parameters:

purchaseReservedElasticsearchInstanceOfferingRequest - Container for parameters to PurchaseReservedElasticsearchInstanceOffering

Returns:

Result of the PurchaseReservedElasticsearchInstanceOffering operation returned by the service.

purchaseReservedElasticsearchInstanceOffering

default PurchaseReservedElasticsearchInstanceOfferingResponse purchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest)
                                                                                                     throws ResourceNotFoundException,
ResourceAlreadyExistsException,
LimitExceededException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows you to purchase reserved Elasticsearch instances.

This is a convenience which creates an instance of the PurchaseReservedElasticsearchInstanceOfferingRequest.Builder avoiding the need to create one manually via PurchaseReservedElasticsearchInstanceOfferingRequest.builder()

Parameters:

purchaseReservedElasticsearchInstanceOfferingRequest - A Consumer that will call methods on PurchaseReservedElasticsearchInstanceOfferingRequest.Builder to create a request. Container for parameters to PurchaseReservedElasticsearchInstanceOffering

Returns:

Result of the PurchaseReservedElasticsearchInstanceOffering operation returned by the service.

rejectInboundCrossClusterSearchConnection

default RejectInboundCrossClusterSearchConnectionResponse rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest rejectInboundCrossClusterSearchConnectionRequest)
                                                                                             throws ResourceNotFoundException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Parameters:

rejectInboundCrossClusterSearchConnectionRequest - Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

Returns:

Result of the RejectInboundCrossClusterSearchConnection operation returned by the service.

rejectInboundCrossClusterSearchConnection

default RejectInboundCrossClusterSearchConnectionResponse rejectInboundCrossClusterSearchConnection(Consumer<RejectInboundCrossClusterSearchConnectionRequest.Builder> rejectInboundCrossClusterSearchConnectionRequest)
                                                                                             throws ResourceNotFoundException,
DisabledOperationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

This is a convenience which creates an instance of the RejectInboundCrossClusterSearchConnectionRequest.Builder avoiding the need to create one manually via RejectInboundCrossClusterSearchConnectionRequest.builder()

Parameters:

rejectInboundCrossClusterSearchConnectionRequest - A Consumer that will call methods on RejectInboundCrossClusterSearchConnectionRequest.Builder to create a request. Container for the parameters to the RejectInboundCrossClusterSearchConnection operation.

Returns:

Result of the RejectInboundCrossClusterSearchConnection operation returned by the service.

removeTags

default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest)
                               throws BaseException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Removes the specified set of tags from the specified Elasticsearch domain.

Parameters:

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.

Returns:

Result of the RemoveTags operation returned by the service.

removeTags

default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
                               throws BaseException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Removes the specified set of tags from the specified Elasticsearch domain.

This is a convenience which creates an instance of the RemoveTagsRequest.Builder avoiding the need to create one manually via RemoveTagsRequest.builder()

Parameters:

removeTagsRequest - A Consumer that will call methods on RemoveTagsRequest.Builder to create a 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

default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Parameters:

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

revokeVpcEndpointAccess

default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest)
                                                         throws ResourceNotFoundException,
ValidationException,
DisabledOperationException,
InternalException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

This is a convenience which creates an instance of the RevokeVpcEndpointAccessRequest.Builder avoiding the need to create one manually via RevokeVpcEndpointAccessRequest.builder()

Parameters:

revokeVpcEndpointAccessRequest - A Consumer that will call methods on RevokeVpcEndpointAccessRequest.Builder to create a 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

default StartElasticsearchServiceSoftwareUpdateResponse startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest)
                                                                                         throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Schedules a service software update for an Amazon ES domain.

Parameters:

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.

Returns:

Result of the StartElasticsearchServiceSoftwareUpdate operation returned by the service.

startElasticsearchServiceSoftwareUpdate

default StartElasticsearchServiceSoftwareUpdateResponse startElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest)
                                                                                         throws BaseException,
InternalException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Schedules a service software update for an Amazon ES domain.

This is a convenience which creates an instance of the StartElasticsearchServiceSoftwareUpdateRequest.Builder avoiding the need to create one manually via StartElasticsearchServiceSoftwareUpdateRequest.builder()

Parameters:

startElasticsearchServiceSoftwareUpdateRequest - A Consumer that will call methods on StartElasticsearchServiceSoftwareUpdateRequest.Builder to create a 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

default UpdateElasticsearchDomainConfigResponse updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest)
                                                                         throws BaseException,
InternalException,
InvalidTypeException,
LimitExceededException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Parameters:

updateElasticsearchDomainConfigRequest - Container for the parameters to the UpdateElasticsearchDomain operation. Specifies the type and number of instances in the domain cluster.

Returns:

Result of the UpdateElasticsearchDomainConfig operation returned by the service.

updateElasticsearchDomainConfig

default UpdateElasticsearchDomainConfigResponse updateElasticsearchDomainConfig(Consumer<UpdateElasticsearchDomainConfigRequest.Builder> updateElasticsearchDomainConfigRequest)
                                                                         throws BaseException,
InternalException,
InvalidTypeException,
LimitExceededException,
ResourceNotFoundException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

This is a convenience which creates an instance of the UpdateElasticsearchDomainConfigRequest.Builder avoiding the need to create one manually via UpdateElasticsearchDomainConfigRequest.builder()

Parameters:

updateElasticsearchDomainConfigRequest - A Consumer that will call methods on UpdateElasticsearchDomainConfigRequest.Builder to create a 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

default UpdatePackageResponse updatePackage(UpdatePackageRequest updatePackageRequest)
                                     throws BaseException,
InternalException,
LimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Updates a package for use with Amazon ES domains.

Parameters:

updatePackageRequest - Container for request parameters to UpdatePackage operation.

Returns:

Result of the UpdatePackage operation returned by the service.

updatePackage

default UpdatePackageResponse updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest)
                                     throws BaseException,
InternalException,
LimitExceededException,
ResourceNotFoundException,
AccessDeniedException,
ValidationException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Updates a package for use with Amazon ES domains.

This is a convenience which creates an instance of the UpdatePackageRequest.Builder avoiding the need to create one manually via UpdatePackageRequest.builder()

Parameters:

updatePackageRequest - A Consumer that will call methods on UpdatePackageRequest.Builder to create a request. Container for request parameters to UpdatePackage operation.

Returns:

Result of the UpdatePackage operation returned by the service.

updateVpcEndpoint

default UpdateVpcEndpointResponse updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)
                                             throws ResourceNotFoundException,
DisabledOperationException,
InternalException,
ValidationException,
ConflictException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Parameters:

updateVpcEndpointRequest - Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Returns:

Result of the UpdateVpcEndpoint operation returned by the service.

updateVpcEndpoint

default UpdateVpcEndpointResponse updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)
                                             throws ResourceNotFoundException,
DisabledOperationException,
InternalException,
ValidationException,
ConflictException,
BaseException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

This is a convenience which creates an instance of the UpdateVpcEndpointRequest.Builder avoiding the need to create one manually via UpdateVpcEndpointRequest.builder()

Parameters:

updateVpcEndpointRequest - A Consumer that will call methods on UpdateVpcEndpointRequest.Builder to create a request. Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Returns:

Result of the UpdateVpcEndpoint operation returned by the service.

upgradeElasticsearchDomain

default UpgradeElasticsearchDomainResponse upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest)
                                                               throws BaseException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Parameters:

upgradeElasticsearchDomainRequest - Container for request parameters to UpgradeElasticsearchDomain operation.

Returns:

Result of the UpgradeElasticsearchDomain operation returned by the service.

upgradeElasticsearchDomain

default UpgradeElasticsearchDomainResponse upgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest)
                                                               throws BaseException,
ResourceNotFoundException,
ResourceAlreadyExistsException,
DisabledOperationException,
ValidationException,
InternalException,
AwsServiceException,
SdkClientException,
ElasticsearchException

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

This is a convenience which creates an instance of the UpgradeElasticsearchDomainRequest.Builder avoiding the need to create one manually via UpgradeElasticsearchDomainRequest.builder()

Parameters:

upgradeElasticsearchDomainRequest - A Consumer that will call methods on UpgradeElasticsearchDomainRequest.Builder to create a request. Container for request parameters to UpgradeElasticsearchDomain operation.

Returns:

Result of the UpgradeElasticsearchDomain operation returned by the service.

create

static ElasticsearchClient create()

Create a ElasticsearchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static ElasticsearchClientBuilder builder()

Create a builder that can be used to configure and create a ElasticsearchClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default ElasticsearchServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration