Interface ElasticsearchAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder() method.The asynchronous client performs non-blocking I/O when configured with any
SdkAsyncHttpClient supported in the SDK. However, full non-blocking is not guaranteed as the async client may
perform blocking calls in some cases such as credentials retrieval and endpoint discovery as part of the async API
call.
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
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionacceptInboundCrossClusterSearchConnection(Consumer<AcceptInboundCrossClusterSearchConnectionRequest.Builder> acceptInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to accept an inbound cross-cluster search connection request.acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest acceptInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to accept an inbound cross-cluster search connection request.default CompletableFuture<AddTagsResponse> addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) Attaches tags to an existing Elasticsearch domain.default CompletableFuture<AddTagsResponse> addTags(AddTagsRequest addTagsRequest) Attaches tags to an existing Elasticsearch domain.associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest) Associates a package with an Amazon ES domain.associatePackage(AssociatePackageRequest associatePackageRequest) Associates a package with an Amazon ES domain.authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.builder()Create a builder that can be used to configure and create aElasticsearchAsyncClient.cancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest) Cancels a pending configuration change on an Amazon OpenSearch Service domain.cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest) Cancels a pending configuration change on an Amazon OpenSearch Service domain.cancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon ES domain.cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon ES domain.static ElasticsearchAsyncClientcreate()Create aElasticsearchAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.createElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest) Creates a new Elasticsearch domain.createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest) Creates a new Elasticsearch domain.createOutboundCrossClusterSearchConnection(Consumer<CreateOutboundCrossClusterSearchConnectionRequest.Builder> createOutboundCrossClusterSearchConnectionRequest) Creates a new cross-cluster search connection from a source domain to a destination domain.createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest createOutboundCrossClusterSearchConnectionRequest) Creates a new cross-cluster search connection from a source domain to a destination domain.default CompletableFuture<CreatePackageResponse> createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) Create a package for use with Amazon ES domains.default CompletableFuture<CreatePackageResponse> createPackage(CreatePackageRequest createPackageRequest) Create a package for use with Amazon ES domains.createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest) Creates an Amazon OpenSearch Service-managed VPC endpoint.createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) Creates an Amazon OpenSearch Service-managed VPC endpoint.deleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest) Permanently deletes the specified Elasticsearch domain and all of its data.deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest) Permanently deletes the specified Elasticsearch domain and all of its data.Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.deleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest) Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest) Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.deleteInboundCrossClusterSearchConnection(Consumer<DeleteInboundCrossClusterSearchConnectionRequest.Builder> deleteInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to delete an existing inbound cross-cluster search connection.deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest deleteInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to delete an existing inbound cross-cluster search connection.deleteOutboundCrossClusterSearchConnection(Consumer<DeleteOutboundCrossClusterSearchConnectionRequest.Builder> deleteOutboundCrossClusterSearchConnectionRequest) Allows the source domain owner to delete an existing outbound cross-cluster search connection.deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest deleteOutboundCrossClusterSearchConnectionRequest) Allows the source domain owner to delete an existing outbound cross-cluster search connection.default CompletableFuture<DeletePackageResponse> deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) Delete the package.default CompletableFuture<DeletePackageResponse> deletePackage(DeletePackageRequest deletePackageRequest) Delete the package.deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.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.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 DescribeDomainAutoTunesPublisherdescribeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) This is a variant ofdescribeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation.default DescribeDomainAutoTunesPublisherdescribeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) This is a variant ofdescribeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation.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.describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.describeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest) Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest) Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.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.describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest) Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.describeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest) Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest) Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.describeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest) Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest) Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.describeInboundCrossClusterSearchConnections(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination domain.describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination domain.describeInboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest) describeInboundCrossClusterSearchConnectionsPaginator(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest) describeOutboundCrossClusterSearchConnections(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest) Lists all the outbound cross-cluster search connections for a source domain.describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest) Lists all the outbound cross-cluster search connections for a source domain.describeOutboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest) describeOutboundCrossClusterSearchConnectionsPaginator(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest) describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) Describes all packages available to Amazon ES.describePackages(DescribePackagesRequest describePackagesRequest) Describes all packages available to Amazon ES.default DescribePackagesPublisherdescribePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) This is a variant ofdescribePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation.default DescribePackagesPublisherdescribePackagesPaginator(DescribePackagesRequest describePackagesRequest) This is a variant ofdescribePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation.Lists available reserved Elasticsearch instance offerings.describeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) Lists available reserved Elasticsearch instance offerings.describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) Lists available reserved Elasticsearch instance offerings.describeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) Returns information about reserved Elasticsearch instances for this account.describeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) Returns information about reserved Elasticsearch instances for this account.describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) Returns information about reserved Elasticsearch instances for this account.describeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest) Dissociates a package from the Amazon ES domain.dissociatePackage(DissociatePackageRequest dissociatePackageRequest) Dissociates a package from the Amazon ES domain.Returns a list of upgrade compatible Elastisearch versions.getCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest) Returns a list of upgrade compatible Elastisearch versions.getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest) Returns a list of upgrade compatible Elastisearch versions.getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) Returns a list of versions of the package, along with their creation time and commit message.getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) Returns a list of versions of the package, along with their creation time and commit message.getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) This is a variant ofgetPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation.getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) This is a variant ofgetPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation.getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades that were performed on the domain.getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades that were performed on the domain.default GetUpgradeHistoryPublishergetUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) This is a variant ofgetUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation.default GetUpgradeHistoryPublishergetUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest) This is a variant ofgetUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation.getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest) Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.default CompletableFuture<ListDomainNamesResponse> Returns the name of all Elasticsearch domains owned by the current user's account.default CompletableFuture<ListDomainNamesResponse> listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) Returns the name of all Elasticsearch domains owned by the current user's account.default CompletableFuture<ListDomainNamesResponse> listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Returns the name of all Elasticsearch domains owned by the current user's account.listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) Lists all Amazon ES domains associated with the package.listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) Lists all Amazon ES domains associated with the package.default ListDomainsForPackagePublisherlistDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) This is a variant oflistDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation.default ListDomainsForPackagePublisherlistDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest) This is a variant oflistDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation.listElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) List all Elasticsearch instance types that are supported for given ElasticsearchVersionlistElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) List all Elasticsearch instance types that are supported for given ElasticsearchVersionlistElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) This is a variant oflistElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation.listElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) This is a variant oflistElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation.List all supported Elasticsearch versionslistElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) List all supported Elasticsearch versionslistElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) List all supported Elasticsearch versionsThis is a variant oflistElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.listElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) This is a variant oflistElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) This is a variant oflistElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) Lists all packages associated with the Amazon ES domain.listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) Lists all packages associated with the Amazon ES domain.default ListPackagesForDomainPublisherlistPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) This is a variant oflistPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation.default ListPackagesForDomainPublisherlistPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest) This is a variant oflistPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation.default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) Returns all tags for the given Elasticsearch domain.default CompletableFuture<ListTagsResponse> listTags(ListTagsRequest listTagsRequest) Returns all tags for the given Elasticsearch domain.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.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.listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.purchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest) Allows you to purchase reserved Elasticsearch instances.purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest) Allows you to purchase reserved Elasticsearch instances.rejectInboundCrossClusterSearchConnection(Consumer<RejectInboundCrossClusterSearchConnectionRequest.Builder> rejectInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to reject an inbound cross-cluster search connection request.rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest rejectInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to reject an inbound cross-cluster search connection request.default CompletableFuture<RemoveTagsResponse> removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes the specified set of tags from the specified Elasticsearch domain.default CompletableFuture<RemoveTagsResponse> removeTags(RemoveTagsRequest removeTagsRequest) Removes the specified set of tags from the specified Elasticsearch domain.revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest) Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest) Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstartElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon ES domain.startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon ES domain.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.updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest) Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.default CompletableFuture<UpdatePackageResponse> updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) Updates a package for use with Amazon ES domains.default CompletableFuture<UpdatePackageResponse> updatePackage(UpdatePackageRequest updatePackageRequest) Updates a package for use with Amazon ES domains.updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.upgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest) Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.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
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
acceptInboundCrossClusterSearchConnection
default CompletableFuture<AcceptInboundCrossClusterSearchConnectionResponse> acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest acceptInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to accept an inbound cross-cluster search connection request.
- Parameters:
acceptInboundCrossClusterSearchConnectionRequest- Container for the parameters to theAcceptInboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the AcceptInboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
acceptInboundCrossClusterSearchConnection
default CompletableFuture<AcceptInboundCrossClusterSearchConnectionResponse> acceptInboundCrossClusterSearchConnection(Consumer<AcceptInboundCrossClusterSearchConnectionRequest.Builder> acceptInboundCrossClusterSearchConnectionRequest) 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.Builderavoiding the need to create one manually viaAcceptInboundCrossClusterSearchConnectionRequest.builder()- Parameters:
acceptInboundCrossClusterSearchConnectionRequest- AConsumerthat will call methods onAcceptInboundCrossClusterSearchConnectionRequest.Builderto create a request. Container for the parameters to theAcceptInboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the AcceptInboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addTags
Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
- Parameters:
addTagsRequest- Container for the parameters to theAddTagsoperation. Specify the tags that you want to attach to the Elasticsearch domain.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
addTags
Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
This is a convenience which creates an instance of the
AddTagsRequest.Builderavoiding the need to create one manually viaAddTagsRequest.builder()- Parameters:
addTagsRequest- AConsumerthat will call methods onAddTagsRequest.Builderto create a request. Container for the parameters to theAddTagsoperation. Specify the tags that you want to attach to the Elasticsearch domain.- Returns:
- A Java Future containing the result of the AddTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
associatePackage
default CompletableFuture<AssociatePackageResponse> associatePackage(AssociatePackageRequest associatePackageRequest) Associates a package with an Amazon ES domain.
- Parameters:
associatePackageRequest- Container for request parameters toAssociatePackageoperation.- Returns:
- A Java Future containing the result of the AssociatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
associatePackage
default CompletableFuture<AssociatePackageResponse> associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest) Associates a package with an Amazon ES domain.
This is a convenience which creates an instance of the
AssociatePackageRequest.Builderavoiding the need to create one manually viaAssociatePackageRequest.builder()- Parameters:
associatePackageRequest- AConsumerthat will call methods onAssociatePackageRequest.Builderto create a request. Container for request parameters toAssociatePackageoperation.- Returns:
- A Java Future containing the result of the AssociatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
authorizeVpcEndpointAccess
default CompletableFuture<AuthorizeVpcEndpointAccessResponse> authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- Parameters:
authorizeVpcEndpointAccessRequest- Container for request parameters to theAuthorizeVpcEndpointAccessoperation. Specifies the account to be permitted to manage VPC endpoints against the domain.- Returns:
- A Java Future containing the result of the AuthorizeVpcEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
authorizeVpcEndpointAccess
default CompletableFuture<AuthorizeVpcEndpointAccessResponse> authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest) 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.Builderavoiding the need to create one manually viaAuthorizeVpcEndpointAccessRequest.builder()- Parameters:
authorizeVpcEndpointAccessRequest- AConsumerthat will call methods onAuthorizeVpcEndpointAccessRequest.Builderto create a request. Container for request parameters to theAuthorizeVpcEndpointAccessoperation. Specifies the account to be permitted to manage VPC endpoints against the domain.- Returns:
- A Java Future containing the result of the AuthorizeVpcEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelDomainConfigChange
default CompletableFuture<CancelDomainConfigChangeResponse> cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest) Cancels a pending configuration change on an Amazon OpenSearch Service domain.
- Parameters:
cancelDomainConfigChangeRequest- Container for parameters of theCancelDomainConfigChangeoperation.- Returns:
- A Java Future containing the result of the CancelDomainConfigChange operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelDomainConfigChange
default CompletableFuture<CancelDomainConfigChangeResponse> cancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest) Cancels a pending configuration change on an Amazon OpenSearch Service domain.
This is a convenience which creates an instance of the
CancelDomainConfigChangeRequest.Builderavoiding the need to create one manually viaCancelDomainConfigChangeRequest.builder()- Parameters:
cancelDomainConfigChangeRequest- AConsumerthat will call methods onCancelDomainConfigChangeRequest.Builderto create a request. Container for parameters of theCancelDomainConfigChangeoperation.- Returns:
- A Java Future containing the result of the CancelDomainConfigChange operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelElasticsearchServiceSoftwareUpdate
default CompletableFuture<CancelElasticsearchServiceSoftwareUpdateResponse> cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the
AutomatedUpdateDateand when theUpdateStatusis in thePENDING_UPDATEstate.- Parameters:
cancelElasticsearchServiceSoftwareUpdateRequest- Container for the parameters to theCancelElasticsearchServiceSoftwareUpdateoperation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.- Returns:
- A Java Future containing the result of the CancelElasticsearchServiceSoftwareUpdate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
cancelElasticsearchServiceSoftwareUpdate
default CompletableFuture<CancelElasticsearchServiceSoftwareUpdateResponse> cancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the
AutomatedUpdateDateand when theUpdateStatusis in thePENDING_UPDATEstate.
This is a convenience which creates an instance of the
CancelElasticsearchServiceSoftwareUpdateRequest.Builderavoiding the need to create one manually viaCancelElasticsearchServiceSoftwareUpdateRequest.builder()- Parameters:
cancelElasticsearchServiceSoftwareUpdateRequest- AConsumerthat will call methods onCancelElasticsearchServiceSoftwareUpdateRequest.Builderto create a request. Container for the parameters to theCancelElasticsearchServiceSoftwareUpdateoperation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.- Returns:
- A Java Future containing the result of the CancelElasticsearchServiceSoftwareUpdate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createElasticsearchDomain
default CompletableFuture<CreateElasticsearchDomainResponse> createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest) Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
- Parameters:
createElasticsearchDomainRequest-- Returns:
- A Java Future containing the result of the CreateElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createElasticsearchDomain
default CompletableFuture<CreateElasticsearchDomainResponse> createElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest) 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.Builderavoiding the need to create one manually viaCreateElasticsearchDomainRequest.builder()- Parameters:
createElasticsearchDomainRequest- AConsumerthat will call methods onCreateElasticsearchDomainRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createOutboundCrossClusterSearchConnection
default CompletableFuture<CreateOutboundCrossClusterSearchConnectionResponse> createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest createOutboundCrossClusterSearchConnectionRequest) Creates a new cross-cluster search connection from a source domain to a destination domain.
- Parameters:
createOutboundCrossClusterSearchConnectionRequest- Container for the parameters to theCreateOutboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the CreateOutboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createOutboundCrossClusterSearchConnection
default CompletableFuture<CreateOutboundCrossClusterSearchConnectionResponse> createOutboundCrossClusterSearchConnection(Consumer<CreateOutboundCrossClusterSearchConnectionRequest.Builder> createOutboundCrossClusterSearchConnectionRequest) 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.Builderavoiding the need to create one manually viaCreateOutboundCrossClusterSearchConnectionRequest.builder()- Parameters:
createOutboundCrossClusterSearchConnectionRequest- AConsumerthat will call methods onCreateOutboundCrossClusterSearchConnectionRequest.Builderto create a request. Container for the parameters to theCreateOutboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the CreateOutboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPackage
default CompletableFuture<CreatePackageResponse> createPackage(CreatePackageRequest createPackageRequest) Create a package for use with Amazon ES domains.
- Parameters:
createPackageRequest- Container for request parameters toCreatePackageoperation.- Returns:
- A Java Future containing the result of the CreatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createPackage
default CompletableFuture<CreatePackageResponse> createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) Create a package for use with Amazon ES domains.
This is a convenience which creates an instance of the
CreatePackageRequest.Builderavoiding the need to create one manually viaCreatePackageRequest.builder()- Parameters:
createPackageRequest- AConsumerthat will call methods onCreatePackageRequest.Builderto create a request. Container for request parameters toCreatePackageoperation.- Returns:
- A Java Future containing the result of the CreatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createVpcEndpoint
default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) Creates an Amazon OpenSearch Service-managed VPC endpoint.
- Parameters:
createVpcEndpointRequest- Container for the parameters to theCreateVpcEndpointRequestoperation.- Returns:
- A Java Future containing the result of the CreateVpcEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
createVpcEndpoint
default CompletableFuture<CreateVpcEndpointResponse> createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest) Creates an Amazon OpenSearch Service-managed VPC endpoint.
This is a convenience which creates an instance of the
CreateVpcEndpointRequest.Builderavoiding the need to create one manually viaCreateVpcEndpointRequest.builder()- Parameters:
createVpcEndpointRequest- AConsumerthat will call methods onCreateVpcEndpointRequest.Builderto create a request. Container for the parameters to theCreateVpcEndpointRequestoperation.- Returns:
- A Java Future containing the result of the CreateVpcEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteElasticsearchDomain
default CompletableFuture<DeleteElasticsearchDomainResponse> deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest) Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
- Parameters:
deleteElasticsearchDomainRequest- Container for the parameters to theDeleteElasticsearchDomainoperation. Specifies the name of the Elasticsearch domain that you want to delete.- Returns:
- A Java Future containing the result of the DeleteElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteElasticsearchDomain
default CompletableFuture<DeleteElasticsearchDomainResponse> deleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest) 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.Builderavoiding the need to create one manually viaDeleteElasticsearchDomainRequest.builder()- Parameters:
deleteElasticsearchDomainRequest- AConsumerthat will call methods onDeleteElasticsearchDomainRequest.Builderto create a request. Container for the parameters to theDeleteElasticsearchDomainoperation. Specifies the name of the Elasticsearch domain that you want to delete.- Returns:
- A Java Future containing the result of the DeleteElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteElasticsearchServiceRole
default CompletableFuture<DeleteElasticsearchServiceRoleResponse> deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest) 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:
- A Java Future containing the result of the DeleteElasticsearchServiceRole operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteElasticsearchServiceRole
default CompletableFuture<DeleteElasticsearchServiceRoleResponse> deleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest) 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.Builderavoiding the need to create one manually viaDeleteElasticsearchServiceRoleRequest.builder()- Parameters:
deleteElasticsearchServiceRoleRequest- AConsumerthat will call methods onDeleteElasticsearchServiceRoleRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeleteElasticsearchServiceRole operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteElasticsearchServiceRole
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:
- A Java Future containing the result of the DeleteElasticsearchServiceRole operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteInboundCrossClusterSearchConnection
default CompletableFuture<DeleteInboundCrossClusterSearchConnectionResponse> deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest deleteInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
- Parameters:
deleteInboundCrossClusterSearchConnectionRequest- Container for the parameters to theDeleteInboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the DeleteInboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteInboundCrossClusterSearchConnection
default CompletableFuture<DeleteInboundCrossClusterSearchConnectionResponse> deleteInboundCrossClusterSearchConnection(Consumer<DeleteInboundCrossClusterSearchConnectionRequest.Builder> deleteInboundCrossClusterSearchConnectionRequest) 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.Builderavoiding the need to create one manually viaDeleteInboundCrossClusterSearchConnectionRequest.builder()- Parameters:
deleteInboundCrossClusterSearchConnectionRequest- AConsumerthat will call methods onDeleteInboundCrossClusterSearchConnectionRequest.Builderto create a request. Container for the parameters to theDeleteInboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the DeleteInboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteOutboundCrossClusterSearchConnection
default CompletableFuture<DeleteOutboundCrossClusterSearchConnectionResponse> deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest deleteOutboundCrossClusterSearchConnectionRequest) Allows the source domain owner to delete an existing outbound cross-cluster search connection.
- Parameters:
deleteOutboundCrossClusterSearchConnectionRequest- Container for the parameters to theDeleteOutboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the DeleteOutboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteOutboundCrossClusterSearchConnection
default CompletableFuture<DeleteOutboundCrossClusterSearchConnectionResponse> deleteOutboundCrossClusterSearchConnection(Consumer<DeleteOutboundCrossClusterSearchConnectionRequest.Builder> deleteOutboundCrossClusterSearchConnectionRequest) 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.Builderavoiding the need to create one manually viaDeleteOutboundCrossClusterSearchConnectionRequest.builder()- Parameters:
deleteOutboundCrossClusterSearchConnectionRequest- AConsumerthat will call methods onDeleteOutboundCrossClusterSearchConnectionRequest.Builderto create a request. Container for the parameters to theDeleteOutboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the DeleteOutboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePackage
default CompletableFuture<DeletePackageResponse> deletePackage(DeletePackageRequest deletePackageRequest) Delete the package.
- Parameters:
deletePackageRequest- Container for request parameters toDeletePackageoperation.- Returns:
- A Java Future containing the result of the DeletePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deletePackage
default CompletableFuture<DeletePackageResponse> deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) Delete the package.
This is a convenience which creates an instance of the
DeletePackageRequest.Builderavoiding the need to create one manually viaDeletePackageRequest.builder()- Parameters:
deletePackageRequest- AConsumerthat will call methods onDeletePackageRequest.Builderto create a request. Container for request parameters toDeletePackageoperation.- Returns:
- A Java Future containing the result of the DeletePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteVpcEndpoint
default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
- Parameters:
deleteVpcEndpointRequest- Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.- Returns:
- A Java Future containing the result of the DeleteVpcEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
deleteVpcEndpoint
default CompletableFuture<DeleteVpcEndpointResponse> deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
This is a convenience which creates an instance of the
DeleteVpcEndpointRequest.Builderavoiding the need to create one manually viaDeleteVpcEndpointRequest.builder()- Parameters:
deleteVpcEndpointRequest- AConsumerthat will call methods onDeleteVpcEndpointRequest.Builderto create a request. Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.- Returns:
- A Java Future containing the result of the DeleteVpcEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainAutoTunes
default CompletableFuture<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.
- Parameters:
describeDomainAutoTunesRequest- Container for the parameters to theDescribeDomainAutoTunesoperation.- Returns:
- A Java Future containing the result of the DescribeDomainAutoTunes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainAutoTunes
default CompletableFuture<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.
This is a convenience which creates an instance of the
DescribeDomainAutoTunesRequest.Builderavoiding the need to create one manually viaDescribeDomainAutoTunesRequest.builder()- Parameters:
describeDomainAutoTunesRequest- AConsumerthat will call methods onDescribeDomainAutoTunesRequest.Builderto create a request. Container for the parameters to theDescribeDomainAutoTunesoperation.- Returns:
- A Java Future containing the result of the DescribeDomainAutoTunes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainAutoTunesPaginator
default DescribeDomainAutoTunesPublisher describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) This is a variant of
describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse response) { //... }; });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 theDescribeDomainAutoTunesoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainAutoTunesPaginator
default DescribeDomainAutoTunesPublisher describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) This is a variant of
describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesPublisher publisher = client.describeDomainAutoTunesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse response) { //... }; });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.Builderavoiding the need to create one manually viaDescribeDomainAutoTunesRequest.builder()- Parameters:
describeDomainAutoTunesRequest- AConsumerthat will call methods onDescribeDomainAutoTunesRequest.Builderto create a request. Container for the parameters to theDescribeDomainAutoTunesoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainChangeProgress
default CompletableFuture<DescribeDomainChangeProgressResponse> describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) 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 theDescribeDomainChangeProgressoperation. Specifies the domain name and optional change specific identity for which you want progress information.- Returns:
- A Java Future containing the result of the DescribeDomainChangeProgress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeDomainChangeProgress
default CompletableFuture<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.
This is a convenience which creates an instance of the
DescribeDomainChangeProgressRequest.Builderavoiding the need to create one manually viaDescribeDomainChangeProgressRequest.builder()- Parameters:
describeDomainChangeProgressRequest- AConsumerthat will call methods onDescribeDomainChangeProgressRequest.Builderto create a request. Container for the parameters to theDescribeDomainChangeProgressoperation. Specifies the domain name and optional change specific identity for which you want progress information.- Returns:
- A Java Future containing the result of the DescribeDomainChangeProgress operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchDomain
default CompletableFuture<DescribeElasticsearchDomainResponse> describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest) Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
- Parameters:
describeElasticsearchDomainRequest- Container for the parameters to theDescribeElasticsearchDomainoperation.- Returns:
- A Java Future containing the result of the DescribeElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchDomain
default CompletableFuture<DescribeElasticsearchDomainResponse> describeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest) 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.Builderavoiding the need to create one manually viaDescribeElasticsearchDomainRequest.builder()- Parameters:
describeElasticsearchDomainRequest- AConsumerthat will call methods onDescribeElasticsearchDomainRequest.Builderto create a request. Container for the parameters to theDescribeElasticsearchDomainoperation.- Returns:
- A Java Future containing the result of the DescribeElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchDomainConfig
default CompletableFuture<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.
- Parameters:
describeElasticsearchDomainConfigRequest- Container for the parameters to theDescribeElasticsearchDomainConfigoperation. Specifies the domain name for which you want configuration information.- Returns:
- A Java Future containing the result of the DescribeElasticsearchDomainConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchDomainConfig
default CompletableFuture<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.
This is a convenience which creates an instance of the
DescribeElasticsearchDomainConfigRequest.Builderavoiding the need to create one manually viaDescribeElasticsearchDomainConfigRequest.builder()- Parameters:
describeElasticsearchDomainConfigRequest- AConsumerthat will call methods onDescribeElasticsearchDomainConfigRequest.Builderto create a request. Container for the parameters to theDescribeElasticsearchDomainConfigoperation. Specifies the domain name for which you want configuration information.- Returns:
- A Java Future containing the result of the DescribeElasticsearchDomainConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchDomains
default CompletableFuture<DescribeElasticsearchDomainsResponse> describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest) Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
- Parameters:
describeElasticsearchDomainsRequest- Container for the parameters to theDescribeElasticsearchDomainsoperation. By default, the API returns the status of all Elasticsearch domains.- Returns:
- A Java Future containing the result of the DescribeElasticsearchDomains operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchDomains
default CompletableFuture<DescribeElasticsearchDomainsResponse> describeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest) 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.Builderavoiding the need to create one manually viaDescribeElasticsearchDomainsRequest.builder()- Parameters:
describeElasticsearchDomainsRequest- AConsumerthat will call methods onDescribeElasticsearchDomainsRequest.Builderto create a request. Container for the parameters to theDescribeElasticsearchDomainsoperation. By default, the API returns the status of all Elasticsearch domains.- Returns:
- A Java Future containing the result of the DescribeElasticsearchDomains operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchInstanceTypeLimits
default CompletableFuture<DescribeElasticsearchInstanceTypeLimitsResponse> describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest) Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the
DomainNameto know what Limits are supported for modifying.- Parameters:
describeElasticsearchInstanceTypeLimitsRequest- Container for the parameters toDescribeElasticsearchInstanceTypeLimitsoperation.- Returns:
- A Java Future containing the result of the DescribeElasticsearchInstanceTypeLimits operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeElasticsearchInstanceTypeLimits
default CompletableFuture<DescribeElasticsearchInstanceTypeLimitsResponse> describeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest) Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the
DomainNameto know what Limits are supported for modifying.
This is a convenience which creates an instance of the
DescribeElasticsearchInstanceTypeLimitsRequest.Builderavoiding the need to create one manually viaDescribeElasticsearchInstanceTypeLimitsRequest.builder()- Parameters:
describeElasticsearchInstanceTypeLimitsRequest- AConsumerthat will call methods onDescribeElasticsearchInstanceTypeLimitsRequest.Builderto create a request. Container for the parameters toDescribeElasticsearchInstanceTypeLimitsoperation.- Returns:
- A Java Future containing the result of the DescribeElasticsearchInstanceTypeLimits operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeInboundCrossClusterSearchConnections
default CompletableFuture<DescribeInboundCrossClusterSearchConnectionsResponse> describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination domain.
- Parameters:
describeInboundCrossClusterSearchConnectionsRequest- Container for the parameters to theDescribeInboundCrossClusterSearchConnectionsoperation.- Returns:
- A Java Future containing the result of the DescribeInboundCrossClusterSearchConnections operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeInboundCrossClusterSearchConnections
default CompletableFuture<DescribeInboundCrossClusterSearchConnectionsResponse> describeInboundCrossClusterSearchConnections(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination domain.
This is a convenience which creates an instance of the
DescribeInboundCrossClusterSearchConnectionsRequest.Builderavoiding the need to create one manually viaDescribeInboundCrossClusterSearchConnectionsRequest.builder()- Parameters:
describeInboundCrossClusterSearchConnectionsRequest- AConsumerthat will call methods onDescribeInboundCrossClusterSearchConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeInboundCrossClusterSearchConnectionsoperation.- Returns:
- A Java Future containing the result of the DescribeInboundCrossClusterSearchConnections operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeInboundCrossClusterSearchConnectionsPaginator
default DescribeInboundCrossClusterSearchConnectionsPublisher describeInboundCrossClusterSearchConnectionsPaginator(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest) This is a variant of
describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsPublisher publisher = client.describeInboundCrossClusterSearchConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsPublisher publisher = client.describeInboundCrossClusterSearchConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse response) { //... }; });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 theDescribeInboundCrossClusterSearchConnectionsoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeInboundCrossClusterSearchConnectionsPaginator
default DescribeInboundCrossClusterSearchConnectionsPublisher describeInboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest) This is a variant of
describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsPublisher publisher = client.describeInboundCrossClusterSearchConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsPublisher publisher = client.describeInboundCrossClusterSearchConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaDescribeInboundCrossClusterSearchConnectionsRequest.builder()- Parameters:
describeInboundCrossClusterSearchConnectionsRequest- AConsumerthat will call methods onDescribeInboundCrossClusterSearchConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeInboundCrossClusterSearchConnectionsoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeOutboundCrossClusterSearchConnections
default CompletableFuture<DescribeOutboundCrossClusterSearchConnectionsResponse> describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest) Lists all the outbound cross-cluster search connections for a source domain.
- Parameters:
describeOutboundCrossClusterSearchConnectionsRequest- Container for the parameters to theDescribeOutboundCrossClusterSearchConnectionsoperation.- Returns:
- A Java Future containing the result of the DescribeOutboundCrossClusterSearchConnections operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeOutboundCrossClusterSearchConnections
default CompletableFuture<DescribeOutboundCrossClusterSearchConnectionsResponse> describeOutboundCrossClusterSearchConnections(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest) Lists all the outbound cross-cluster search connections for a source domain.
This is a convenience which creates an instance of the
DescribeOutboundCrossClusterSearchConnectionsRequest.Builderavoiding the need to create one manually viaDescribeOutboundCrossClusterSearchConnectionsRequest.builder()- Parameters:
describeOutboundCrossClusterSearchConnectionsRequest- AConsumerthat will call methods onDescribeOutboundCrossClusterSearchConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeOutboundCrossClusterSearchConnectionsoperation.- Returns:
- A Java Future containing the result of the DescribeOutboundCrossClusterSearchConnections operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeOutboundCrossClusterSearchConnectionsPaginator
default DescribeOutboundCrossClusterSearchConnectionsPublisher describeOutboundCrossClusterSearchConnectionsPaginator(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest) This is a variant of
describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsPublisher publisher = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsPublisher publisher = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse response) { //... }; });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 theDescribeOutboundCrossClusterSearchConnectionsoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeOutboundCrossClusterSearchConnectionsPaginator
default DescribeOutboundCrossClusterSearchConnectionsPublisher describeOutboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest) This is a variant of
describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsPublisher publisher = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsPublisher publisher = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaDescribeOutboundCrossClusterSearchConnectionsRequest.builder()- Parameters:
describeOutboundCrossClusterSearchConnectionsRequest- AConsumerthat will call methods onDescribeOutboundCrossClusterSearchConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeOutboundCrossClusterSearchConnectionsoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InvalidPaginationTokenException The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describePackages
default CompletableFuture<DescribePackagesResponse> describePackages(DescribePackagesRequest describePackagesRequest) Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
- Parameters:
describePackagesRequest- Container for request parameters toDescribePackageoperation.- Returns:
- A Java Future containing the result of the DescribePackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describePackages
default CompletableFuture<DescribePackagesResponse> describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) 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.Builderavoiding the need to create one manually viaDescribePackagesRequest.builder()- Parameters:
describePackagesRequest- AConsumerthat will call methods onDescribePackagesRequest.Builderto create a request. Container for request parameters toDescribePackageoperation.- Returns:
- A Java Future containing the result of the DescribePackages operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describePackagesPaginator
default DescribePackagesPublisher describePackagesPaginator(DescribePackagesRequest describePackagesRequest) This is a variant of
describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse response) { //... }; });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 toDescribePackageoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describePackagesPaginator
default DescribePackagesPublisher describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) This is a variant of
describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesPublisher publisher = client.describePackagesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse response) { //... }; });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.Builderavoiding the need to create one manually viaDescribePackagesRequest.builder()- Parameters:
describePackagesRequest- AConsumerthat will call methods onDescribePackagesRequest.Builderto create a request. Container for request parameters toDescribePackageoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstanceOfferings
default CompletableFuture<DescribeReservedElasticsearchInstanceOfferingsResponse> describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) Lists available reserved Elasticsearch instance offerings.
- Parameters:
describeReservedElasticsearchInstanceOfferingsRequest- Container for parameters toDescribeReservedElasticsearchInstanceOfferings- Returns:
- A Java Future containing the result of the DescribeReservedElasticsearchInstanceOfferings operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstanceOfferings
default CompletableFuture<DescribeReservedElasticsearchInstanceOfferingsResponse> describeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) Lists available reserved Elasticsearch instance offerings.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstanceOfferingsRequest.Builderavoiding the need to create one manually viaDescribeReservedElasticsearchInstanceOfferingsRequest.builder()- Parameters:
describeReservedElasticsearchInstanceOfferingsRequest- AConsumerthat will call methods onDescribeReservedElasticsearchInstanceOfferingsRequest.Builderto create a request. Container for parameters toDescribeReservedElasticsearchInstanceOfferings- Returns:
- A Java Future containing the result of the DescribeReservedElasticsearchInstanceOfferings operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstanceOfferings
default CompletableFuture<DescribeReservedElasticsearchInstanceOfferingsResponse> describeReservedElasticsearchInstanceOfferings()Lists available reserved Elasticsearch instance offerings.
- Returns:
- A Java Future containing the result of the DescribeReservedElasticsearchInstanceOfferings operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstanceOfferingsPaginator
default DescribeReservedElasticsearchInstanceOfferingsPublisher describeReservedElasticsearchInstanceOfferingsPaginator()This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsPublisher publisher = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsPublisher publisher = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstanceOfferingsPaginator
default DescribeReservedElasticsearchInstanceOfferingsPublisher describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsPublisher publisher = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsPublisher publisher = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response) { //... }; });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 toDescribeReservedElasticsearchInstanceOfferings- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstanceOfferingsPaginator
default DescribeReservedElasticsearchInstanceOfferingsPublisher describeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsPublisher publisher = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsPublisher publisher = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaDescribeReservedElasticsearchInstanceOfferingsRequest.builder()- Parameters:
describeReservedElasticsearchInstanceOfferingsRequest- AConsumerthat will call methods onDescribeReservedElasticsearchInstanceOfferingsRequest.Builderto create a request. Container for parameters toDescribeReservedElasticsearchInstanceOfferings- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstances
default CompletableFuture<DescribeReservedElasticsearchInstancesResponse> describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) Returns information about reserved Elasticsearch instances for this account.
- Parameters:
describeReservedElasticsearchInstancesRequest- Container for parameters toDescribeReservedElasticsearchInstances- Returns:
- A Java Future containing the result of the DescribeReservedElasticsearchInstances operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstances
default CompletableFuture<DescribeReservedElasticsearchInstancesResponse> describeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) Returns information about reserved Elasticsearch instances for this account.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstancesRequest.Builderavoiding the need to create one manually viaDescribeReservedElasticsearchInstancesRequest.builder()- Parameters:
describeReservedElasticsearchInstancesRequest- AConsumerthat will call methods onDescribeReservedElasticsearchInstancesRequest.Builderto create a request. Container for parameters toDescribeReservedElasticsearchInstances- Returns:
- A Java Future containing the result of the DescribeReservedElasticsearchInstances operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstances
default CompletableFuture<DescribeReservedElasticsearchInstancesResponse> describeReservedElasticsearchInstances()Returns information about reserved Elasticsearch instances for this account.
- Returns:
- A Java Future containing the result of the DescribeReservedElasticsearchInstances operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstancesPaginator
default DescribeReservedElasticsearchInstancesPublisher describeReservedElasticsearchInstancesPaginator()This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesPublisher publisher = client.describeReservedElasticsearchInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesPublisher publisher = client.describeReservedElasticsearchInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstancesPaginator
default DescribeReservedElasticsearchInstancesPublisher describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesPublisher publisher = client.describeReservedElasticsearchInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesPublisher publisher = client.describeReservedElasticsearchInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response) { //... }; });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 toDescribeReservedElasticsearchInstances- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeReservedElasticsearchInstancesPaginator
default DescribeReservedElasticsearchInstancesPublisher describeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesPublisher publisher = client.describeReservedElasticsearchInstancesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesPublisher publisher = client.describeReservedElasticsearchInstancesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response) { //... }; });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.Builderavoiding the need to create one manually viaDescribeReservedElasticsearchInstancesRequest.builder()- Parameters:
describeReservedElasticsearchInstancesRequest- AConsumerthat will call methods onDescribeReservedElasticsearchInstancesRequest.Builderto create a request. Container for parameters toDescribeReservedElasticsearchInstances- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeVpcEndpoints
default CompletableFuture<DescribeVpcEndpointsResponse> describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
- Parameters:
describeVpcEndpointsRequest- Container for request parameters to theDescribeVpcEndpointsoperation. Specifies the list of VPC endpoints to be described.- Returns:
- A Java Future containing the result of the DescribeVpcEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
describeVpcEndpoints
default CompletableFuture<DescribeVpcEndpointsResponse> describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
This is a convenience which creates an instance of the
DescribeVpcEndpointsRequest.Builderavoiding the need to create one manually viaDescribeVpcEndpointsRequest.builder()- Parameters:
describeVpcEndpointsRequest- AConsumerthat will call methods onDescribeVpcEndpointsRequest.Builderto create a request. Container for request parameters to theDescribeVpcEndpointsoperation. Specifies the list of VPC endpoints to be described.- Returns:
- A Java Future containing the result of the DescribeVpcEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
dissociatePackage
default CompletableFuture<DissociatePackageResponse> dissociatePackage(DissociatePackageRequest dissociatePackageRequest) Dissociates a package from the Amazon ES domain.
- Parameters:
dissociatePackageRequest- Container for request parameters toDissociatePackageoperation.- Returns:
- A Java Future containing the result of the DissociatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
dissociatePackage
default CompletableFuture<DissociatePackageResponse> dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest) Dissociates a package from the Amazon ES domain.
This is a convenience which creates an instance of the
DissociatePackageRequest.Builderavoiding the need to create one manually viaDissociatePackageRequest.builder()- Parameters:
dissociatePackageRequest- AConsumerthat will call methods onDissociatePackageRequest.Builderto create a request. Container for request parameters toDissociatePackageoperation.- Returns:
- A Java Future containing the result of the DissociatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getCompatibleElasticsearchVersions
default CompletableFuture<GetCompatibleElasticsearchVersionsResponse> getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest) Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
DomainNameto get all upgrade compatible Elasticsearch versions for that specific domain.- Parameters:
getCompatibleElasticsearchVersionsRequest- Container for request parameters toGetCompatibleElasticsearchVersionsoperation.- Returns:
- A Java Future containing the result of the GetCompatibleElasticsearchVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getCompatibleElasticsearchVersions
default CompletableFuture<GetCompatibleElasticsearchVersionsResponse> getCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest) Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
DomainNameto get all upgrade compatible Elasticsearch versions for that specific domain.
This is a convenience which creates an instance of the
GetCompatibleElasticsearchVersionsRequest.Builderavoiding the need to create one manually viaGetCompatibleElasticsearchVersionsRequest.builder()- Parameters:
getCompatibleElasticsearchVersionsRequest- AConsumerthat will call methods onGetCompatibleElasticsearchVersionsRequest.Builderto create a request. Container for request parameters toGetCompatibleElasticsearchVersionsoperation.- Returns:
- A Java Future containing the result of the GetCompatibleElasticsearchVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getCompatibleElasticsearchVersions
default CompletableFuture<GetCompatibleElasticsearchVersionsResponse> getCompatibleElasticsearchVersions()Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
DomainNameto get all upgrade compatible Elasticsearch versions for that specific domain.- Returns:
- A Java Future containing the result of the GetCompatibleElasticsearchVersions operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageVersionHistory
default CompletableFuture<GetPackageVersionHistoryResponse> getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) Returns a list of versions of the package, along with their creation time and commit message.
- Parameters:
getPackageVersionHistoryRequest- Container for request parameters toGetPackageVersionHistoryoperation.- Returns:
- A Java Future containing the result of the GetPackageVersionHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageVersionHistory
default CompletableFuture<GetPackageVersionHistoryResponse> getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) 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.Builderavoiding the need to create one manually viaGetPackageVersionHistoryRequest.builder()- Parameters:
getPackageVersionHistoryRequest- AConsumerthat will call methods onGetPackageVersionHistoryRequest.Builderto create a request. Container for request parameters toGetPackageVersionHistoryoperation.- Returns:
- A Java Future containing the result of the GetPackageVersionHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageVersionHistoryPaginator
default GetPackageVersionHistoryPublisher getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) This is a variant of
getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse response) { //... }; });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 toGetPackageVersionHistoryoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getPackageVersionHistoryPaginator
default GetPackageVersionHistoryPublisher getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) This is a variant of
getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryPublisher publisher = client.getPackageVersionHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse response) { //... }; });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.Builderavoiding the need to create one manually viaGetPackageVersionHistoryRequest.builder()- Parameters:
getPackageVersionHistoryRequest- AConsumerthat will call methods onGetPackageVersionHistoryRequest.Builderto create a request. Container for request parameters toGetPackageVersionHistoryoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getUpgradeHistory
default CompletableFuture<GetUpgradeHistoryResponse> getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades that were performed on the domain.
- Parameters:
getUpgradeHistoryRequest- Container for request parameters toGetUpgradeHistoryoperation.- Returns:
- A Java Future containing the result of the GetUpgradeHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getUpgradeHistory
default CompletableFuture<GetUpgradeHistoryResponse> getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) 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.Builderavoiding the need to create one manually viaGetUpgradeHistoryRequest.builder()- Parameters:
getUpgradeHistoryRequest- AConsumerthat will call methods onGetUpgradeHistoryRequest.Builderto create a request. Container for request parameters toGetUpgradeHistoryoperation.- Returns:
- A Java Future containing the result of the GetUpgradeHistory operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getUpgradeHistoryPaginator
default GetUpgradeHistoryPublisher getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest) This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response) { //... }; });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 toGetUpgradeHistoryoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getUpgradeHistoryPaginator
default GetUpgradeHistoryPublisher getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryPublisher publisher = client.getUpgradeHistoryPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response) { //... }; });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.Builderavoiding the need to create one manually viaGetUpgradeHistoryRequest.builder()- Parameters:
getUpgradeHistoryRequest- AConsumerthat will call methods onGetUpgradeHistoryRequest.Builderto create a request. Container for request parameters toGetUpgradeHistoryoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getUpgradeStatus
default CompletableFuture<GetUpgradeStatusResponse> getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
- Parameters:
getUpgradeStatusRequest- Container for request parameters toGetUpgradeStatusoperation.- Returns:
- A Java Future containing the result of the GetUpgradeStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
getUpgradeStatus
default CompletableFuture<GetUpgradeStatusResponse> getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest) 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.Builderavoiding the need to create one manually viaGetUpgradeStatusRequest.builder()- Parameters:
getUpgradeStatusRequest- AConsumerthat will call methods onGetUpgradeStatusRequest.Builderto create a request. Container for request parameters toGetUpgradeStatusoperation.- Returns:
- A Java Future containing the result of the GetUpgradeStatus operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainNames
default CompletableFuture<ListDomainNamesResponse> listDomainNames(ListDomainNamesRequest listDomainNamesRequest) Returns the name of all Elasticsearch domains owned by the current user's account.
- Parameters:
listDomainNamesRequest- Container for the parameters to theListDomainNamesoperation.- Returns:
- A Java Future containing the result of the ListDomainNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainNames
default CompletableFuture<ListDomainNamesResponse> listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) 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.Builderavoiding the need to create one manually viaListDomainNamesRequest.builder()- Parameters:
listDomainNamesRequest- AConsumerthat will call methods onListDomainNamesRequest.Builderto create a request. Container for the parameters to theListDomainNamesoperation.- Returns:
- A Java Future containing the result of the ListDomainNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainNames
Returns the name of all Elasticsearch domains owned by the current user's account.
- Returns:
- A Java Future containing the result of the ListDomainNames operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainsForPackage
default CompletableFuture<ListDomainsForPackageResponse> listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) Lists all Amazon ES domains associated with the package.
- Parameters:
listDomainsForPackageRequest- Container for request parameters toListDomainsForPackageoperation.- Returns:
- A Java Future containing the result of the ListDomainsForPackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainsForPackage
default CompletableFuture<ListDomainsForPackageResponse> listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) Lists all Amazon ES domains associated with the package.
This is a convenience which creates an instance of the
ListDomainsForPackageRequest.Builderavoiding the need to create one manually viaListDomainsForPackageRequest.builder()- Parameters:
listDomainsForPackageRequest- AConsumerthat will call methods onListDomainsForPackageRequest.Builderto create a request. Container for request parameters toListDomainsForPackageoperation.- Returns:
- A Java Future containing the result of the ListDomainsForPackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainsForPackagePaginator
default ListDomainsForPackagePublisher listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest) This is a variant of
listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse response) { //... }; });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 toListDomainsForPackageoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listDomainsForPackagePaginator
default ListDomainsForPackagePublisher listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) This is a variant of
listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackagePublisher publisher = client.listDomainsForPackagePaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListDomainsForPackageRequest.builder()- Parameters:
listDomainsForPackageRequest- AConsumerthat will call methods onListDomainsForPackageRequest.Builderto create a request. Container for request parameters toListDomainsForPackageoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchInstanceTypes
default CompletableFuture<ListElasticsearchInstanceTypesResponse> listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) List all Elasticsearch instance types that are supported for given ElasticsearchVersion
- Parameters:
listElasticsearchInstanceTypesRequest- Container for the parameters to theListElasticsearchInstanceTypesoperation.- Returns:
- A Java Future containing the result of the ListElasticsearchInstanceTypes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchInstanceTypes
default CompletableFuture<ListElasticsearchInstanceTypesResponse> listElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) List all Elasticsearch instance types that are supported for given ElasticsearchVersion
This is a convenience which creates an instance of the
ListElasticsearchInstanceTypesRequest.Builderavoiding the need to create one manually viaListElasticsearchInstanceTypesRequest.builder()- Parameters:
listElasticsearchInstanceTypesRequest- AConsumerthat will call methods onListElasticsearchInstanceTypesRequest.Builderto create a request. Container for the parameters to theListElasticsearchInstanceTypesoperation.- Returns:
- A Java Future containing the result of the ListElasticsearchInstanceTypes operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchInstanceTypesPaginator
default ListElasticsearchInstanceTypesPublisher listElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) This is a variant of
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesPublisher publisher = client.listElasticsearchInstanceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesPublisher publisher = client.listElasticsearchInstanceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response) { //... }; });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 theListElasticsearchInstanceTypesoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchInstanceTypesPaginator
default ListElasticsearchInstanceTypesPublisher listElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) This is a variant of
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesPublisher publisher = client.listElasticsearchInstanceTypesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesPublisher publisher = client.listElasticsearchInstanceTypesPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListElasticsearchInstanceTypesRequest.builder()- Parameters:
listElasticsearchInstanceTypesRequest- AConsumerthat will call methods onListElasticsearchInstanceTypesRequest.Builderto create a request. Container for the parameters to theListElasticsearchInstanceTypesoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchVersions
default CompletableFuture<ListElasticsearchVersionsResponse> listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) List all supported Elasticsearch versions
- Parameters:
listElasticsearchVersionsRequest- Container for the parameters to theListElasticsearchVersionsoperation.Use
MaxResultsto control the maximum number of results to retrieve in a single call.Use
NextTokenin response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.- Returns:
- A Java Future containing the result of the ListElasticsearchVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchVersions
default CompletableFuture<ListElasticsearchVersionsResponse> listElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) List all supported Elasticsearch versions
This is a convenience which creates an instance of the
ListElasticsearchVersionsRequest.Builderavoiding the need to create one manually viaListElasticsearchVersionsRequest.builder()- Parameters:
listElasticsearchVersionsRequest- AConsumerthat will call methods onListElasticsearchVersionsRequest.Builderto create a request. Container for the parameters to theListElasticsearchVersionsoperation.Use
MaxResultsto control the maximum number of results to retrieve in a single call.Use
NextTokenin response to retrieve more results. If the received response does not contain a NextToken, then there are no more results to retrieve.- Returns:
- A Java Future containing the result of the ListElasticsearchVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchVersions
List all supported Elasticsearch versions
- Returns:
- A Java Future containing the result of the ListElasticsearchVersions operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchVersionsPaginator
This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsPublisher publisher = client.listElasticsearchVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsPublisher publisher = client.listElasticsearchVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response) { //... }; });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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchVersionsPaginator
default ListElasticsearchVersionsPublisher listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsPublisher publisher = client.listElasticsearchVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsPublisher publisher = client.listElasticsearchVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response) { //... }; });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 theListElasticsearchVersionsoperation.Use
MaxResultsto control the maximum number of results to retrieve in a single call.Use
NextTokenin 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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listElasticsearchVersionsPaginator
default ListElasticsearchVersionsPublisher listElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsPublisher publisher = client.listElasticsearchVersionsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsPublisher publisher = client.listElasticsearchVersionsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListElasticsearchVersionsRequest.builder()- Parameters:
listElasticsearchVersionsRequest- AConsumerthat will call methods onListElasticsearchVersionsRequest.Builderto create a request. Container for the parameters to theListElasticsearchVersionsoperation.Use
MaxResultsto control the maximum number of results to retrieve in a single call.Use
NextTokenin 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 publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackagesForDomain
default CompletableFuture<ListPackagesForDomainResponse> listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) Lists all packages associated with the Amazon ES domain.
- Parameters:
listPackagesForDomainRequest- Container for request parameters toListPackagesForDomainoperation.- Returns:
- A Java Future containing the result of the ListPackagesForDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackagesForDomain
default CompletableFuture<ListPackagesForDomainResponse> listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) Lists all packages associated with the Amazon ES domain.
This is a convenience which creates an instance of the
ListPackagesForDomainRequest.Builderavoiding the need to create one manually viaListPackagesForDomainRequest.builder()- Parameters:
listPackagesForDomainRequest- AConsumerthat will call methods onListPackagesForDomainRequest.Builderto create a request. Container for request parameters toListPackagesForDomainoperation.- Returns:
- A Java Future containing the result of the ListPackagesForDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackagesForDomainPaginator
default ListPackagesForDomainPublisher listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest) This is a variant of
listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse response) { //... }; });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 toListPackagesForDomainoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listPackagesForDomainPaginator
default ListPackagesForDomainPublisher listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) This is a variant of
listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainPublisher publisher = client.listPackagesForDomainPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse response) { //... }; });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.Builderavoiding the need to create one manually viaListPackagesForDomainRequest.builder()- Parameters:
listPackagesForDomainRequest- AConsumerthat will call methods onListPackagesForDomainRequest.Builderto create a request. Container for request parameters toListPackagesForDomainoperation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTags
Returns all tags for the given Elasticsearch domain.
- Parameters:
listTagsRequest- Container for the parameters to theListTagsoperation. Specify theARNfor the Elasticsearch domain to which the tags are attached that you want to view are attached.- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listTags
default CompletableFuture<ListTagsResponse> listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) Returns all tags for the given Elasticsearch domain.
This is a convenience which creates an instance of the
ListTagsRequest.Builderavoiding the need to create one manually viaListTagsRequest.builder()- Parameters:
listTagsRequest- AConsumerthat will call methods onListTagsRequest.Builderto create a request. Container for the parameters to theListTagsoperation. Specify theARNfor the Elasticsearch domain to which the tags are attached that you want to view are attached.- Returns:
- A Java Future containing the result of the ListTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVpcEndpointAccess
default CompletableFuture<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.
- 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:
- A Java Future containing the result of the ListVpcEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVpcEndpointAccess
default CompletableFuture<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.
This is a convenience which creates an instance of the
ListVpcEndpointAccessRequest.Builderavoiding the need to create one manually viaListVpcEndpointAccessRequest.builder()- Parameters:
listVpcEndpointAccessRequest- AConsumerthat will call methods onListVpcEndpointAccessRequest.Builderto 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:
- A Java Future containing the result of the ListVpcEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVpcEndpoints
default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
- Parameters:
listVpcEndpointsRequest- Container for request parameters to theListVpcEndpointsoperation.- Returns:
- A Java Future containing the result of the ListVpcEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVpcEndpoints
default CompletableFuture<ListVpcEndpointsResponse> listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest) 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.Builderavoiding the need to create one manually viaListVpcEndpointsRequest.builder()- Parameters:
listVpcEndpointsRequest- AConsumerthat will call methods onListVpcEndpointsRequest.Builderto create a request. Container for request parameters to theListVpcEndpointsoperation.- Returns:
- A Java Future containing the result of the ListVpcEndpoints operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVpcEndpointsForDomain
default CompletableFuture<ListVpcEndpointsForDomainResponse> listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
- Parameters:
listVpcEndpointsForDomainRequest- Container for request parameters to theListVpcEndpointsForDomainoperation. Specifies the domain whose VPC endpoints will be listed.- Returns:
- A Java Future containing the result of the ListVpcEndpointsForDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
listVpcEndpointsForDomain
default CompletableFuture<ListVpcEndpointsForDomainResponse> listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
This is a convenience which creates an instance of the
ListVpcEndpointsForDomainRequest.Builderavoiding the need to create one manually viaListVpcEndpointsForDomainRequest.builder()- Parameters:
listVpcEndpointsForDomainRequest- AConsumerthat will call methods onListVpcEndpointsForDomainRequest.Builderto create a request. Container for request parameters to theListVpcEndpointsForDomainoperation. Specifies the domain whose VPC endpoints will be listed.- Returns:
- A Java Future containing the result of the ListVpcEndpointsForDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
purchaseReservedElasticsearchInstanceOffering
default CompletableFuture<PurchaseReservedElasticsearchInstanceOfferingResponse> purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest) Allows you to purchase reserved Elasticsearch instances.
- Parameters:
purchaseReservedElasticsearchInstanceOfferingRequest- Container for parameters toPurchaseReservedElasticsearchInstanceOffering- Returns:
- A Java Future containing the result of the PurchaseReservedElasticsearchInstanceOffering operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
purchaseReservedElasticsearchInstanceOffering
default CompletableFuture<PurchaseReservedElasticsearchInstanceOfferingResponse> purchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest) Allows you to purchase reserved Elasticsearch instances.
This is a convenience which creates an instance of the
PurchaseReservedElasticsearchInstanceOfferingRequest.Builderavoiding the need to create one manually viaPurchaseReservedElasticsearchInstanceOfferingRequest.builder()- Parameters:
purchaseReservedElasticsearchInstanceOfferingRequest- AConsumerthat will call methods onPurchaseReservedElasticsearchInstanceOfferingRequest.Builderto create a request. Container for parameters toPurchaseReservedElasticsearchInstanceOffering- Returns:
- A Java Future containing the result of the PurchaseReservedElasticsearchInstanceOffering operation
returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
rejectInboundCrossClusterSearchConnection
default CompletableFuture<RejectInboundCrossClusterSearchConnectionResponse> rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest rejectInboundCrossClusterSearchConnectionRequest) Allows the destination domain owner to reject an inbound cross-cluster search connection request.
- Parameters:
rejectInboundCrossClusterSearchConnectionRequest- Container for the parameters to theRejectInboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the RejectInboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
rejectInboundCrossClusterSearchConnection
default CompletableFuture<RejectInboundCrossClusterSearchConnectionResponse> rejectInboundCrossClusterSearchConnection(Consumer<RejectInboundCrossClusterSearchConnectionRequest.Builder> rejectInboundCrossClusterSearchConnectionRequest) 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.Builderavoiding the need to create one manually viaRejectInboundCrossClusterSearchConnectionRequest.builder()- Parameters:
rejectInboundCrossClusterSearchConnectionRequest- AConsumerthat will call methods onRejectInboundCrossClusterSearchConnectionRequest.Builderto create a request. Container for the parameters to theRejectInboundCrossClusterSearchConnectionoperation.- Returns:
- A Java Future containing the result of the RejectInboundCrossClusterSearchConnection operation returned
by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeTags
Removes the specified set of tags from the specified Elasticsearch domain.
- Parameters:
removeTagsRequest- Container for the parameters to theRemoveTagsoperation. Specify theARNfor the Elasticsearch domain from which you want to remove the specifiedTagKey.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
removeTags
default CompletableFuture<RemoveTagsResponse> removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes the specified set of tags from the specified Elasticsearch domain.
This is a convenience which creates an instance of the
RemoveTagsRequest.Builderavoiding the need to create one manually viaRemoveTagsRequest.builder()- Parameters:
removeTagsRequest- AConsumerthat will call methods onRemoveTagsRequest.Builderto create a request. Container for the parameters to theRemoveTagsoperation. Specify theARNfor the Elasticsearch domain from which you want to remove the specifiedTagKey.- Returns:
- A Java Future containing the result of the RemoveTags operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
revokeVpcEndpointAccess
default CompletableFuture<RevokeVpcEndpointAccessResponse> revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest) 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:
- A Java Future containing the result of the RevokeVpcEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
revokeVpcEndpointAccess
default CompletableFuture<RevokeVpcEndpointAccessResponse> revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest) 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.Builderavoiding the need to create one manually viaRevokeVpcEndpointAccessRequest.builder()- Parameters:
revokeVpcEndpointAccessRequest- AConsumerthat will call methods onRevokeVpcEndpointAccessRequest.Builderto create a request. Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.- Returns:
- A Java Future containing the result of the RevokeVpcEndpointAccess operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startElasticsearchServiceSoftwareUpdate
default CompletableFuture<StartElasticsearchServiceSoftwareUpdateResponse> startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon ES domain.
- Parameters:
startElasticsearchServiceSoftwareUpdateRequest- Container for the parameters to theStartElasticsearchServiceSoftwareUpdateoperation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.- Returns:
- A Java Future containing the result of the StartElasticsearchServiceSoftwareUpdate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
startElasticsearchServiceSoftwareUpdate
default CompletableFuture<StartElasticsearchServiceSoftwareUpdateResponse> startElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon ES domain.
This is a convenience which creates an instance of the
StartElasticsearchServiceSoftwareUpdateRequest.Builderavoiding the need to create one manually viaStartElasticsearchServiceSoftwareUpdateRequest.builder()- Parameters:
startElasticsearchServiceSoftwareUpdateRequest- AConsumerthat will call methods onStartElasticsearchServiceSoftwareUpdateRequest.Builderto create a request. Container for the parameters to theStartElasticsearchServiceSoftwareUpdateoperation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.- Returns:
- A Java Future containing the result of the StartElasticsearchServiceSoftwareUpdate operation returned by
the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateElasticsearchDomainConfig
default CompletableFuture<UpdateElasticsearchDomainConfigResponse> updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest) Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
- Parameters:
updateElasticsearchDomainConfigRequest- Container for the parameters to theUpdateElasticsearchDomainoperation. Specifies the type and number of instances in the domain cluster.- Returns:
- A Java Future containing the result of the UpdateElasticsearchDomainConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateElasticsearchDomainConfig
default CompletableFuture<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.
This is a convenience which creates an instance of the
UpdateElasticsearchDomainConfigRequest.Builderavoiding the need to create one manually viaUpdateElasticsearchDomainConfigRequest.builder()- Parameters:
updateElasticsearchDomainConfigRequest- AConsumerthat will call methods onUpdateElasticsearchDomainConfigRequest.Builderto create a request. Container for the parameters to theUpdateElasticsearchDomainoperation. Specifies the type and number of instances in the domain cluster.- Returns:
- A Java Future containing the result of the UpdateElasticsearchDomainConfig operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- InvalidTypeException An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackage
default CompletableFuture<UpdatePackageResponse> updatePackage(UpdatePackageRequest updatePackageRequest) Updates a package for use with Amazon ES domains.
- Parameters:
updatePackageRequest- Container for request parameters toUpdatePackageoperation.- Returns:
- A Java Future containing the result of the UpdatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updatePackage
default CompletableFuture<UpdatePackageResponse> updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) Updates a package for use with Amazon ES domains.
This is a convenience which creates an instance of the
UpdatePackageRequest.Builderavoiding the need to create one manually viaUpdatePackageRequest.builder()- Parameters:
updatePackageRequest- AConsumerthat will call methods onUpdatePackageRequest.Builderto create a request. Container for request parameters toUpdatePackageoperation.- Returns:
- A Java Future containing the result of the UpdatePackage operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- LimitExceededException An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- AccessDeniedException An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateVpcEndpoint
default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
- Parameters:
updateVpcEndpointRequest- Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.- Returns:
- A Java Future containing the result of the UpdateVpcEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
updateVpcEndpoint
default CompletableFuture<UpdateVpcEndpointResponse> updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
This is a convenience which creates an instance of the
UpdateVpcEndpointRequest.Builderavoiding the need to create one manually viaUpdateVpcEndpointRequest.builder()- Parameters:
updateVpcEndpointRequest- AConsumerthat will call methods onUpdateVpcEndpointRequest.Builderto create a request. Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.- Returns:
- A Java Future containing the result of the UpdateVpcEndpoint operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- ConflictException An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
- BaseException An error occurred while processing the request.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
upgradeElasticsearchDomain
default CompletableFuture<UpgradeElasticsearchDomainResponse> upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest) Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
- Parameters:
upgradeElasticsearchDomainRequest- Container for request parameters toUpgradeElasticsearchDomainoperation.- Returns:
- A Java Future containing the result of the UpgradeElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
upgradeElasticsearchDomain
default CompletableFuture<UpgradeElasticsearchDomainResponse> upgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest) 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.Builderavoiding the need to create one manually viaUpgradeElasticsearchDomainRequest.builder()- Parameters:
upgradeElasticsearchDomainRequest- AConsumerthat will call methods onUpgradeElasticsearchDomainRequest.Builderto create a request. Container for request parameters toUpgradeElasticsearchDomainoperation.- Returns:
- A Java Future containing the result of the UpgradeElasticsearchDomain operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()to retrieve the underlying exception.- BaseException An error occurred while processing the request.
- ResourceNotFoundException An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
- ResourceAlreadyExistsException An exception for creating a resource that already exists. Gives http status code of 400.
- DisabledOperationException An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
- ValidationException An exception for missing / invalid input fields. Gives http status code of 400.
- InternalException The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- ElasticsearchException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aElasticsearchAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aElasticsearchAsyncClient.
-