Interface ElasticsearchClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @SdkPublicApi @ThreadSafe public interface ElasticsearchClient extends AwsClient
Service client for accessing Amazon Elasticsearch Service. This can be created using the staticbuilder()method.Amazon Elasticsearch Configuration Service Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.
For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch APIs.
The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description default AcceptInboundCrossClusterSearchConnectionResponseacceptInboundCrossClusterSearchConnection(Consumer<AcceptInboundCrossClusterSearchConnectionRequest.Builder> acceptInboundCrossClusterSearchConnectionRequest)Allows the destination domain owner to accept an inbound cross-cluster search connection request.default AcceptInboundCrossClusterSearchConnectionResponseacceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest acceptInboundCrossClusterSearchConnectionRequest)Allows the destination domain owner to accept an inbound cross-cluster search connection request.default AddTagsResponseaddTags(Consumer<AddTagsRequest.Builder> addTagsRequest)Attaches tags to an existing Elasticsearch domain.default AddTagsResponseaddTags(AddTagsRequest addTagsRequest)Attaches tags to an existing Elasticsearch domain.default AssociatePackageResponseassociatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest)Associates a package with an Amazon ES domain.default AssociatePackageResponseassociatePackage(AssociatePackageRequest associatePackageRequest)Associates a package with an Amazon ES domain.default AuthorizeVpcEndpointAccessResponseauthorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest)Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.default AuthorizeVpcEndpointAccessResponseauthorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.static ElasticsearchClientBuilderbuilder()Create a builder that can be used to configure and create aElasticsearchClient.default CancelDomainConfigChangeResponsecancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest)Cancels a pending configuration change on an Amazon OpenSearch Service domain.default CancelDomainConfigChangeResponsecancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest)Cancels a pending configuration change on an Amazon OpenSearch Service domain.default CancelElasticsearchServiceSoftwareUpdateResponsecancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest)Cancels a scheduled service software update for an Amazon ES domain.default CancelElasticsearchServiceSoftwareUpdateResponsecancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest)Cancels a scheduled service software update for an Amazon ES domain.static ElasticsearchClientcreate()Create aElasticsearchClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateElasticsearchDomainResponsecreateElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest)Creates a new Elasticsearch domain.default CreateElasticsearchDomainResponsecreateElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest)Creates a new Elasticsearch domain.default CreateOutboundCrossClusterSearchConnectionResponsecreateOutboundCrossClusterSearchConnection(Consumer<CreateOutboundCrossClusterSearchConnectionRequest.Builder> createOutboundCrossClusterSearchConnectionRequest)Creates a new cross-cluster search connection from a source domain to a destination domain.default CreateOutboundCrossClusterSearchConnectionResponsecreateOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest createOutboundCrossClusterSearchConnectionRequest)Creates a new cross-cluster search connection from a source domain to a destination domain.default CreatePackageResponsecreatePackage(Consumer<CreatePackageRequest.Builder> createPackageRequest)Create a package for use with Amazon ES domains.default CreatePackageResponsecreatePackage(CreatePackageRequest createPackageRequest)Create a package for use with Amazon ES domains.default CreateVpcEndpointResponsecreateVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)Creates an Amazon OpenSearch Service-managed VPC endpoint.default CreateVpcEndpointResponsecreateVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)Creates an Amazon OpenSearch Service-managed VPC endpoint.default DeleteElasticsearchDomainResponsedeleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest)Permanently deletes the specified Elasticsearch domain and all of its data.default DeleteElasticsearchDomainResponsedeleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest)Permanently deletes the specified Elasticsearch domain and all of its data.default DeleteElasticsearchServiceRoleResponsedeleteElasticsearchServiceRole()Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.default DeleteElasticsearchServiceRoleResponsedeleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest)Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.default DeleteElasticsearchServiceRoleResponsedeleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest)Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.default DeleteInboundCrossClusterSearchConnectionResponsedeleteInboundCrossClusterSearchConnection(Consumer<DeleteInboundCrossClusterSearchConnectionRequest.Builder> deleteInboundCrossClusterSearchConnectionRequest)Allows the destination domain owner to delete an existing inbound cross-cluster search connection.default DeleteInboundCrossClusterSearchConnectionResponsedeleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest deleteInboundCrossClusterSearchConnectionRequest)Allows the destination domain owner to delete an existing inbound cross-cluster search connection.default DeleteOutboundCrossClusterSearchConnectionResponsedeleteOutboundCrossClusterSearchConnection(Consumer<DeleteOutboundCrossClusterSearchConnectionRequest.Builder> deleteOutboundCrossClusterSearchConnectionRequest)Allows the source domain owner to delete an existing outbound cross-cluster search connection.default DeleteOutboundCrossClusterSearchConnectionResponsedeleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest deleteOutboundCrossClusterSearchConnectionRequest)Allows the source domain owner to delete an existing outbound cross-cluster search connection.default DeletePackageResponsedeletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest)Delete the package.default DeletePackageResponsedeletePackage(DeletePackageRequest deletePackageRequest)Delete the package.default DeleteVpcEndpointResponsedeleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.default DeleteVpcEndpointResponsedeleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.default DescribeDomainAutoTunesResponsedescribeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.default DescribeDomainAutoTunesResponsedescribeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.default DescribeDomainAutoTunesIterabledescribeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)This is a variant ofdescribeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation.default DescribeDomainAutoTunesIterabledescribeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)This is a variant ofdescribeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation.default DescribeDomainChangeProgressResponsedescribeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest)Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.default DescribeDomainChangeProgressResponsedescribeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.default DescribeElasticsearchDomainResponsedescribeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest)Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.default DescribeElasticsearchDomainResponsedescribeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest)Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.default DescribeElasticsearchDomainConfigResponsedescribeElasticsearchDomainConfig(Consumer<DescribeElasticsearchDomainConfigRequest.Builder> describeElasticsearchDomainConfigRequest)Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.default DescribeElasticsearchDomainConfigResponsedescribeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest)Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.default DescribeElasticsearchDomainsResponsedescribeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest)Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.default DescribeElasticsearchDomainsResponsedescribeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest)Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.default DescribeElasticsearchInstanceTypeLimitsResponsedescribeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest)Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.default DescribeElasticsearchInstanceTypeLimitsResponsedescribeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest)Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.default DescribeInboundCrossClusterSearchConnectionsResponsedescribeInboundCrossClusterSearchConnections(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest)Lists all the inbound cross-cluster search connections for a destination domain.default DescribeInboundCrossClusterSearchConnectionsResponsedescribeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest)Lists all the inbound cross-cluster search connections for a destination domain.default DescribeInboundCrossClusterSearchConnectionsIterabledescribeInboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest)default DescribeInboundCrossClusterSearchConnectionsIterabledescribeInboundCrossClusterSearchConnectionsPaginator(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest)default DescribeOutboundCrossClusterSearchConnectionsResponsedescribeOutboundCrossClusterSearchConnections(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest)Lists all the outbound cross-cluster search connections for a source domain.default DescribeOutboundCrossClusterSearchConnectionsResponsedescribeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest)Lists all the outbound cross-cluster search connections for a source domain.default DescribeOutboundCrossClusterSearchConnectionsIterabledescribeOutboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest)default DescribeOutboundCrossClusterSearchConnectionsIterabledescribeOutboundCrossClusterSearchConnectionsPaginator(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest)default DescribePackagesResponsedescribePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)Describes all packages available to Amazon ES.default DescribePackagesResponsedescribePackages(DescribePackagesRequest describePackagesRequest)Describes all packages available to Amazon ES.default DescribePackagesIterabledescribePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)This is a variant ofdescribePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation.default DescribePackagesIterabledescribePackagesPaginator(DescribePackagesRequest describePackagesRequest)This is a variant ofdescribePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation.default DescribeReservedElasticsearchInstanceOfferingsResponsedescribeReservedElasticsearchInstanceOfferings()Lists available reserved Elasticsearch instance offerings.default DescribeReservedElasticsearchInstanceOfferingsResponsedescribeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)Lists available reserved Elasticsearch instance offerings.default DescribeReservedElasticsearchInstanceOfferingsResponsedescribeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)Lists available reserved Elasticsearch instance offerings.default DescribeReservedElasticsearchInstanceOfferingsIterabledescribeReservedElasticsearchInstanceOfferingsPaginator()default DescribeReservedElasticsearchInstanceOfferingsIterabledescribeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest)default DescribeReservedElasticsearchInstanceOfferingsIterabledescribeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest)default DescribeReservedElasticsearchInstancesResponsedescribeReservedElasticsearchInstances()Returns information about reserved Elasticsearch instances for this account.default DescribeReservedElasticsearchInstancesResponsedescribeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)Returns information about reserved Elasticsearch instances for this account.default DescribeReservedElasticsearchInstancesResponsedescribeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)Returns information about reserved Elasticsearch instances for this account.default DescribeReservedElasticsearchInstancesIterabledescribeReservedElasticsearchInstancesPaginator()default DescribeReservedElasticsearchInstancesIterabledescribeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest)default DescribeReservedElasticsearchInstancesIterabledescribeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest)default DescribeVpcEndpointsResponsedescribeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest)Describes one or more Amazon OpenSearch Service-managed VPC endpoints.default DescribeVpcEndpointsResponsedescribeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)Describes one or more Amazon OpenSearch Service-managed VPC endpoints.default DissociatePackageResponsedissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest)Dissociates a package from the Amazon ES domain.default DissociatePackageResponsedissociatePackage(DissociatePackageRequest dissociatePackageRequest)Dissociates a package from the Amazon ES domain.default GetCompatibleElasticsearchVersionsResponsegetCompatibleElasticsearchVersions()Returns a list of upgrade compatible Elastisearch versions.default GetCompatibleElasticsearchVersionsResponsegetCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest)Returns a list of upgrade compatible Elastisearch versions.default GetCompatibleElasticsearchVersionsResponsegetCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest)Returns a list of upgrade compatible Elastisearch versions.default GetPackageVersionHistoryResponsegetPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)Returns a list of versions of the package, along with their creation time and commit message.default GetPackageVersionHistoryResponsegetPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)Returns a list of versions of the package, along with their creation time and commit message.default GetPackageVersionHistoryIterablegetPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)This is a variant ofgetPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation.default GetPackageVersionHistoryIterablegetPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)This is a variant ofgetPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation.default GetUpgradeHistoryResponsegetUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)Retrieves the complete history of the last 10 upgrades that were performed on the domain.default GetUpgradeHistoryResponsegetUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)Retrieves the complete history of the last 10 upgrades that were performed on the domain.default GetUpgradeHistoryIterablegetUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)This is a variant ofgetUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation.default GetUpgradeHistoryIterablegetUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest)This is a variant ofgetUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation.default GetUpgradeStatusResponsegetUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest)Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.default GetUpgradeStatusResponsegetUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.default ListDomainNamesResponselistDomainNames()Returns the name of all Elasticsearch domains owned by the current user's account.default ListDomainNamesResponselistDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)Returns the name of all Elasticsearch domains owned by the current user's account.default ListDomainNamesResponselistDomainNames(ListDomainNamesRequest listDomainNamesRequest)Returns the name of all Elasticsearch domains owned by the current user's account.default ListDomainsForPackageResponselistDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)Lists all Amazon ES domains associated with the package.default ListDomainsForPackageResponselistDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)Lists all Amazon ES domains associated with the package.default ListDomainsForPackageIterablelistDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)This is a variant oflistDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation.default ListDomainsForPackageIterablelistDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest)This is a variant oflistDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation.default ListElasticsearchInstanceTypesResponselistElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)List all Elasticsearch instance types that are supported for given ElasticsearchVersiondefault ListElasticsearchInstanceTypesResponselistElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)List all Elasticsearch instance types that are supported for given ElasticsearchVersiondefault ListElasticsearchInstanceTypesIterablelistElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest)This is a variant oflistElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation.default ListElasticsearchInstanceTypesIterablelistElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest)This is a variant oflistElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation.default ListElasticsearchVersionsResponselistElasticsearchVersions()List all supported Elasticsearch versionsdefault ListElasticsearchVersionsResponselistElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)List all supported Elasticsearch versionsdefault ListElasticsearchVersionsResponselistElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)List all supported Elasticsearch versionsdefault ListElasticsearchVersionsIterablelistElasticsearchVersionsPaginator()This is a variant oflistElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.default ListElasticsearchVersionsIterablelistElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest)This is a variant oflistElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.default ListElasticsearchVersionsIterablelistElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest)This is a variant oflistElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.default ListPackagesForDomainResponselistPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)Lists all packages associated with the Amazon ES domain.default ListPackagesForDomainResponselistPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)Lists all packages associated with the Amazon ES domain.default ListPackagesForDomainIterablelistPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)This is a variant oflistPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation.default ListPackagesForDomainIterablelistPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest)This is a variant oflistPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation.default ListTagsResponselistTags(Consumer<ListTagsRequest.Builder> listTagsRequest)Returns all tags for the given Elasticsearch domain.default ListTagsResponselistTags(ListTagsRequest listTagsRequest)Returns all tags for the given Elasticsearch domain.default ListVpcEndpointAccessResponselistVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest)Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.default ListVpcEndpointAccessResponselistVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest)Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.default ListVpcEndpointsResponselistVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.default ListVpcEndpointsResponselistVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.default ListVpcEndpointsForDomainResponselistVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest)Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.default ListVpcEndpointsForDomainResponselistVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.default PurchaseReservedElasticsearchInstanceOfferingResponsepurchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest)Allows you to purchase reserved Elasticsearch instances.default PurchaseReservedElasticsearchInstanceOfferingResponsepurchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest)Allows you to purchase reserved Elasticsearch instances.default RejectInboundCrossClusterSearchConnectionResponserejectInboundCrossClusterSearchConnection(Consumer<RejectInboundCrossClusterSearchConnectionRequest.Builder> rejectInboundCrossClusterSearchConnectionRequest)Allows the destination domain owner to reject an inbound cross-cluster search connection request.default RejectInboundCrossClusterSearchConnectionResponserejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest rejectInboundCrossClusterSearchConnectionRequest)Allows the destination domain owner to reject an inbound cross-cluster search connection request.default RemoveTagsResponseremoveTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)Removes the specified set of tags from the specified Elasticsearch domain.default RemoveTagsResponseremoveTags(RemoveTagsRequest removeTagsRequest)Removes the specified set of tags from the specified Elasticsearch domain.default RevokeVpcEndpointAccessResponserevokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest)Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.default RevokeVpcEndpointAccessResponserevokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.default ElasticsearchServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartElasticsearchServiceSoftwareUpdateResponsestartElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest)Schedules a service software update for an Amazon ES domain.default StartElasticsearchServiceSoftwareUpdateResponsestartElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest)Schedules a service software update for an Amazon ES domain.default UpdateElasticsearchDomainConfigResponseupdateElasticsearchDomainConfig(Consumer<UpdateElasticsearchDomainConfigRequest.Builder> updateElasticsearchDomainConfigRequest)Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.default UpdateElasticsearchDomainConfigResponseupdateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest)Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.default UpdatePackageResponseupdatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest)Updates a package for use with Amazon ES domains.default UpdatePackageResponseupdatePackage(UpdatePackageRequest updatePackageRequest)Updates a package for use with Amazon ES domains.default UpdateVpcEndpointResponseupdateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.default UpdateVpcEndpointResponseupdateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.default UpgradeElasticsearchDomainResponseupgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest)Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.default UpgradeElasticsearchDomainResponseupgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest)Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
acceptInboundCrossClusterSearchConnection
default AcceptInboundCrossClusterSearchConnectionResponse acceptInboundCrossClusterSearchConnection(AcceptInboundCrossClusterSearchConnectionRequest acceptInboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, LimitExceededException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
- Parameters:
acceptInboundCrossClusterSearchConnectionRequest- Container for the parameters to theAcceptInboundCrossClusterSearchConnectionoperation.- Returns:
- Result of the AcceptInboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
acceptInboundCrossClusterSearchConnection
default AcceptInboundCrossClusterSearchConnectionResponse acceptInboundCrossClusterSearchConnection(Consumer<AcceptInboundCrossClusterSearchConnectionRequest.Builder> acceptInboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, LimitExceededException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the destination domain owner to accept an inbound cross-cluster search connection request.
This is a convenience which creates an instance of the
AcceptInboundCrossClusterSearchConnectionRequest.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:
- Result of the AcceptInboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
addTags
default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws BaseException, LimitExceededException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
- Parameters:
addTagsRequest- Container for the parameters to theAddTagsoperation. Specify the tags that you want to attach to the Elasticsearch domain.- Returns:
- Result of the AddTags operation returned by the service.
- Throws:
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.AwsServiceException
-
addTags
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws BaseException, LimitExceededException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
This is a convenience which creates an instance of the
AddTagsRequest.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:
- Result of the AddTags operation returned by the service.
- Throws:
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.AwsServiceException
-
associatePackage
default AssociatePackageResponse associatePackage(AssociatePackageRequest associatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, ElasticsearchException
Associates a package with an Amazon ES domain.
- Parameters:
associatePackageRequest- Container for request parameters toAssociatePackageoperation.- Returns:
- Result of the AssociatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
associatePackage
default AssociatePackageResponse associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, ElasticsearchException
Associates a package with an Amazon ES domain.
This is a convenience which creates an instance of the
AssociatePackageRequest.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:
- Result of the AssociatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
authorizeVpcEndpointAccess
default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, LimitExceededException, ValidationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- Parameters:
authorizeVpcEndpointAccessRequest- Container for request parameters to theAuthorizeVpcEndpointAccessoperation. Specifies the account to be permitted to manage VPC endpoints against the domain.- Returns:
- Result of the AuthorizeVpcEndpointAccess operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
authorizeVpcEndpointAccess
default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, LimitExceededException, ValidationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
This is a convenience which creates an instance of the
AuthorizeVpcEndpointAccessRequest.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:
- Result of the AuthorizeVpcEndpointAccess operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
cancelDomainConfigChange
default CancelDomainConfigChangeResponse cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
- Parameters:
cancelDomainConfigChangeRequest- Container for parameters of theCancelDomainConfigChangeoperation.- Returns:
- Result of the CancelDomainConfigChange operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelDomainConfigChange
default CancelDomainConfigChangeResponse cancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
This is a convenience which creates an instance of the
CancelDomainConfigChangeRequest.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:
- Result of the CancelDomainConfigChange operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelElasticsearchServiceSoftwareUpdate
default CancelElasticsearchServiceSoftwareUpdateResponse cancelElasticsearchServiceSoftwareUpdate(CancelElasticsearchServiceSoftwareUpdateRequest cancelElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the
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:
- Result of the CancelElasticsearchServiceSoftwareUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
cancelElasticsearchServiceSoftwareUpdate
default CancelElasticsearchServiceSoftwareUpdateResponse cancelElasticsearchServiceSoftwareUpdate(Consumer<CancelElasticsearchServiceSoftwareUpdateRequest.Builder> cancelElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the
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:
- Result of the CancelElasticsearchServiceSoftwareUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
createElasticsearchDomain
default CreateElasticsearchDomainResponse createElasticsearchDomain(CreateElasticsearchDomainRequest createElasticsearchDomainRequest) throws BaseException, DisabledOperationException, InternalException, InvalidTypeException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
- Parameters:
createElasticsearchDomainRequest-- Returns:
- Result of the CreateElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
createElasticsearchDomain
default CreateElasticsearchDomainResponse createElasticsearchDomain(Consumer<CreateElasticsearchDomainRequest.Builder> createElasticsearchDomainRequest) throws BaseException, DisabledOperationException, InternalException, InvalidTypeException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
This is a convenience which creates an instance of the
CreateElasticsearchDomainRequest.Builderavoiding the need to create one manually viaCreateElasticsearchDomainRequest.builder()- Parameters:
createElasticsearchDomainRequest- AConsumerthat will call methods onCreateElasticsearchDomainRequest.Builderto create a request.- Returns:
- Result of the CreateElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
createOutboundCrossClusterSearchConnection
default CreateOutboundCrossClusterSearchConnectionResponse createOutboundCrossClusterSearchConnection(CreateOutboundCrossClusterSearchConnectionRequest createOutboundCrossClusterSearchConnectionRequest) throws LimitExceededException, InternalException, ResourceAlreadyExistsException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Creates a new cross-cluster search connection from a source domain to a destination domain.
- Parameters:
createOutboundCrossClusterSearchConnectionRequest- Container for the parameters to theCreateOutboundCrossClusterSearchConnectionoperation.- Returns:
- Result of the CreateOutboundCrossClusterSearchConnection operation returned by the service.
- Throws:
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.AwsServiceException
-
createOutboundCrossClusterSearchConnection
default CreateOutboundCrossClusterSearchConnectionResponse createOutboundCrossClusterSearchConnection(Consumer<CreateOutboundCrossClusterSearchConnectionRequest.Builder> createOutboundCrossClusterSearchConnectionRequest) throws LimitExceededException, InternalException, ResourceAlreadyExistsException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Creates a new cross-cluster search connection from a source domain to a destination domain.
This is a convenience which creates an instance of the
CreateOutboundCrossClusterSearchConnectionRequest.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:
- Result of the CreateOutboundCrossClusterSearchConnection operation returned by the service.
- Throws:
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.AwsServiceException
-
createPackage
default CreatePackageResponse createPackage(CreatePackageRequest createPackageRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceAlreadyExistsException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Create a package for use with Amazon ES domains.
- Parameters:
createPackageRequest- Container for request parameters toCreatePackageoperation.- Returns:
- Result of the CreatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
createPackage
default CreatePackageResponse createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceAlreadyExistsException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Create a package for use with Amazon ES domains.
This is a convenience which creates an instance of the
CreatePackageRequest.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:
- Result of the CreatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
createVpcEndpoint
default CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) throws ConflictException, ValidationException, LimitExceededException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Creates an Amazon OpenSearch Service-managed VPC endpoint.
- Parameters:
createVpcEndpointRequest- Container for the parameters to theCreateVpcEndpointRequestoperation.- Returns:
- Result of the CreateVpcEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
-
createVpcEndpoint
default CreateVpcEndpointResponse createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest) throws ConflictException, ValidationException, LimitExceededException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Creates an Amazon OpenSearch Service-managed VPC endpoint.
This is a convenience which creates an instance of the
CreateVpcEndpointRequest.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:
- Result of the CreateVpcEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteElasticsearchDomain
default DeleteElasticsearchDomainResponse deleteElasticsearchDomain(DeleteElasticsearchDomainRequest deleteElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
- Parameters:
deleteElasticsearchDomainRequest- Container for the parameters to theDeleteElasticsearchDomainoperation. Specifies the name of the Elasticsearch domain that you want to delete.- Returns:
- Result of the DeleteElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteElasticsearchDomain
default DeleteElasticsearchDomainResponse deleteElasticsearchDomain(Consumer<DeleteElasticsearchDomainRequest.Builder> deleteElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
This is a convenience which creates an instance of the
DeleteElasticsearchDomainRequest.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:
- Result of the DeleteElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteElasticsearchServiceRole
default DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest deleteElasticsearchServiceRoleRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
- Parameters:
deleteElasticsearchServiceRoleRequest-- Returns:
- Result of the DeleteElasticsearchServiceRole operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteElasticsearchServiceRole
default DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole(Consumer<DeleteElasticsearchServiceRoleRequest.Builder> deleteElasticsearchServiceRoleRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
This is a convenience which creates an instance of the
DeleteElasticsearchServiceRoleRequest.Builderavoiding the need to create one manually viaDeleteElasticsearchServiceRoleRequest.builder()- Parameters:
deleteElasticsearchServiceRoleRequest- AConsumerthat will call methods onDeleteElasticsearchServiceRoleRequest.Builderto create a request.- Returns:
- Result of the DeleteElasticsearchServiceRole operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteElasticsearchServiceRole
default DeleteElasticsearchServiceRoleResponse deleteElasticsearchServiceRole() throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
- Returns:
- Result of the DeleteElasticsearchServiceRole operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
deleteElasticsearchServiceRole(DeleteElasticsearchServiceRoleRequest)
-
deleteInboundCrossClusterSearchConnection
default DeleteInboundCrossClusterSearchConnectionResponse deleteInboundCrossClusterSearchConnection(DeleteInboundCrossClusterSearchConnectionRequest deleteInboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
- Parameters:
deleteInboundCrossClusterSearchConnectionRequest- Container for the parameters to theDeleteInboundCrossClusterSearchConnectionoperation.- Returns:
- Result of the DeleteInboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
deleteInboundCrossClusterSearchConnection
default DeleteInboundCrossClusterSearchConnectionResponse deleteInboundCrossClusterSearchConnection(Consumer<DeleteInboundCrossClusterSearchConnectionRequest.Builder> deleteInboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
This is a convenience which creates an instance of the
DeleteInboundCrossClusterSearchConnectionRequest.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:
- Result of the DeleteInboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
deleteOutboundCrossClusterSearchConnection
default DeleteOutboundCrossClusterSearchConnectionResponse deleteOutboundCrossClusterSearchConnection(DeleteOutboundCrossClusterSearchConnectionRequest deleteOutboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
- Parameters:
deleteOutboundCrossClusterSearchConnectionRequest- Container for the parameters to theDeleteOutboundCrossClusterSearchConnectionoperation.- Returns:
- Result of the DeleteOutboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
deleteOutboundCrossClusterSearchConnection
default DeleteOutboundCrossClusterSearchConnectionResponse deleteOutboundCrossClusterSearchConnection(Consumer<DeleteOutboundCrossClusterSearchConnectionRequest.Builder> deleteOutboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the source domain owner to delete an existing outbound cross-cluster search connection.
This is a convenience which creates an instance of the
DeleteOutboundCrossClusterSearchConnectionRequest.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:
- Result of the DeleteOutboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
deletePackage
default DeletePackageResponse deletePackage(DeletePackageRequest deletePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, ElasticsearchException
Delete the package.
- Parameters:
deletePackageRequest- Container for request parameters toDeletePackageoperation.- Returns:
- Result of the DeletePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
deletePackage
default DeletePackageResponse deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, ElasticsearchException
Delete the package.
This is a convenience which creates an instance of the
DeletePackageRequest.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:
- Result of the DeletePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteVpcEndpoint
default DeleteVpcEndpointResponse deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
- Parameters:
deleteVpcEndpointRequest- Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.- Returns:
- Result of the DeleteVpcEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
-
deleteVpcEndpoint
default DeleteVpcEndpointResponse deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
This is a convenience which creates an instance of the
DeleteVpcEndpointRequest.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:
- Result of the DeleteVpcEndpoint operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
describeDomainAutoTunes
default DescribeDomainAutoTunesResponse describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
- Parameters:
describeDomainAutoTunesRequest- Container for the parameters to theDescribeDomainAutoTunesoperation.- Returns:
- Result of the DescribeDomainAutoTunes operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDomainAutoTunes
default DescribeDomainAutoTunesResponse describeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
This is a convenience which creates an instance of the
DescribeDomainAutoTunesRequest.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:
- Result of the DescribeDomainAutoTunes operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDomainAutoTunesPaginator
default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client .describeDomainAutoTunesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation.- Parameters:
describeDomainAutoTunesRequest- Container for the parameters to theDescribeDomainAutoTunesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeDomainAutoTunesPaginator
default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client .describeDomainAutoTunesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeDomainAutoTunes(software.amazon.awssdk.services.elasticsearch.model.DescribeDomainAutoTunesRequest)operation.
This is a convenience which creates an instance of the
DescribeDomainAutoTunesRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeDomainChangeProgress
default DescribeDomainChangeProgressResponse describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
- Parameters:
describeDomainChangeProgressRequest- Container for the parameters to theDescribeDomainChangeProgressoperation. Specifies the domain name and optional change specific identity for which you want progress information.- Returns:
- Result of the DescribeDomainChangeProgress operation returned by the service.
- Throws:
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.AwsServiceException
-
describeDomainChangeProgress
default DescribeDomainChangeProgressResponse describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
This is a convenience which creates an instance of the
DescribeDomainChangeProgressRequest.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:
- Result of the DescribeDomainChangeProgress operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchDomain
default DescribeElasticsearchDomainResponse describeElasticsearchDomain(DescribeElasticsearchDomainRequest describeElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
- Parameters:
describeElasticsearchDomainRequest- Container for the parameters to theDescribeElasticsearchDomainoperation.- Returns:
- Result of the DescribeElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchDomain
default DescribeElasticsearchDomainResponse describeElasticsearchDomain(Consumer<DescribeElasticsearchDomainRequest.Builder> describeElasticsearchDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
This is a convenience which creates an instance of the
DescribeElasticsearchDomainRequest.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:
- Result of the DescribeElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchDomainConfig
default DescribeElasticsearchDomainConfigResponse describeElasticsearchDomainConfig(DescribeElasticsearchDomainConfigRequest describeElasticsearchDomainConfigRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
- Parameters:
describeElasticsearchDomainConfigRequest- Container for the parameters to theDescribeElasticsearchDomainConfigoperation. Specifies the domain name for which you want configuration information.- Returns:
- Result of the DescribeElasticsearchDomainConfig operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchDomainConfig
default DescribeElasticsearchDomainConfigResponse describeElasticsearchDomainConfig(Consumer<DescribeElasticsearchDomainConfigRequest.Builder> describeElasticsearchDomainConfigRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
This is a convenience which creates an instance of the
DescribeElasticsearchDomainConfigRequest.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:
- Result of the DescribeElasticsearchDomainConfig operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchDomains
default DescribeElasticsearchDomainsResponse describeElasticsearchDomains(DescribeElasticsearchDomainsRequest describeElasticsearchDomainsRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
- Parameters:
describeElasticsearchDomainsRequest- Container for the parameters to theDescribeElasticsearchDomainsoperation. By default, the API returns the status of all Elasticsearch domains.- Returns:
- Result of the DescribeElasticsearchDomains operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchDomains
default DescribeElasticsearchDomainsResponse describeElasticsearchDomains(Consumer<DescribeElasticsearchDomainsRequest.Builder> describeElasticsearchDomainsRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
This is a convenience which creates an instance of the
DescribeElasticsearchDomainsRequest.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:
- Result of the DescribeElasticsearchDomains operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchInstanceTypeLimits
default DescribeElasticsearchInstanceTypeLimitsResponse describeElasticsearchInstanceTypeLimits(DescribeElasticsearchInstanceTypeLimitsRequest describeElasticsearchInstanceTypeLimitsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the
DomainNameto know what Limits are supported for modifying.- Parameters:
describeElasticsearchInstanceTypeLimitsRequest- Container for the parameters toDescribeElasticsearchInstanceTypeLimitsoperation.- Returns:
- Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.
- Throws:
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.AwsServiceException
-
describeElasticsearchInstanceTypeLimits
default DescribeElasticsearchInstanceTypeLimitsResponse describeElasticsearchInstanceTypeLimits(Consumer<DescribeElasticsearchInstanceTypeLimitsRequest.Builder> describeElasticsearchInstanceTypeLimitsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the
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:
- Result of the DescribeElasticsearchInstanceTypeLimits operation returned by the service.
- Throws:
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.AwsServiceException
-
describeInboundCrossClusterSearchConnections
default DescribeInboundCrossClusterSearchConnectionsResponse describeInboundCrossClusterSearchConnections(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all the inbound cross-cluster search connections for a destination domain.
- Parameters:
describeInboundCrossClusterSearchConnectionsRequest- Container for the parameters to theDescribeInboundCrossClusterSearchConnectionsoperation.- Returns:
- Result of the DescribeInboundCrossClusterSearchConnections operation returned by the service.
- Throws:
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.AwsServiceException
-
describeInboundCrossClusterSearchConnections
default DescribeInboundCrossClusterSearchConnectionsResponse describeInboundCrossClusterSearchConnections(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all the inbound cross-cluster search connections for a destination domain.
This is a convenience which creates an instance of the
DescribeInboundCrossClusterSearchConnectionsRequest.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:
- Result of the DescribeInboundCrossClusterSearchConnections operation returned by the service.
- Throws:
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.AwsServiceException
-
describeInboundCrossClusterSearchConnectionsPaginator
default DescribeInboundCrossClusterSearchConnectionsIterable describeInboundCrossClusterSearchConnectionsPaginator(DescribeInboundCrossClusterSearchConnectionsRequest describeInboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client .describeInboundCrossClusterSearchConnectionsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest)operation.- Parameters:
describeInboundCrossClusterSearchConnectionsRequest- Container for the parameters to theDescribeInboundCrossClusterSearchConnectionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeInboundCrossClusterSearchConnectionsPaginator
default DescribeInboundCrossClusterSearchConnectionsIterable describeInboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeInboundCrossClusterSearchConnectionsRequest.Builder> describeInboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client .describeInboundCrossClusterSearchConnectionsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeInboundCrossClusterSearchConnectionsIterable responses = client.describeInboundCrossClusterSearchConnectionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeInboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeInboundCrossClusterSearchConnectionsRequest)operation.
This is a convenience which creates an instance of the
DescribeInboundCrossClusterSearchConnectionsRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeOutboundCrossClusterSearchConnections
default DescribeOutboundCrossClusterSearchConnectionsResponse describeOutboundCrossClusterSearchConnections(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all the outbound cross-cluster search connections for a source domain.
- Parameters:
describeOutboundCrossClusterSearchConnectionsRequest- Container for the parameters to theDescribeOutboundCrossClusterSearchConnectionsoperation.- Returns:
- Result of the DescribeOutboundCrossClusterSearchConnections operation returned by the service.
- Throws:
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.AwsServiceException
-
describeOutboundCrossClusterSearchConnections
default DescribeOutboundCrossClusterSearchConnectionsResponse describeOutboundCrossClusterSearchConnections(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all the outbound cross-cluster search connections for a source domain.
This is a convenience which creates an instance of the
DescribeOutboundCrossClusterSearchConnectionsRequest.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:
- Result of the DescribeOutboundCrossClusterSearchConnections operation returned by the service.
- Throws:
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.AwsServiceException
-
describeOutboundCrossClusterSearchConnectionsPaginator
default DescribeOutboundCrossClusterSearchConnectionsIterable describeOutboundCrossClusterSearchConnectionsPaginator(DescribeOutboundCrossClusterSearchConnectionsRequest describeOutboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client .describeOutboundCrossClusterSearchConnectionsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest)operation.- Parameters:
describeOutboundCrossClusterSearchConnectionsRequest- Container for the parameters to theDescribeOutboundCrossClusterSearchConnectionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeOutboundCrossClusterSearchConnectionsPaginator
default DescribeOutboundCrossClusterSearchConnectionsIterable describeOutboundCrossClusterSearchConnectionsPaginator(Consumer<DescribeOutboundCrossClusterSearchConnectionsRequest.Builder> describeOutboundCrossClusterSearchConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client .describeOutboundCrossClusterSearchConnectionsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeOutboundCrossClusterSearchConnectionsIterable responses = client.describeOutboundCrossClusterSearchConnectionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeOutboundCrossClusterSearchConnections(software.amazon.awssdk.services.elasticsearch.model.DescribeOutboundCrossClusterSearchConnectionsRequest)operation.
This is a convenience which creates an instance of the
DescribeOutboundCrossClusterSearchConnectionsRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describePackages
default DescribePackagesResponse describePackages(DescribePackagesRequest describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
- Parameters:
describePackagesRequest- Container for request parameters toDescribePackageoperation.- Returns:
- Result of the DescribePackages operation returned by the service.
- Throws:
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.AwsServiceException
-
describePackages
default DescribePackagesResponse describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
This is a convenience which creates an instance of the
DescribePackagesRequest.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:
- Result of the DescribePackages operation returned by the service.
- Throws:
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.AwsServiceException
-
describePackagesPaginator
default DescribePackagesIterable describePackagesPaginator(DescribePackagesRequest describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client .describePackagesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation.- Parameters:
describePackagesRequest- Container for request parameters toDescribePackageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describePackagesPaginator
default DescribePackagesIterable describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client .describePackagesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribePackagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describePackages(software.amazon.awssdk.services.elasticsearch.model.DescribePackagesRequest)operation.
This is a convenience which creates an instance of the
DescribePackagesRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeReservedElasticsearchInstanceOfferings
default DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
- Parameters:
describeReservedElasticsearchInstanceOfferingsRequest- Container for parameters toDescribeReservedElasticsearchInstanceOfferings- Returns:
- Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
describeReservedElasticsearchInstanceOfferings
default DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstanceOfferingsRequest.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:
- Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
describeReservedElasticsearchInstanceOfferings
default DescribeReservedElasticsearchInstanceOfferingsResponse describeReservedElasticsearchInstanceOfferings() throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Lists available reserved Elasticsearch instance offerings.
- Returns:
- Result of the DescribeReservedElasticsearchInstanceOfferings operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeReservedElasticsearchInstanceOfferings(DescribeReservedElasticsearchInstanceOfferingsRequest)
-
describeReservedElasticsearchInstanceOfferingsPaginator
default DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator() throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client .describeReservedElasticsearchInstanceOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest)
-
describeReservedElasticsearchInstanceOfferingsPaginator
default DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator(DescribeReservedElasticsearchInstanceOfferingsRequest describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client .describeReservedElasticsearchInstanceOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation.- Parameters:
describeReservedElasticsearchInstanceOfferingsRequest- Container for parameters toDescribeReservedElasticsearchInstanceOfferings- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeReservedElasticsearchInstanceOfferingsPaginator
default DescribeReservedElasticsearchInstanceOfferingsIterable describeReservedElasticsearchInstanceOfferingsPaginator(Consumer<DescribeReservedElasticsearchInstanceOfferingsRequest.Builder> describeReservedElasticsearchInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client .describeReservedElasticsearchInstanceOfferingsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstanceOfferingsIterable responses = client.describeReservedElasticsearchInstanceOfferingsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstanceOfferings(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstanceOfferingsRequest)operation.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstanceOfferingsRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeReservedElasticsearchInstances
default DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
- Parameters:
describeReservedElasticsearchInstancesRequest- Container for parameters toDescribeReservedElasticsearchInstances- Returns:
- Result of the DescribeReservedElasticsearchInstances operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
describeReservedElasticsearchInstances
default DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstancesRequest.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:
- Result of the DescribeReservedElasticsearchInstances operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
describeReservedElasticsearchInstances
default DescribeReservedElasticsearchInstancesResponse describeReservedElasticsearchInstances() throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns information about reserved Elasticsearch instances for this account.
- Returns:
- Result of the DescribeReservedElasticsearchInstances operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
describeReservedElasticsearchInstances(DescribeReservedElasticsearchInstancesRequest)
-
describeReservedElasticsearchInstancesPaginator
default DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator() throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client .describeReservedElasticsearchInstancesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest)
-
describeReservedElasticsearchInstancesPaginator
default DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator(DescribeReservedElasticsearchInstancesRequest describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client .describeReservedElasticsearchInstancesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation.- Parameters:
describeReservedElasticsearchInstancesRequest- Container for parameters toDescribeReservedElasticsearchInstances- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeReservedElasticsearchInstancesPaginator
default DescribeReservedElasticsearchInstancesIterable describeReservedElasticsearchInstancesPaginator(Consumer<DescribeReservedElasticsearchInstancesRequest.Builder> describeReservedElasticsearchInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client .describeReservedElasticsearchInstancesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.DescribeReservedElasticsearchInstancesIterable responses = client.describeReservedElasticsearchInstancesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
describeReservedElasticsearchInstances(software.amazon.awssdk.services.elasticsearch.model.DescribeReservedElasticsearchInstancesRequest)operation.
This is a convenience which creates an instance of the
DescribeReservedElasticsearchInstancesRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
describeVpcEndpoints
default DescribeVpcEndpointsResponse describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) throws ValidationException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
- Parameters:
describeVpcEndpointsRequest- Container for request parameters to theDescribeVpcEndpointsoperation. Specifies the list of VPC endpoints to be described.- Returns:
- Result of the DescribeVpcEndpoints operation returned by the service.
- Throws:
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.AwsServiceException
-
describeVpcEndpoints
default DescribeVpcEndpointsResponse describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest) throws ValidationException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
This is a convenience which creates an instance of the
DescribeVpcEndpointsRequest.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:
- Result of the DescribeVpcEndpoints operation returned by the service.
- Throws:
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.AwsServiceException
-
dissociatePackage
default DissociatePackageResponse dissociatePackage(DissociatePackageRequest dissociatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, ElasticsearchException
Dissociates a package from the Amazon ES domain.
- Parameters:
dissociatePackageRequest- Container for request parameters toDissociatePackageoperation.- Returns:
- Result of the DissociatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
dissociatePackage
default DissociatePackageResponse dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, ElasticsearchException
Dissociates a package from the Amazon ES domain.
This is a convenience which creates an instance of the
DissociatePackageRequest.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:
- Result of the DissociatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
getCompatibleElasticsearchVersions
default GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest getCompatibleElasticsearchVersionsRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
DomainNameto get all upgrade compatible Elasticsearch versions for that specific domain.- Parameters:
getCompatibleElasticsearchVersionsRequest- Container for request parameters toGetCompatibleElasticsearchVersionsoperation.- Returns:
- Result of the GetCompatibleElasticsearchVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
getCompatibleElasticsearchVersions
default GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions(Consumer<GetCompatibleElasticsearchVersionsRequest.Builder> getCompatibleElasticsearchVersionsRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
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:
- Result of the GetCompatibleElasticsearchVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
getCompatibleElasticsearchVersions
default GetCompatibleElasticsearchVersionsResponse getCompatibleElasticsearchVersions() throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a
DomainNameto get all upgrade compatible Elasticsearch versions for that specific domain.- Returns:
- Result of the GetCompatibleElasticsearchVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
getCompatibleElasticsearchVersions(GetCompatibleElasticsearchVersionsRequest)
-
getPackageVersionHistory
default GetPackageVersionHistoryResponse getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns a list of versions of the package, along with their creation time and commit message.
- Parameters:
getPackageVersionHistoryRequest- Container for request parameters toGetPackageVersionHistoryoperation.- Returns:
- Result of the GetPackageVersionHistory operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackageVersionHistory
default GetPackageVersionHistoryResponse getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns a list of versions of the package, along with their creation time and commit message.
This is a convenience which creates an instance of the
GetPackageVersionHistoryRequest.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:
- Result of the GetPackageVersionHistory operation returned by the service.
- Throws:
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.AwsServiceException
-
getPackageVersionHistoryPaginator
default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client .getPackageVersionHistoryPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation.- Parameters:
getPackageVersionHistoryRequest- Container for request parameters toGetPackageVersionHistoryoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
getPackageVersionHistoryPaginator
default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client .getPackageVersionHistoryPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getPackageVersionHistory(software.amazon.awssdk.services.elasticsearch.model.GetPackageVersionHistoryRequest)operation.
This is a convenience which creates an instance of the
GetPackageVersionHistoryRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
getUpgradeHistory
default GetUpgradeHistoryResponse getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
- Parameters:
getUpgradeHistoryRequest- Container for request parameters toGetUpgradeHistoryoperation.- Returns:
- Result of the GetUpgradeHistory operation returned by the service.
- Throws:
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.AwsServiceException
-
getUpgradeHistory
default GetUpgradeHistoryResponse getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the complete history of the last 10 upgrades that were performed on the domain.
This is a convenience which creates an instance of the
GetUpgradeHistoryRequest.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:
- Result of the GetUpgradeHistory operation returned by the service.
- Throws:
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.AwsServiceException
-
getUpgradeHistoryPaginator
default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client .getUpgradeHistoryPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation.- Parameters:
getUpgradeHistoryRequest- Container for request parameters toGetUpgradeHistoryoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
getUpgradeHistoryPaginator
default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client .getUpgradeHistoryPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
getUpgradeHistory(software.amazon.awssdk.services.elasticsearch.model.GetUpgradeHistoryRequest)operation.
This is a convenience which creates an instance of the
GetUpgradeHistoryRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
getUpgradeStatus
default GetUpgradeStatusResponse getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
- Parameters:
getUpgradeStatusRequest- Container for request parameters toGetUpgradeStatusoperation.- Returns:
- Result of the GetUpgradeStatus operation returned by the service.
- Throws:
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.AwsServiceException
-
getUpgradeStatus
default GetUpgradeStatusResponse getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
This is a convenience which creates an instance of the
GetUpgradeStatusRequest.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:
- Result of the GetUpgradeStatus operation returned by the service.
- Throws:
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.AwsServiceException
-
listDomainNames
default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest) throws BaseException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns the name of all Elasticsearch domains owned by the current user's account.
- Parameters:
listDomainNamesRequest- Container for the parameters to theListDomainNamesoperation.- Returns:
- Result of the ListDomainNames operation returned by the service.
- Throws:
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.AwsServiceException
-
listDomainNames
default ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) throws BaseException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns the name of all Elasticsearch domains owned by the current user's account.
This is a convenience which creates an instance of the
ListDomainNamesRequest.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:
- Result of the ListDomainNames operation returned by the service.
- Throws:
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.AwsServiceException
-
listDomainNames
default ListDomainNamesResponse listDomainNames() throws BaseException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Returns the name of all Elasticsearch domains owned by the current user's account.
- Returns:
- Result of the ListDomainNames operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listDomainNames(ListDomainNamesRequest)
-
listDomainsForPackage
default ListDomainsForPackageResponse listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all Amazon ES domains associated with the package.
- Parameters:
listDomainsForPackageRequest- Container for request parameters toListDomainsForPackageoperation.- Returns:
- Result of the ListDomainsForPackage operation returned by the service.
- Throws:
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.AwsServiceException
-
listDomainsForPackage
default ListDomainsForPackageResponse listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all Amazon ES domains associated with the package.
This is a convenience which creates an instance of the
ListDomainsForPackageRequest.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:
- Result of the ListDomainsForPackage operation returned by the service.
- Throws:
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.AwsServiceException
-
listDomainsForPackagePaginator
default ListDomainsForPackageIterable listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client .listDomainsForPackagePaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation.- Parameters:
listDomainsForPackageRequest- Container for request parameters toListDomainsForPackageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listDomainsForPackagePaginator
default ListDomainsForPackageIterable listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client .listDomainsForPackagePaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDomainsForPackage(software.amazon.awssdk.services.elasticsearch.model.ListDomainsForPackageRequest)operation.
This is a convenience which creates an instance of the
ListDomainsForPackageRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listElasticsearchInstanceTypes
default ListElasticsearchInstanceTypesResponse listElasticsearchInstanceTypes(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
- Parameters:
listElasticsearchInstanceTypesRequest- Container for the parameters to theListElasticsearchInstanceTypesoperation.- Returns:
- Result of the ListElasticsearchInstanceTypes operation returned by the service.
- Throws:
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.AwsServiceException
-
listElasticsearchInstanceTypes
default ListElasticsearchInstanceTypesResponse listElasticsearchInstanceTypes(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all Elasticsearch instance types that are supported for given ElasticsearchVersion
This is a convenience which creates an instance of the
ListElasticsearchInstanceTypesRequest.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:
- Result of the ListElasticsearchInstanceTypes operation returned by the service.
- Throws:
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.AwsServiceException
-
listElasticsearchInstanceTypesPaginator
default ListElasticsearchInstanceTypesIterable listElasticsearchInstanceTypesPaginator(ListElasticsearchInstanceTypesRequest listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client .listElasticsearchInstanceTypesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation.- Parameters:
listElasticsearchInstanceTypesRequest- Container for the parameters to theListElasticsearchInstanceTypesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listElasticsearchInstanceTypesPaginator
default ListElasticsearchInstanceTypesIterable listElasticsearchInstanceTypesPaginator(Consumer<ListElasticsearchInstanceTypesRequest.Builder> listElasticsearchInstanceTypesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client .listElasticsearchInstanceTypesPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchInstanceTypesIterable responses = client.listElasticsearchInstanceTypesPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listElasticsearchInstanceTypes(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchInstanceTypesRequest)operation.
This is a convenience which creates an instance of the
ListElasticsearchInstanceTypesRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listElasticsearchVersions
default ListElasticsearchVersionsResponse listElasticsearchVersions(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
- Parameters:
listElasticsearchVersionsRequest- Container for the parameters to 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:
- Result of the ListElasticsearchVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listElasticsearchVersions
default ListElasticsearchVersionsResponse listElasticsearchVersions(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
This is a convenience which creates an instance of the
ListElasticsearchVersionsRequest.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:
- Result of the ListElasticsearchVersions operation returned by the service.
- Throws:
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.AwsServiceException
-
listElasticsearchVersions
default ListElasticsearchVersionsResponse listElasticsearchVersions() throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
List all supported Elasticsearch versions
- Returns:
- Result of the ListElasticsearchVersions operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
listElasticsearchVersions(ListElasticsearchVersionsRequest)
-
listElasticsearchVersionsPaginator
default ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator() throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client .listElasticsearchVersionsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest)
-
listElasticsearchVersionsPaginator
default ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator(ListElasticsearchVersionsRequest listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client .listElasticsearchVersionsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.- Parameters:
listElasticsearchVersionsRequest- Container for the parameters to 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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listElasticsearchVersionsPaginator
default ListElasticsearchVersionsIterable listElasticsearchVersionsPaginator(Consumer<ListElasticsearchVersionsRequest.Builder> listElasticsearchVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client .listElasticsearchVersionsPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListElasticsearchVersionsIterable responses = client.listElasticsearchVersionsPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listElasticsearchVersions(software.amazon.awssdk.services.elasticsearch.model.ListElasticsearchVersionsRequest)operation.
This is a convenience which creates an instance of the
ListElasticsearchVersionsRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listPackagesForDomain
default ListPackagesForDomainResponse listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all packages associated with the Amazon ES domain.
- Parameters:
listPackagesForDomainRequest- Container for request parameters toListPackagesForDomainoperation.- Returns:
- Result of the ListPackagesForDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
listPackagesForDomain
default ListPackagesForDomainResponse listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Lists all packages associated with the Amazon ES domain.
This is a convenience which creates an instance of the
ListPackagesForDomainRequest.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:
- Result of the ListPackagesForDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
listPackagesForDomainPaginator
default ListPackagesForDomainIterable listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client .listPackagesForDomainPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation.- Parameters:
listPackagesForDomainRequest- Container for request parameters toListPackagesForDomainoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listPackagesForDomainPaginator
default ListPackagesForDomainIterable listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
This is a variant of
listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
2) Using For loopsoftware.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client .listPackagesForDomainPaginator(request); for (software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.elasticsearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request); responses.iterator().forEachRemaining(....);Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPackagesForDomain(software.amazon.awssdk.services.elasticsearch.model.ListPackagesForDomainRequest)operation.
This is a convenience which creates an instance of the
ListPackagesForDomainRequest.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 iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws BaseException, ResourceNotFoundException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Returns all tags for the given Elasticsearch domain.
- Parameters:
listTagsRequest- Container for the parameters to theListTagsoperation. Specify theARNfor the Elasticsearch domain to which the tags are attached that you want to view are attached.- Returns:
- Result of the ListTags operation returned by the service.
- Throws:
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.AwsServiceException
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws BaseException, ResourceNotFoundException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Returns all tags for the given Elasticsearch domain.
This is a convenience which creates an instance of the
ListTagsRequest.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:
- Result of the ListTags operation returned by the service.
- Throws:
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.AwsServiceException
-
listVpcEndpointAccess
default ListVpcEndpointAccessResponse listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- Parameters:
listVpcEndpointAccessRequest- Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint- Returns:
- Result of the ListVpcEndpointAccess operation returned by the service.
- Throws:
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.AwsServiceException
-
listVpcEndpointAccess
default ListVpcEndpointAccessResponse listVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
This is a convenience which creates an instance of the
ListVpcEndpointAccessRequest.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:
- Result of the ListVpcEndpointAccess operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
listVpcEndpoints
default ListVpcEndpointsResponse listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest) throws InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
- Parameters:
listVpcEndpointsRequest- Container for request parameters to theListVpcEndpointsoperation.- Returns:
- Result of the ListVpcEndpoints operation returned by the service.
- Throws:
InternalException- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.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.AwsServiceException
-
listVpcEndpoints
default ListVpcEndpointsResponse listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest) throws InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
This is a convenience which creates an instance of the
ListVpcEndpointsRequest.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:
- Result of the ListVpcEndpoints operation returned by the service.
- Throws:
InternalException- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.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.AwsServiceException
-
listVpcEndpointsForDomain
default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest) throws InternalException, DisabledOperationException, ResourceNotFoundException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
- Parameters:
listVpcEndpointsForDomainRequest- Container for request parameters to theListVpcEndpointsForDomainoperation. Specifies the domain whose VPC endpoints will be listed.- Returns:
- Result of the ListVpcEndpointsForDomain operation returned by the service.
- Throws:
InternalException- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.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.AwsServiceException
-
listVpcEndpointsForDomain
default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest) throws InternalException, DisabledOperationException, ResourceNotFoundException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
This is a convenience which creates an instance of the
ListVpcEndpointsForDomainRequest.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:
- Result of the ListVpcEndpointsForDomain operation returned by the service.
- Throws:
InternalException- The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.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.AwsServiceException
-
purchaseReservedElasticsearchInstanceOffering
default PurchaseReservedElasticsearchInstanceOfferingResponse purchaseReservedElasticsearchInstanceOffering(PurchaseReservedElasticsearchInstanceOfferingRequest purchaseReservedElasticsearchInstanceOfferingRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to purchase reserved Elasticsearch instances.
- Parameters:
purchaseReservedElasticsearchInstanceOfferingRequest- Container for parameters toPurchaseReservedElasticsearchInstanceOffering- Returns:
- Result of the PurchaseReservedElasticsearchInstanceOffering operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
purchaseReservedElasticsearchInstanceOffering
default PurchaseReservedElasticsearchInstanceOfferingResponse purchaseReservedElasticsearchInstanceOffering(Consumer<PurchaseReservedElasticsearchInstanceOfferingRequest.Builder> purchaseReservedElasticsearchInstanceOfferingRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to purchase reserved Elasticsearch instances.
This is a convenience which creates an instance of the
PurchaseReservedElasticsearchInstanceOfferingRequest.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:
- Result of the PurchaseReservedElasticsearchInstanceOffering operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
rejectInboundCrossClusterSearchConnection
default RejectInboundCrossClusterSearchConnectionResponse rejectInboundCrossClusterSearchConnection(RejectInboundCrossClusterSearchConnectionRequest rejectInboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
- Parameters:
rejectInboundCrossClusterSearchConnectionRequest- Container for the parameters to theRejectInboundCrossClusterSearchConnectionoperation.- Returns:
- Result of the RejectInboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
rejectInboundCrossClusterSearchConnection
default RejectInboundCrossClusterSearchConnectionResponse rejectInboundCrossClusterSearchConnection(Consumer<RejectInboundCrossClusterSearchConnectionRequest.Builder> rejectInboundCrossClusterSearchConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, ElasticsearchException
Allows the destination domain owner to reject an inbound cross-cluster search connection request.
This is a convenience which creates an instance of the
RejectInboundCrossClusterSearchConnectionRequest.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:
- Result of the RejectInboundCrossClusterSearchConnection operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
removeTags
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws BaseException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Removes the specified set of tags from the specified Elasticsearch domain.
- Parameters:
removeTagsRequest- Container for the parameters to theRemoveTagsoperation. Specify theARNfor the Elasticsearch domain from which you want to remove the specifiedTagKey.- Returns:
- Result of the RemoveTags operation returned by the service.
- Throws:
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.AwsServiceException
-
removeTags
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws BaseException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Removes the specified set of tags from the specified Elasticsearch domain.
This is a convenience which creates an instance of the
RemoveTagsRequest.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:
- Result of the RemoveTags operation returned by the service.
- Throws:
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.AwsServiceException
-
revokeVpcEndpointAccess
default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
- Parameters:
revokeVpcEndpointAccessRequest- Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.- Returns:
- Result of the RevokeVpcEndpointAccess operation returned by the service.
- Throws:
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.AwsServiceException
-
revokeVpcEndpointAccess
default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
This is a convenience which creates an instance of the
RevokeVpcEndpointAccessRequest.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:
- Result of the RevokeVpcEndpointAccess operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
startElasticsearchServiceSoftwareUpdate
default StartElasticsearchServiceSoftwareUpdateResponse startElasticsearchServiceSoftwareUpdate(StartElasticsearchServiceSoftwareUpdateRequest startElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Schedules a service software update for an Amazon ES domain.
- Parameters:
startElasticsearchServiceSoftwareUpdateRequest- Container for the parameters to theStartElasticsearchServiceSoftwareUpdateoperation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.- Returns:
- Result of the StartElasticsearchServiceSoftwareUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
startElasticsearchServiceSoftwareUpdate
default StartElasticsearchServiceSoftwareUpdateResponse startElasticsearchServiceSoftwareUpdate(Consumer<StartElasticsearchServiceSoftwareUpdateRequest.Builder> startElasticsearchServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Schedules a service software update for an Amazon ES domain.
This is a convenience which creates an instance of the
StartElasticsearchServiceSoftwareUpdateRequest.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:
- Result of the StartElasticsearchServiceSoftwareUpdate operation returned by the service.
- Throws:
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.AwsServiceException
-
updateElasticsearchDomainConfig
default UpdateElasticsearchDomainConfigResponse updateElasticsearchDomainConfig(UpdateElasticsearchDomainConfigRequest updateElasticsearchDomainConfigRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
- Parameters:
updateElasticsearchDomainConfigRequest- Container for the parameters to theUpdateElasticsearchDomainoperation. Specifies the type and number of instances in the domain cluster.- Returns:
- Result of the UpdateElasticsearchDomainConfig operation returned by the service.
- Throws:
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.AwsServiceException
-
updateElasticsearchDomainConfig
default UpdateElasticsearchDomainConfigResponse updateElasticsearchDomainConfig(Consumer<UpdateElasticsearchDomainConfigRequest.Builder> updateElasticsearchDomainConfigRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
This is a convenience which creates an instance of the
UpdateElasticsearchDomainConfigRequest.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:
- Result of the UpdateElasticsearchDomainConfig operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackage
default UpdatePackageResponse updatePackage(UpdatePackageRequest updatePackageRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Updates a package for use with Amazon ES domains.
- Parameters:
updatePackageRequest- Container for request parameters toUpdatePackageoperation.- Returns:
- Result of the UpdatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
updatePackage
default UpdatePackageResponse updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, ElasticsearchException
Updates a package for use with Amazon ES domains.
This is a convenience which creates an instance of the
UpdatePackageRequest.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:
- Result of the UpdatePackage operation returned by the service.
- Throws:
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.AwsServiceException
-
updateVpcEndpoint
default UpdateVpcEndpointResponse updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, ValidationException, ConflictException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
- Parameters:
updateVpcEndpointRequest- Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.- Returns:
- Result of the UpdateVpcEndpoint operation returned by the service.
- Throws:
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.AwsServiceException
-
updateVpcEndpoint
default UpdateVpcEndpointResponse updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, ValidationException, ConflictException, BaseException, AwsServiceException, SdkClientException, ElasticsearchException
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
This is a convenience which creates an instance of the
UpdateVpcEndpointRequest.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:
- Result of the UpdateVpcEndpoint operation returned by the service.
- Throws:
ResourceNotFoundException- An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.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.AwsServiceException
-
upgradeElasticsearchDomain
default UpgradeElasticsearchDomainResponse upgradeElasticsearchDomain(UpgradeElasticsearchDomainRequest upgradeElasticsearchDomainRequest) throws BaseException, ResourceNotFoundException, ResourceAlreadyExistsException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
- Parameters:
upgradeElasticsearchDomainRequest- Container for request parameters toUpgradeElasticsearchDomainoperation.- Returns:
- Result of the UpgradeElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
upgradeElasticsearchDomain
default UpgradeElasticsearchDomainResponse upgradeElasticsearchDomain(Consumer<UpgradeElasticsearchDomainRequest.Builder> upgradeElasticsearchDomainRequest) throws BaseException, ResourceNotFoundException, ResourceAlreadyExistsException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, ElasticsearchException
Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
This is a convenience which creates an instance of the
UpgradeElasticsearchDomainRequest.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:
- Result of the UpgradeElasticsearchDomain operation returned by the service.
- Throws:
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.AwsServiceException
-
create
static ElasticsearchClient create()
Create aElasticsearchClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static ElasticsearchClientBuilder builder()
Create a builder that can be used to configure and create aElasticsearchClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default ElasticsearchServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-