Interface OpenSearchClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. 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 Amazon Web Services service endpoints.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptiondefault AcceptInboundConnectionResponseacceptInboundConnection(Consumer<AcceptInboundConnectionRequest.Builder> acceptInboundConnectionRequest) Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.default AcceptInboundConnectionResponseacceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest) Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.default AddDataSourceResponseaddDataSource(Consumer<AddDataSourceRequest.Builder> addDataSourceRequest) Creates a new direct-query data source to the specified domain.default AddDataSourceResponseaddDataSource(AddDataSourceRequest addDataSourceRequest) Creates a new direct-query data source to the specified domain.default AddTagsResponseaddTags(Consumer<AddTagsRequest.Builder> addTagsRequest) Attaches tags to an existing Amazon OpenSearch Service domain.default AddTagsResponseaddTags(AddTagsRequest addTagsRequest) Attaches tags to an existing Amazon OpenSearch Service domain.default AssociatePackageResponseassociatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest) Associates a package with an Amazon OpenSearch Service domain.default AssociatePackageResponseassociatePackage(AssociatePackageRequest associatePackageRequest) Associates a package with an Amazon OpenSearch Service domain.authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.static OpenSearchClientBuilderbuilder()Create a builder that can be used to configure and create aOpenSearchClient.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.cancelServiceSoftwareUpdate(Consumer<CancelServiceSoftwareUpdateRequest.Builder> cancelServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.static OpenSearchClientcreate()Create aOpenSearchClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CreateDomainResponsecreateDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) Creates an Amazon OpenSearch Service domain.default CreateDomainResponsecreateDomain(CreateDomainRequest createDomainRequest) Creates an Amazon OpenSearch Service domain.default CreateOutboundConnectionResponsecreateOutboundConnection(Consumer<CreateOutboundConnectionRequest.Builder> createOutboundConnectionRequest) Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.default CreateOutboundConnectionResponsecreateOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest) Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.default CreatePackageResponsecreatePackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) Creates a package for use with Amazon OpenSearch Service domains.default CreatePackageResponsecreatePackage(CreatePackageRequest createPackageRequest) Creates a package for use with Amazon OpenSearch Service 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 DeleteDataSourceResponsedeleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) Deletes a direct-query data source.default DeleteDataSourceResponsedeleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) Deletes a direct-query data source.default DeleteDomainResponsedeleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) Deletes an Amazon OpenSearch Service domain and all of its data.default DeleteDomainResponsedeleteDomain(DeleteDomainRequest deleteDomainRequest) Deletes an Amazon OpenSearch Service domain and all of its data.default DeleteInboundConnectionResponsedeleteInboundConnection(Consumer<DeleteInboundConnectionRequest.Builder> deleteInboundConnectionRequest) Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.default DeleteInboundConnectionResponsedeleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest) Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.default DeleteOutboundConnectionResponsedeleteOutboundConnection(Consumer<DeleteOutboundConnectionRequest.Builder> deleteOutboundConnectionRequest) Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.default DeleteOutboundConnectionResponsedeleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest) Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.default DeletePackageResponsedeletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) Deletes an Amazon OpenSearch Service package.default DeletePackageResponsedeletePackage(DeletePackageRequest deletePackageRequest) Deletes an Amazon OpenSearch Service 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 DescribeDomainResponsedescribeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.default DescribeDomainResponsedescribeDomain(DescribeDomainRequest describeDomainRequest) Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.default DescribeDomainAutoTunesResponsedescribeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.default DescribeDomainAutoTunesResponsedescribeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.default DescribeDomainAutoTunesIterabledescribeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) This is a variant ofdescribeDomainAutoTunes(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesRequest)operation.default DescribeDomainAutoTunesIterabledescribeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) This is a variant ofdescribeDomainAutoTunes(software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesRequest)operation.describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest) Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.default DescribeDomainConfigResponsedescribeDomainConfig(Consumer<DescribeDomainConfigRequest.Builder> describeDomainConfigRequest) Returns the configuration of an Amazon OpenSearch Service domain.default DescribeDomainConfigResponsedescribeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest) Returns the configuration of an Amazon OpenSearch Service domain.default DescribeDomainHealthResponsedescribeDomainHealth(Consumer<DescribeDomainHealthRequest.Builder> describeDomainHealthRequest) Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.default DescribeDomainHealthResponsedescribeDomainHealth(DescribeDomainHealthRequest describeDomainHealthRequest) Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.default DescribeDomainNodesResponsedescribeDomainNodes(Consumer<DescribeDomainNodesRequest.Builder> describeDomainNodesRequest) Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.default DescribeDomainNodesResponsedescribeDomainNodes(DescribeDomainNodesRequest describeDomainNodesRequest) Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.default DescribeDomainsResponsedescribeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest) Returns domain configuration information about the specified Amazon OpenSearch Service domains.default DescribeDomainsResponsedescribeDomains(DescribeDomainsRequest describeDomainsRequest) Returns domain configuration information about the specified Amazon OpenSearch Service domains.default DescribeDryRunProgressResponsedescribeDryRunProgress(Consumer<DescribeDryRunProgressRequest.Builder> describeDryRunProgressRequest) Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.default DescribeDryRunProgressResponsedescribeDryRunProgress(DescribeDryRunProgressRequest describeDryRunProgressRequest) Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.describeInboundConnections(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest) Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.describeInboundConnectionsPaginator(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest) This is a variant ofdescribeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest)operation.describeInboundConnectionsPaginator(DescribeInboundConnectionsRequest describeInboundConnectionsRequest) This is a variant ofdescribeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest)operation.describeInstanceTypeLimits(Consumer<DescribeInstanceTypeLimitsRequest.Builder> describeInstanceTypeLimitsRequest) Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest) Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.describeOutboundConnections(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest) Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest) Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.describeOutboundConnectionsPaginator(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest) This is a variant ofdescribeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest)operation.describeOutboundConnectionsPaginator(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest) This is a variant ofdescribeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest)operation.default DescribePackagesResponsedescribePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) Describes all packages available to OpenSearch Service.default DescribePackagesResponsedescribePackages(DescribePackagesRequest describePackagesRequest) Describes all packages available to OpenSearch Service.default DescribePackagesIterabledescribePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) This is a variant ofdescribePackages(software.amazon.awssdk.services.opensearch.model.DescribePackagesRequest)operation.default DescribePackagesIterabledescribePackagesPaginator(DescribePackagesRequest describePackagesRequest) This is a variant ofdescribePackages(software.amazon.awssdk.services.opensearch.model.DescribePackagesRequest)operation.describeReservedInstanceOfferings(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest) Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest) Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.describeReservedInstanceOfferingsPaginator(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest) This is a variant ofdescribeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest)operation.describeReservedInstanceOfferingsPaginator(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest) This is a variant ofdescribeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest)operation.describeReservedInstances(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest) Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.describeReservedInstancesPaginator(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest) This is a variant ofdescribeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest)operation.describeReservedInstancesPaginator(DescribeReservedInstancesRequest describeReservedInstancesRequest) This is a variant ofdescribeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest)operation.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) Removes a package from the specified Amazon OpenSearch Service domain.default DissociatePackageResponsedissociatePackage(DissociatePackageRequest dissociatePackageRequest) Removes a package from the specified Amazon OpenSearch Service domain.default GetCompatibleVersionsResponsegetCompatibleVersions(Consumer<GetCompatibleVersionsRequest.Builder> getCompatibleVersionsRequest) Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.default GetCompatibleVersionsResponsegetCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest) Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.default GetDataSourceResponsegetDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) Retrieves information about a direct query data source.default GetDataSourceResponsegetDataSource(GetDataSourceRequest getDataSourceRequest) Retrieves information about a direct query data source.getDomainMaintenanceStatus(Consumer<GetDomainMaintenanceStatusRequest.Builder> getDomainMaintenanceStatusRequest) The status of the maintenance action.getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest getDomainMaintenanceStatusRequest) The status of the maintenance action.default GetPackageVersionHistoryResponsegetPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).default GetPackageVersionHistoryResponsegetPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).default GetPackageVersionHistoryIterablegetPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) This is a variant ofgetPackageVersionHistory(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryRequest)operation.default GetPackageVersionHistoryIterablegetPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) This is a variant ofgetPackageVersionHistory(software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryRequest)operation.default GetUpgradeHistoryResponsegetUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.default GetUpgradeHistoryResponsegetUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.default GetUpgradeHistoryIterablegetUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) This is a variant ofgetUpgradeHistory(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryRequest)operation.default GetUpgradeHistoryIterablegetUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest) This is a variant ofgetUpgradeHistory(software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryRequest)operation.default GetUpgradeStatusResponsegetUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest) Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.default GetUpgradeStatusResponsegetUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.default ListDataSourcesResponselistDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) Lists direct-query data sources for a specific domain.default ListDataSourcesResponselistDataSources(ListDataSourcesRequest listDataSourcesRequest) Lists direct-query data sources for a specific domain.default ListDomainMaintenancesResponselistDomainMaintenances(Consumer<ListDomainMaintenancesRequest.Builder> listDomainMaintenancesRequest) A list of maintenance actions for the domain.default ListDomainMaintenancesResponselistDomainMaintenances(ListDomainMaintenancesRequest listDomainMaintenancesRequest) A list of maintenance actions for the domain.default ListDomainMaintenancesIterablelistDomainMaintenancesPaginator(Consumer<ListDomainMaintenancesRequest.Builder> listDomainMaintenancesRequest) This is a variant oflistDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest)operation.default ListDomainMaintenancesIterablelistDomainMaintenancesPaginator(ListDomainMaintenancesRequest listDomainMaintenancesRequest) This is a variant oflistDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest)operation.default ListDomainNamesResponselistDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.default ListDomainNamesResponselistDomainNames(ListDomainNamesRequest listDomainNamesRequest) Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.default ListDomainsForPackageResponselistDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) Lists all Amazon OpenSearch Service domains associated with a given package.default ListDomainsForPackageResponselistDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) Lists all Amazon OpenSearch Service domains associated with a given package.default ListDomainsForPackageIterablelistDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) This is a variant oflistDomainsForPackage(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageRequest)operation.default ListDomainsForPackageIterablelistDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest) This is a variant oflistDomainsForPackage(software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageRequest)operation.default ListInstanceTypeDetailsResponselistInstanceTypeDetails(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest) Lists all instance types and available features for a given OpenSearch or Elasticsearch version.default ListInstanceTypeDetailsResponselistInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest) Lists all instance types and available features for a given OpenSearch or Elasticsearch version.default ListInstanceTypeDetailsIterablelistInstanceTypeDetailsPaginator(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest) This is a variant oflistInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest)operation.default ListInstanceTypeDetailsIterablelistInstanceTypeDetailsPaginator(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest) This is a variant oflistInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest)operation.default ListPackagesForDomainResponselistPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) Lists all packages associated with an Amazon OpenSearch Service domain.default ListPackagesForDomainResponselistPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) Lists all packages associated with an Amazon OpenSearch Service domain.default ListPackagesForDomainIterablelistPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) This is a variant oflistPackagesForDomain(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainRequest)operation.default ListPackagesForDomainIterablelistPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest) This is a variant oflistPackagesForDomain(software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainRequest)operation.default ListScheduledActionsResponselistScheduledActions(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest) Retrieves a list of configuration changes that are scheduled for a domain.default ListScheduledActionsResponselistScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest) Retrieves a list of configuration changes that are scheduled for a domain.default ListScheduledActionsIterablelistScheduledActionsPaginator(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest) This is a variant oflistScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest)operation.default ListScheduledActionsIterablelistScheduledActionsPaginator(ListScheduledActionsRequest listScheduledActionsRequest) This is a variant oflistScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest)operation.default ListTagsResponselistTags(Consumer<ListTagsRequest.Builder> listTagsRequest) Returns all resource tags for an Amazon OpenSearch Service domain.default ListTagsResponselistTags(ListTagsRequest listTagsRequest) Returns all resource tags for an Amazon OpenSearch Service domain.default ListVersionsResponselistVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest) Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.default ListVersionsResponselistVersions(ListVersionsRequest listVersionsRequest) Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.default ListVersionsIterablelistVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest) This is a variant oflistVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest)operation.default ListVersionsIterablelistVersionsPaginator(ListVersionsRequest listVersionsRequest) This is a variant oflistVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest)operation.default ListVpcEndpointAccessResponselistVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest) Retrieves information about each Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services account and Region.default ListVpcEndpointsResponselistVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.purchaseReservedInstanceOffering(Consumer<PurchaseReservedInstanceOfferingRequest.Builder> purchaseReservedInstanceOfferingRequest) Allows you to purchase Amazon OpenSearch Service Reserved Instances.purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest) Allows you to purchase Amazon OpenSearch Service Reserved Instances.default RejectInboundConnectionResponserejectInboundConnection(Consumer<RejectInboundConnectionRequest.Builder> rejectInboundConnectionRequest) Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.default RejectInboundConnectionResponserejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest) Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.default RemoveTagsResponseremoveTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) Removes the specified set of tags from an Amazon OpenSearch Service domain.default RemoveTagsResponseremoveTags(RemoveTagsRequest removeTagsRequest) Removes the specified set of tags from an Amazon OpenSearch Service 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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadatadefault StartDomainMaintenanceResponsestartDomainMaintenance(Consumer<StartDomainMaintenanceRequest.Builder> startDomainMaintenanceRequest) Starts the node maintenance process on the data node.default StartDomainMaintenanceResponsestartDomainMaintenance(StartDomainMaintenanceRequest startDomainMaintenanceRequest) Starts the node maintenance process on the data node.startServiceSoftwareUpdate(Consumer<StartServiceSoftwareUpdateRequest.Builder> startServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon OpenSearch Service domain.startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest) Schedules a service software update for an Amazon OpenSearch Service domain.default UpdateDataSourceResponseupdateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) Updates a direct-query data source.default UpdateDataSourceResponseupdateDataSource(UpdateDataSourceRequest updateDataSourceRequest) Updates a direct-query data source.default UpdateDomainConfigResponseupdateDomainConfig(Consumer<UpdateDomainConfigRequest.Builder> updateDomainConfigRequest) Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.default UpdateDomainConfigResponseupdateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest) Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.default UpdatePackageResponseupdatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) Updates a package for use with Amazon OpenSearch Service domains.default UpdatePackageResponseupdatePackage(UpdatePackageRequest updatePackageRequest) Updates a package for use with Amazon OpenSearch Service domains.default UpdateScheduledActionResponseupdateScheduledAction(Consumer<UpdateScheduledActionRequest.Builder> updateScheduledActionRequest) Reschedules a planned domain configuration change for a later time.default UpdateScheduledActionResponseupdateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest) Reschedules a planned domain configuration change for a later time.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 UpgradeDomainResponseupgradeDomain(Consumer<UpgradeDomainRequest.Builder> upgradeDomainRequest) Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.default UpgradeDomainResponseupgradeDomain(UpgradeDomainRequest upgradeDomainRequest) Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
-
-
Method Details
-
acceptInboundConnection
default AcceptInboundConnectionResponse acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest) throws ResourceNotFoundException, LimitExceededException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
- Parameters:
acceptInboundConnectionRequest- Container for the parameters to theAcceptInboundConnectionoperation.- Returns:
- Result of the AcceptInboundConnection operation returned by the service.
-
acceptInboundConnection
default AcceptInboundConnectionResponse acceptInboundConnection(Consumer<AcceptInboundConnectionRequest.Builder> acceptInboundConnectionRequest) throws ResourceNotFoundException, LimitExceededException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
This is a convenience which creates an instance of the
AcceptInboundConnectionRequest.Builderavoiding the need to create one manually viaAcceptInboundConnectionRequest.builder()- Parameters:
acceptInboundConnectionRequest- AConsumerthat will call methods onAcceptInboundConnectionRequest.Builderto create a request. Container for the parameters to theAcceptInboundConnectionoperation.- Returns:
- Result of the AcceptInboundConnection operation returned by the service.
-
addDataSource
default AddDataSourceResponse addDataSource(AddDataSourceRequest addDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, LimitExceededException, AwsServiceException, SdkClientException, OpenSearchException Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.
- Parameters:
addDataSourceRequest- Container for the parameters to theAddDataSourceoperation.- Returns:
- Result of the AddDataSource operation returned by the service.
-
addDataSource
default AddDataSourceResponse addDataSource(Consumer<AddDataSourceRequest.Builder> addDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, LimitExceededException, AwsServiceException, SdkClientException, OpenSearchException Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.
This is a convenience which creates an instance of the
AddDataSourceRequest.Builderavoiding the need to create one manually viaAddDataSourceRequest.builder()- Parameters:
addDataSourceRequest- AConsumerthat will call methods onAddDataSourceRequest.Builderto create a request. Container for the parameters to theAddDataSourceoperation.- Returns:
- Result of the AddDataSource operation returned by the service.
-
addTags
default AddTagsResponse addTags(AddTagsRequest addTagsRequest) throws BaseException, LimitExceededException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
- Parameters:
addTagsRequest- Container for the parameters to theAddTagsoperation. Specifies the tags to attach to the domain.- Returns:
- Result of the AddTags operation returned by the service.
-
addTags
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest) throws BaseException, LimitExceededException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
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. Specifies the tags to attach to the domain.- Returns:
- Result of the AddTags operation returned by the service.
-
associatePackage
default AssociatePackageResponse associatePackage(AssociatePackageRequest associatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, OpenSearchException Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
associatePackageRequest- Container for the request parameters to theAssociatePackageoperation.- Returns:
- Result of the AssociatePackage operation returned by the service.
-
associatePackage
default AssociatePackageResponse associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, OpenSearchException Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
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 the request parameters to theAssociatePackageoperation.- Returns:
- Result of the AssociatePackage operation returned by the service.
-
authorizeVpcEndpointAccess
default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, LimitExceededException, ValidationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- Parameters:
authorizeVpcEndpointAccessRequest-- Returns:
- Result of the AuthorizeVpcEndpointAccess operation returned by the service.
-
authorizeVpcEndpointAccess
default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, LimitExceededException, ValidationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the AuthorizeVpcEndpointAccess operation returned by the service.
-
cancelDomainConfigChange
default CancelDomainConfigChangeResponse cancelDomainConfigChange(CancelDomainConfigChangeRequest cancelDomainConfigChangeRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Cancels a pending configuration change on an Amazon OpenSearch Service domain.
- Parameters:
cancelDomainConfigChangeRequest-- Returns:
- Result of the CancelDomainConfigChange operation returned by the service.
-
cancelDomainConfigChange
default CancelDomainConfigChangeResponse cancelDomainConfigChange(Consumer<CancelDomainConfigChangeRequest.Builder> cancelDomainConfigChangeRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the CancelDomainConfigChange operation returned by the service.
-
cancelServiceSoftwareUpdate
default CancelServiceSoftwareUpdateResponse cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the
AutomatedUpdateDateand when the domain'sUpdateStatusisPENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.- Parameters:
cancelServiceSoftwareUpdateRequest- Container for the request parameters to cancel a service software update.- Returns:
- Result of the CancelServiceSoftwareUpdate operation returned by the service.
-
cancelServiceSoftwareUpdate
default CancelServiceSoftwareUpdateResponse cancelServiceSoftwareUpdate(Consumer<CancelServiceSoftwareUpdateRequest.Builder> cancelServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the
AutomatedUpdateDateand when the domain'sUpdateStatusisPENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.
This is a convenience which creates an instance of the
CancelServiceSoftwareUpdateRequest.Builderavoiding the need to create one manually viaCancelServiceSoftwareUpdateRequest.builder()- Parameters:
cancelServiceSoftwareUpdateRequest- AConsumerthat will call methods onCancelServiceSoftwareUpdateRequest.Builderto create a request. Container for the request parameters to cancel a service software update.- Returns:
- Result of the CancelServiceSoftwareUpdate operation returned by the service.
-
createDomain
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest) throws BaseException, DisabledOperationException, InternalException, InvalidTypeException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
- Parameters:
createDomainRequest-- Returns:
- Result of the CreateDomain operation returned by the service.
-
createDomain
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest) throws BaseException, DisabledOperationException, InternalException, InvalidTypeException, LimitExceededException, ResourceAlreadyExistsException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
This is a convenience which creates an instance of the
CreateDomainRequest.Builderavoiding the need to create one manually viaCreateDomainRequest.builder()- Parameters:
createDomainRequest- AConsumerthat will call methods onCreateDomainRequest.Builderto create a request.- Returns:
- Result of the CreateDomain operation returned by the service.
-
createOutboundConnection
default CreateOutboundConnectionResponse createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest) throws LimitExceededException, InternalException, ResourceAlreadyExistsException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
- Parameters:
createOutboundConnectionRequest- Container for the parameters to theCreateOutboundConnectionoperation.- Returns:
- Result of the CreateOutboundConnection operation returned by the service.
-
createOutboundConnection
default CreateOutboundConnectionResponse createOutboundConnection(Consumer<CreateOutboundConnectionRequest.Builder> createOutboundConnectionRequest) throws LimitExceededException, InternalException, ResourceAlreadyExistsException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
This is a convenience which creates an instance of the
CreateOutboundConnectionRequest.Builderavoiding the need to create one manually viaCreateOutboundConnectionRequest.builder()- Parameters:
createOutboundConnectionRequest- AConsumerthat will call methods onCreateOutboundConnectionRequest.Builderto create a request. Container for the parameters to theCreateOutboundConnectionoperation.- Returns:
- Result of the CreateOutboundConnection operation returned by the service.
-
createPackage
default CreatePackageResponse createPackage(CreatePackageRequest createPackageRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceAlreadyExistsException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
createPackageRequest- Container for request parameters to theCreatePackageoperation.- Returns:
- Result of the CreatePackage operation returned by the service.
-
createPackage
default CreatePackageResponse createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest) throws BaseException, InternalException, LimitExceededException, InvalidTypeException, ResourceAlreadyExistsException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
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 to theCreatePackageoperation.- Returns:
- Result of the CreatePackage operation returned by the service.
-
createVpcEndpoint
default CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) throws ConflictException, ValidationException, LimitExceededException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Creates an Amazon OpenSearch Service-managed VPC endpoint.
- Parameters:
createVpcEndpointRequest-- Returns:
- Result of the CreateVpcEndpoint operation returned by the service.
-
createVpcEndpoint
default CreateVpcEndpointResponse createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest) throws ConflictException, ValidationException, LimitExceededException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the CreateVpcEndpoint operation returned by the service.
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(DeleteDataSourceRequest deleteDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
- Parameters:
deleteDataSourceRequest- Container for the parameters to theDeleteDataSourceoperation.- Returns:
- Result of the DeleteDataSource operation returned by the service.
-
deleteDataSource
default DeleteDataSourceResponse deleteDataSource(Consumer<DeleteDataSourceRequest.Builder> deleteDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
This is a convenience which creates an instance of the
DeleteDataSourceRequest.Builderavoiding the need to create one manually viaDeleteDataSourceRequest.builder()- Parameters:
deleteDataSourceRequest- AConsumerthat will call methods onDeleteDataSourceRequest.Builderto create a request. Container for the parameters to theDeleteDataSourceoperation.- Returns:
- Result of the DeleteDataSource operation returned by the service.
-
deleteDomain
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
- Parameters:
deleteDomainRequest- Container for the parameters to theDeleteDomainoperation.- Returns:
- Result of the DeleteDomain operation returned by the service.
-
deleteDomain
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
This is a convenience which creates an instance of the
DeleteDomainRequest.Builderavoiding the need to create one manually viaDeleteDomainRequest.builder()- Parameters:
deleteDomainRequest- AConsumerthat will call methods onDeleteDomainRequest.Builderto create a request. Container for the parameters to theDeleteDomainoperation.- Returns:
- Result of the DeleteDomain operation returned by the service.
-
deleteInboundConnection
default DeleteInboundConnectionResponse deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
- Parameters:
deleteInboundConnectionRequest- Container for the parameters to theDeleteInboundConnectionoperation.- Returns:
- Result of the DeleteInboundConnection operation returned by the service.
-
deleteInboundConnection
default DeleteInboundConnectionResponse deleteInboundConnection(Consumer<DeleteInboundConnectionRequest.Builder> deleteInboundConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
This is a convenience which creates an instance of the
DeleteInboundConnectionRequest.Builderavoiding the need to create one manually viaDeleteInboundConnectionRequest.builder()- Parameters:
deleteInboundConnectionRequest- AConsumerthat will call methods onDeleteInboundConnectionRequest.Builderto create a request. Container for the parameters to theDeleteInboundConnectionoperation.- Returns:
- Result of the DeleteInboundConnection operation returned by the service.
-
deleteOutboundConnection
default DeleteOutboundConnectionResponse deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
- Parameters:
deleteOutboundConnectionRequest- Container for the parameters to theDeleteOutboundConnectionoperation.- Returns:
- Result of the DeleteOutboundConnection operation returned by the service.
-
deleteOutboundConnection
default DeleteOutboundConnectionResponse deleteOutboundConnection(Consumer<DeleteOutboundConnectionRequest.Builder> deleteOutboundConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
This is a convenience which creates an instance of the
DeleteOutboundConnectionRequest.Builderavoiding the need to create one manually viaDeleteOutboundConnectionRequest.builder()- Parameters:
deleteOutboundConnectionRequest- AConsumerthat will call methods onDeleteOutboundConnectionRequest.Builderto create a request. Container for the parameters to theDeleteOutboundConnectionoperation.- Returns:
- Result of the DeleteOutboundConnection operation returned by the service.
-
deletePackage
default DeletePackageResponse deletePackage(DeletePackageRequest deletePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, OpenSearchException Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
deletePackageRequest- Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.- Returns:
- Result of the DeletePackage operation returned by the service.
-
deletePackage
default DeletePackageResponse deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, OpenSearchException Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
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. Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.- Returns:
- Result of the DeletePackage operation returned by the service.
-
deleteVpcEndpoint
default DeleteVpcEndpointResponse deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
- Parameters:
deleteVpcEndpointRequest-- Returns:
- Result of the DeleteVpcEndpoint operation returned by the service.
-
deleteVpcEndpoint
default DeleteVpcEndpointResponse deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the DeleteVpcEndpoint operation returned by the service.
-
describeDomain
default DescribeDomainResponse describeDomain(DescribeDomainRequest describeDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
- Parameters:
describeDomainRequest- Container for the parameters to theDescribeDomainoperation.- Returns:
- Result of the DescribeDomain operation returned by the service.
-
describeDomain
default DescribeDomainResponse describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
This is a convenience which creates an instance of the
DescribeDomainRequest.Builderavoiding the need to create one manually viaDescribeDomainRequest.builder()- Parameters:
describeDomainRequest- AConsumerthat will call methods onDescribeDomainRequest.Builderto create a request. Container for the parameters to theDescribeDomainoperation.- Returns:
- Result of the DescribeDomain operation returned by the service.
-
describeDomainAutoTunes
default DescribeDomainAutoTunesResponse describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
- Parameters:
describeDomainAutoTunesRequest- Container for the parameters to theDescribeDomainAutoTunesoperation.- Returns:
- Result of the DescribeDomainAutoTunes operation returned by the service.
-
describeDomainAutoTunes
default DescribeDomainAutoTunesResponse describeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
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.
-
describeDomainAutoTunesPaginator
default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeDomainAutoTunes(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeDomainAutoTunesIterable responses = client .describeDomainAutoTunesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.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.
-
describeDomainAutoTunesPaginator
default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeDomainAutoTunes(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeDomainAutoTunesIterable responses = client .describeDomainAutoTunesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeDomainAutoTunesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.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.
-
describeDomainChangeProgress
default DescribeDomainChangeProgressResponse describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
- Parameters:
describeDomainChangeProgressRequest- Container for the parameters to theDescribeDomainChangeProgressoperation.- Returns:
- Result of the DescribeDomainChangeProgress operation returned by the service.
-
describeDomainChangeProgress
default DescribeDomainChangeProgressResponse describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
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.- Returns:
- Result of the DescribeDomainChangeProgress operation returned by the service.
-
describeDomainConfig
default DescribeDomainConfigResponse describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns the configuration of an Amazon OpenSearch Service domain.
- Parameters:
describeDomainConfigRequest- Container for the parameters to theDescribeDomainConfigoperation.- Returns:
- Result of the DescribeDomainConfig operation returned by the service.
-
describeDomainConfig
default DescribeDomainConfigResponse describeDomainConfig(Consumer<DescribeDomainConfigRequest.Builder> describeDomainConfigRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns the configuration of an Amazon OpenSearch Service domain.
This is a convenience which creates an instance of the
DescribeDomainConfigRequest.Builderavoiding the need to create one manually viaDescribeDomainConfigRequest.builder()- Parameters:
describeDomainConfigRequest- AConsumerthat will call methods onDescribeDomainConfigRequest.Builderto create a request. Container for the parameters to theDescribeDomainConfigoperation.- Returns:
- Result of the DescribeDomainConfig operation returned by the service.
-
describeDomainHealth
default DescribeDomainHealthResponse describeDomainHealth(DescribeDomainHealthRequest describeDomainHealthRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
- Parameters:
describeDomainHealthRequest- Container for the parameters to theDescribeDomainHealthoperation.- Returns:
- Result of the DescribeDomainHealth operation returned by the service.
-
describeDomainHealth
default DescribeDomainHealthResponse describeDomainHealth(Consumer<DescribeDomainHealthRequest.Builder> describeDomainHealthRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
This is a convenience which creates an instance of the
DescribeDomainHealthRequest.Builderavoiding the need to create one manually viaDescribeDomainHealthRequest.builder()- Parameters:
describeDomainHealthRequest- AConsumerthat will call methods onDescribeDomainHealthRequest.Builderto create a request. Container for the parameters to theDescribeDomainHealthoperation.- Returns:
- Result of the DescribeDomainHealth operation returned by the service.
-
describeDomainNodes
default DescribeDomainNodesResponse describeDomainNodes(DescribeDomainNodesRequest describeDomainNodesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
- Parameters:
describeDomainNodesRequest- Container for the parameters to theDescribeDomainNodesoperation.- Returns:
- Result of the DescribeDomainNodes operation returned by the service.
-
describeDomainNodes
default DescribeDomainNodesResponse describeDomainNodes(Consumer<DescribeDomainNodesRequest.Builder> describeDomainNodesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
This is a convenience which creates an instance of the
DescribeDomainNodesRequest.Builderavoiding the need to create one manually viaDescribeDomainNodesRequest.builder()- Parameters:
describeDomainNodesRequest- AConsumerthat will call methods onDescribeDomainNodesRequest.Builderto create a request. Container for the parameters to theDescribeDomainNodesoperation.- Returns:
- Result of the DescribeDomainNodes operation returned by the service.
-
describeDomains
default DescribeDomainsResponse describeDomains(DescribeDomainsRequest describeDomainsRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns domain configuration information about the specified Amazon OpenSearch Service domains.
- Parameters:
describeDomainsRequest- Container for the parameters to theDescribeDomainsoperation.- Returns:
- Result of the DescribeDomains operation returned by the service.
-
describeDomains
default DescribeDomainsResponse describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns domain configuration information about the specified Amazon OpenSearch Service domains.
This is a convenience which creates an instance of the
DescribeDomainsRequest.Builderavoiding the need to create one manually viaDescribeDomainsRequest.builder()- Parameters:
describeDomainsRequest- AConsumerthat will call methods onDescribeDomainsRequest.Builderto create a request. Container for the parameters to theDescribeDomainsoperation.- Returns:
- Result of the DescribeDomains operation returned by the service.
-
describeDryRunProgress
default DescribeDryRunProgressResponse describeDryRunProgress(DescribeDryRunProgressRequest describeDryRunProgressRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.
- Parameters:
describeDryRunProgressRequest-- Returns:
- Result of the DescribeDryRunProgress operation returned by the service.
-
describeDryRunProgress
default DescribeDryRunProgressResponse describeDryRunProgress(Consumer<DescribeDryRunProgressRequest.Builder> describeDryRunProgressRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.
This is a convenience which creates an instance of the
DescribeDryRunProgressRequest.Builderavoiding the need to create one manually viaDescribeDryRunProgressRequest.builder()- Parameters:
describeDryRunProgressRequest- AConsumerthat will call methods onDescribeDryRunProgressRequest.Builderto create a request.- Returns:
- Result of the DescribeDryRunProgress operation returned by the service.
-
describeInboundConnections
default DescribeInboundConnectionsResponse describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
- Parameters:
describeInboundConnectionsRequest- Container for the parameters to theDescribeInboundConnectionsoperation.- Returns:
- Result of the DescribeInboundConnections operation returned by the service.
-
describeInboundConnections
default DescribeInboundConnectionsResponse describeInboundConnections(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
This is a convenience which creates an instance of the
DescribeInboundConnectionsRequest.Builderavoiding the need to create one manually viaDescribeInboundConnectionsRequest.builder()- Parameters:
describeInboundConnectionsRequest- AConsumerthat will call methods onDescribeInboundConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeInboundConnectionsoperation.- Returns:
- Result of the DescribeInboundConnections operation returned by the service.
-
describeInboundConnectionsPaginator
default DescribeInboundConnectionsIterable describeInboundConnectionsPaginator(DescribeInboundConnectionsRequest describeInboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest)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.opensearch.paginators.DescribeInboundConnectionsIterable responses = client.describeInboundConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsIterable responses = client .describeInboundConnectionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsIterable responses = client.describeInboundConnectionsPaginator(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
describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest)operation.- Parameters:
describeInboundConnectionsRequest- Container for the parameters to theDescribeInboundConnectionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeInboundConnectionsPaginator
default DescribeInboundConnectionsIterable describeInboundConnectionsPaginator(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest)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.opensearch.paginators.DescribeInboundConnectionsIterable responses = client.describeInboundConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsIterable responses = client .describeInboundConnectionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsIterable responses = client.describeInboundConnectionsPaginator(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
describeInboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeInboundConnectionsRequest)operation.
This is a convenience which creates an instance of the
DescribeInboundConnectionsRequest.Builderavoiding the need to create one manually viaDescribeInboundConnectionsRequest.builder()- Parameters:
describeInboundConnectionsRequest- AConsumerthat will call methods onDescribeInboundConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeInboundConnectionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeInstanceTypeLimits
default DescribeInstanceTypeLimitsResponse describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
- Parameters:
describeInstanceTypeLimitsRequest- Container for the parameters to theDescribeInstanceTypeLimitsoperation.- Returns:
- Result of the DescribeInstanceTypeLimits operation returned by the service.
-
describeInstanceTypeLimits
default DescribeInstanceTypeLimitsResponse describeInstanceTypeLimits(Consumer<DescribeInstanceTypeLimitsRequest.Builder> describeInstanceTypeLimitsRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
This is a convenience which creates an instance of the
DescribeInstanceTypeLimitsRequest.Builderavoiding the need to create one manually viaDescribeInstanceTypeLimitsRequest.builder()- Parameters:
describeInstanceTypeLimitsRequest- AConsumerthat will call methods onDescribeInstanceTypeLimitsRequest.Builderto create a request. Container for the parameters to theDescribeInstanceTypeLimitsoperation.- Returns:
- Result of the DescribeInstanceTypeLimits operation returned by the service.
-
describeOutboundConnections
default DescribeOutboundConnectionsResponse describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
- Parameters:
describeOutboundConnectionsRequest- Container for the parameters to theDescribeOutboundConnectionsoperation.- Returns:
- Result of the DescribeOutboundConnections operation returned by the service.
-
describeOutboundConnections
default DescribeOutboundConnectionsResponse describeOutboundConnections(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
This is a convenience which creates an instance of the
DescribeOutboundConnectionsRequest.Builderavoiding the need to create one manually viaDescribeOutboundConnectionsRequest.builder()- Parameters:
describeOutboundConnectionsRequest- AConsumerthat will call methods onDescribeOutboundConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeOutboundConnectionsoperation.- Returns:
- Result of the DescribeOutboundConnections operation returned by the service.
-
describeOutboundConnectionsPaginator
default DescribeOutboundConnectionsIterable describeOutboundConnectionsPaginator(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest)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.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client.describeOutboundConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client .describeOutboundConnectionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client.describeOutboundConnectionsPaginator(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
describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest)operation.- Parameters:
describeOutboundConnectionsRequest- Container for the parameters to theDescribeOutboundConnectionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeOutboundConnectionsPaginator
default DescribeOutboundConnectionsIterable describeOutboundConnectionsPaginator(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest) throws InvalidPaginationTokenException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest)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.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client.describeOutboundConnectionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client .describeOutboundConnectionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client.describeOutboundConnectionsPaginator(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
describeOutboundConnections(software.amazon.awssdk.services.opensearch.model.DescribeOutboundConnectionsRequest)operation.
This is a convenience which creates an instance of the
DescribeOutboundConnectionsRequest.Builderavoiding the need to create one manually viaDescribeOutboundConnectionsRequest.builder()- Parameters:
describeOutboundConnectionsRequest- AConsumerthat will call methods onDescribeOutboundConnectionsRequest.Builderto create a request. Container for the parameters to theDescribeOutboundConnectionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describePackages
default DescribePackagesResponse describePackages(DescribePackagesRequest describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
describePackagesRequest- Container for the request parameters to theDescribePackageoperation.- Returns:
- Result of the DescribePackages operation returned by the service.
-
describePackages
default DescribePackagesResponse describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
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 the request parameters to theDescribePackageoperation.- Returns:
- Result of the DescribePackages operation returned by the service.
-
describePackagesPaginator
default DescribePackagesIterable describePackagesPaginator(DescribePackagesRequest describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describePackages(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribePackagesIterable responses = client .describePackagesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribePackagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.model.DescribePackagesRequest)operation.- Parameters:
describePackagesRequest- Container for the request parameters to theDescribePackageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describePackagesPaginator
default DescribePackagesIterable describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describePackages(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribePackagesIterable responses = client .describePackagesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribePackagesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.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 the request parameters to theDescribePackageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeReservedInstanceOfferings
default DescribeReservedInstanceOfferingsResponse describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
- Parameters:
describeReservedInstanceOfferingsRequest- Container for the request parameters to aDescribeReservedInstanceOfferingsoperation.- Returns:
- Result of the DescribeReservedInstanceOfferings operation returned by the service.
-
describeReservedInstanceOfferings
default DescribeReservedInstanceOfferingsResponse describeReservedInstanceOfferings(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
This is a convenience which creates an instance of the
DescribeReservedInstanceOfferingsRequest.Builderavoiding the need to create one manually viaDescribeReservedInstanceOfferingsRequest.builder()- Parameters:
describeReservedInstanceOfferingsRequest- AConsumerthat will call methods onDescribeReservedInstanceOfferingsRequest.Builderto create a request. Container for the request parameters to aDescribeReservedInstanceOfferingsoperation.- Returns:
- Result of the DescribeReservedInstanceOfferings operation returned by the service.
-
describeReservedInstanceOfferingsPaginator
default DescribeReservedInstanceOfferingsIterable describeReservedInstanceOfferingsPaginator(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest)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.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client.describeReservedInstanceOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client .describeReservedInstanceOfferingsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client.describeReservedInstanceOfferingsPaginator(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
describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest)operation.- Parameters:
describeReservedInstanceOfferingsRequest- Container for the request parameters to aDescribeReservedInstanceOfferingsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeReservedInstanceOfferingsPaginator
default DescribeReservedInstanceOfferingsIterable describeReservedInstanceOfferingsPaginator(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest)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.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client.describeReservedInstanceOfferingsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client .describeReservedInstanceOfferingsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client.describeReservedInstanceOfferingsPaginator(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
describeReservedInstanceOfferings(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstanceOfferingsRequest)operation.
This is a convenience which creates an instance of the
DescribeReservedInstanceOfferingsRequest.Builderavoiding the need to create one manually viaDescribeReservedInstanceOfferingsRequest.builder()- Parameters:
describeReservedInstanceOfferingsRequest- AConsumerthat will call methods onDescribeReservedInstanceOfferingsRequest.Builderto create a request. Container for the request parameters to aDescribeReservedInstanceOfferingsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeReservedInstances
default DescribeReservedInstancesResponse describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
- Parameters:
describeReservedInstancesRequest- Container for the request parameters to theDescribeReservedInstancesoperation.- Returns:
- Result of the DescribeReservedInstances operation returned by the service.
-
describeReservedInstances
default DescribeReservedInstancesResponse describeReservedInstances(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
This is a convenience which creates an instance of the
DescribeReservedInstancesRequest.Builderavoiding the need to create one manually viaDescribeReservedInstancesRequest.builder()- Parameters:
describeReservedInstancesRequest- AConsumerthat will call methods onDescribeReservedInstancesRequest.Builderto create a request. Container for the request parameters to theDescribeReservedInstancesoperation.- Returns:
- Result of the DescribeReservedInstances operation returned by the service.
-
describeReservedInstancesPaginator
default DescribeReservedInstancesIterable describeReservedInstancesPaginator(DescribeReservedInstancesRequest describeReservedInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest)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.opensearch.paginators.DescribeReservedInstancesIterable responses = client.describeReservedInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesIterable responses = client .describeReservedInstancesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesIterable responses = client.describeReservedInstancesPaginator(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
describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest)operation.- Parameters:
describeReservedInstancesRequest- Container for the request parameters to theDescribeReservedInstancesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeReservedInstancesPaginator
default DescribeReservedInstancesIterable describeReservedInstancesPaginator(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest) throws ResourceNotFoundException, InternalException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest)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.opensearch.paginators.DescribeReservedInstancesIterable responses = client.describeReservedInstancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesIterable responses = client .describeReservedInstancesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesIterable responses = client.describeReservedInstancesPaginator(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
describeReservedInstances(software.amazon.awssdk.services.opensearch.model.DescribeReservedInstancesRequest)operation.
This is a convenience which creates an instance of the
DescribeReservedInstancesRequest.Builderavoiding the need to create one manually viaDescribeReservedInstancesRequest.builder()- Parameters:
describeReservedInstancesRequest- AConsumerthat will call methods onDescribeReservedInstancesRequest.Builderto create a request. Container for the request parameters to theDescribeReservedInstancesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
describeVpcEndpoints
default DescribeVpcEndpointsResponse describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) throws ValidationException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
- Parameters:
describeVpcEndpointsRequest-- Returns:
- Result of the DescribeVpcEndpoints operation returned by the service.
-
describeVpcEndpoints
default DescribeVpcEndpointsResponse describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest) throws ValidationException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the DescribeVpcEndpoints operation returned by the service.
-
dissociatePackage
default DissociatePackageResponse dissociatePackage(DissociatePackageRequest dissociatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, OpenSearchException Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
dissociatePackageRequest- Container for the request parameters to theDissociatePackageoperation.- Returns:
- Result of the DissociatePackage operation returned by the service.
-
dissociatePackage
default DissociatePackageResponse dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, ConflictException, AwsServiceException, SdkClientException, OpenSearchException Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
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 the request parameters to theDissociatePackageoperation.- Returns:
- Result of the DissociatePackage operation returned by the service.
-
getCompatibleVersions
default GetCompatibleVersionsResponse getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
- Parameters:
getCompatibleVersionsRequest- Container for the request parameters toGetCompatibleVersionsoperation.- Returns:
- Result of the GetCompatibleVersions operation returned by the service.
-
getCompatibleVersions
default GetCompatibleVersionsResponse getCompatibleVersions(Consumer<GetCompatibleVersionsRequest.Builder> getCompatibleVersionsRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
This is a convenience which creates an instance of the
GetCompatibleVersionsRequest.Builderavoiding the need to create one manually viaGetCompatibleVersionsRequest.builder()- Parameters:
getCompatibleVersionsRequest- AConsumerthat will call methods onGetCompatibleVersionsRequest.Builderto create a request. Container for the request parameters toGetCompatibleVersionsoperation.- Returns:
- Result of the GetCompatibleVersions operation returned by the service.
-
getDataSource
default GetDataSourceResponse getDataSource(GetDataSourceRequest getDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Retrieves information about a direct query data source.
- Parameters:
getDataSourceRequest- Container for the parameters to theGetDataSourceoperation.- Returns:
- Result of the GetDataSource operation returned by the service.
-
getDataSource
default GetDataSourceResponse getDataSource(Consumer<GetDataSourceRequest.Builder> getDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Retrieves information about a direct query data source.
This is a convenience which creates an instance of the
GetDataSourceRequest.Builderavoiding the need to create one manually viaGetDataSourceRequest.builder()- Parameters:
getDataSourceRequest- AConsumerthat will call methods onGetDataSourceRequest.Builderto create a request. Container for the parameters to theGetDataSourceoperation.- Returns:
- Result of the GetDataSource operation returned by the service.
-
getDomainMaintenanceStatus
default GetDomainMaintenanceStatusResponse getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest getDomainMaintenanceStatusRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException The status of the maintenance action.
- Parameters:
getDomainMaintenanceStatusRequest- Container for the parameters to theGetDomainMaintenanceStatusoperation.- Returns:
- Result of the GetDomainMaintenanceStatus operation returned by the service.
-
getDomainMaintenanceStatus
default GetDomainMaintenanceStatusResponse getDomainMaintenanceStatus(Consumer<GetDomainMaintenanceStatusRequest.Builder> getDomainMaintenanceStatusRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException The status of the maintenance action.
This is a convenience which creates an instance of the
GetDomainMaintenanceStatusRequest.Builderavoiding the need to create one manually viaGetDomainMaintenanceStatusRequest.builder()- Parameters:
getDomainMaintenanceStatusRequest- AConsumerthat will call methods onGetDomainMaintenanceStatusRequest.Builderto create a request. Container for the parameters to theGetDomainMaintenanceStatusoperation.- Returns:
- Result of the GetDomainMaintenanceStatus operation returned by the service.
-
getPackageVersionHistory
default GetPackageVersionHistoryResponse getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
getPackageVersionHistoryRequest- Container for the request parameters to theGetPackageVersionHistoryoperation.- Returns:
- Result of the GetPackageVersionHistory operation returned by the service.
-
getPackageVersionHistory
default GetPackageVersionHistoryResponse getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.
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 the request parameters to theGetPackageVersionHistoryoperation.- Returns:
- Result of the GetPackageVersionHistory operation returned by the service.
-
getPackageVersionHistoryPaginator
default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
getPackageVersionHistory(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.GetPackageVersionHistoryIterable responses = client .getPackageVersionHistoryPaginator(request); for (software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.model.GetPackageVersionHistoryRequest)operation.- Parameters:
getPackageVersionHistoryRequest- Container for the request parameters to theGetPackageVersionHistoryoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
getPackageVersionHistoryPaginator
default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
getPackageVersionHistory(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.GetPackageVersionHistoryIterable responses = client .getPackageVersionHistoryPaginator(request); for (software.amazon.awssdk.services.opensearch.model.GetPackageVersionHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.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 the request parameters to theGetPackageVersionHistoryoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
getUpgradeHistory
default GetUpgradeHistoryResponse getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
- Parameters:
getUpgradeHistoryRequest- Container for the request parameters to theGetUpgradeHistoryoperation.- Returns:
- Result of the GetUpgradeHistory operation returned by the service.
-
getUpgradeHistory
default GetUpgradeHistoryResponse getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service 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 the request parameters to theGetUpgradeHistoryoperation.- Returns:
- Result of the GetUpgradeHistory operation returned by the service.
-
getUpgradeHistoryPaginator
default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.GetUpgradeHistoryIterable responses = client .getUpgradeHistoryPaginator(request); for (software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.model.GetUpgradeHistoryRequest)operation.- Parameters:
getUpgradeHistoryRequest- Container for the request parameters to theGetUpgradeHistoryoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
getUpgradeHistoryPaginator
default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
getUpgradeHistory(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.GetUpgradeHistoryIterable responses = client .getUpgradeHistoryPaginator(request); for (software.amazon.awssdk.services.opensearch.model.GetUpgradeHistoryResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.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 the request parameters to theGetUpgradeHistoryoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
getUpgradeStatus
default GetUpgradeStatusResponse getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
- Parameters:
getUpgradeStatusRequest- Container for the request parameters to theGetUpgradeStatusoperation.- Returns:
- Result of the GetUpgradeStatus operation returned by the service.
-
getUpgradeStatus
default GetUpgradeStatusResponse getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest) throws BaseException, ResourceNotFoundException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service 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 the request parameters to theGetUpgradeStatusoperation.- Returns:
- Result of the GetUpgradeStatus operation returned by the service.
-
listDataSources
default ListDataSourcesResponse listDataSources(ListDataSourcesRequest listDataSourcesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
- Parameters:
listDataSourcesRequest- Container for the parameters to theListDataSourcesoperation.- Returns:
- Result of the ListDataSources operation returned by the service.
-
listDataSources
default ListDataSourcesResponse listDataSources(Consumer<ListDataSourcesRequest.Builder> listDataSourcesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
This is a convenience which creates an instance of the
ListDataSourcesRequest.Builderavoiding the need to create one manually viaListDataSourcesRequest.builder()- Parameters:
listDataSourcesRequest- AConsumerthat will call methods onListDataSourcesRequest.Builderto create a request. Container for the parameters to theListDataSourcesoperation.- Returns:
- Result of the ListDataSources operation returned by the service.
-
listDomainMaintenances
default ListDomainMaintenancesResponse listDomainMaintenances(ListDomainMaintenancesRequest listDomainMaintenancesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException A list of maintenance actions for the domain.
- Parameters:
listDomainMaintenancesRequest- Container for the parameters to theListDomainMaintenancesoperation.- Returns:
- Result of the ListDomainMaintenances operation returned by the service.
-
listDomainMaintenances
default ListDomainMaintenancesResponse listDomainMaintenances(Consumer<ListDomainMaintenancesRequest.Builder> listDomainMaintenancesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException A list of maintenance actions for the domain.
This is a convenience which creates an instance of the
ListDomainMaintenancesRequest.Builderavoiding the need to create one manually viaListDomainMaintenancesRequest.builder()- Parameters:
listDomainMaintenancesRequest- AConsumerthat will call methods onListDomainMaintenancesRequest.Builderto create a request. Container for the parameters to theListDomainMaintenancesoperation.- Returns:
- Result of the ListDomainMaintenances operation returned by the service.
-
listDomainMaintenancesPaginator
default ListDomainMaintenancesIterable listDomainMaintenancesPaginator(ListDomainMaintenancesRequest listDomainMaintenancesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest)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.opensearch.paginators.ListDomainMaintenancesIterable responses = client.listDomainMaintenancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListDomainMaintenancesIterable responses = client .listDomainMaintenancesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListDomainMaintenancesIterable responses = client.listDomainMaintenancesPaginator(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
listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest)operation.- Parameters:
listDomainMaintenancesRequest- Container for the parameters to theListDomainMaintenancesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listDomainMaintenancesPaginator
default ListDomainMaintenancesIterable listDomainMaintenancesPaginator(Consumer<ListDomainMaintenancesRequest.Builder> listDomainMaintenancesRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest)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.opensearch.paginators.ListDomainMaintenancesIterable responses = client.listDomainMaintenancesPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListDomainMaintenancesIterable responses = client .listDomainMaintenancesPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListDomainMaintenancesIterable responses = client.listDomainMaintenancesPaginator(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
listDomainMaintenances(software.amazon.awssdk.services.opensearch.model.ListDomainMaintenancesRequest)operation.
This is a convenience which creates an instance of the
ListDomainMaintenancesRequest.Builderavoiding the need to create one manually viaListDomainMaintenancesRequest.builder()- Parameters:
listDomainMaintenancesRequest- AConsumerthat will call methods onListDomainMaintenancesRequest.Builderto create a request. Container for the parameters to theListDomainMaintenancesoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listDomainNames
default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest) throws BaseException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
- Parameters:
listDomainNamesRequest- Container for the parameters to theListDomainNamesoperation.- Returns:
- Result of the ListDomainNames operation returned by the service.
-
listDomainNames
default ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest) throws BaseException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
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.
-
listDomainsForPackage
default ListDomainsForPackageResponse listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
listDomainsForPackageRequest- Container for the request parameters to theListDomainsForPackageoperation.- Returns:
- Result of the ListDomainsForPackage operation returned by the service.
-
listDomainsForPackage
default ListDomainsForPackageResponse listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
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 the request parameters to theListDomainsForPackageoperation.- Returns:
- Result of the ListDomainsForPackage operation returned by the service.
-
listDomainsForPackagePaginator
default ListDomainsForPackageIterable listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listDomainsForPackage(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListDomainsForPackageIterable responses = client .listDomainsForPackagePaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.model.ListDomainsForPackageRequest)operation.- Parameters:
listDomainsForPackageRequest- Container for the request parameters to theListDomainsForPackageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listDomainsForPackagePaginator
default ListDomainsForPackageIterable listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listDomainsForPackage(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListDomainsForPackageIterable responses = client .listDomainsForPackagePaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListDomainsForPackageResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.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 the request parameters to theListDomainsForPackageoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listInstanceTypeDetails
default ListInstanceTypeDetailsResponse listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
- Parameters:
listInstanceTypeDetailsRequest-- Returns:
- Result of the ListInstanceTypeDetails operation returned by the service.
-
listInstanceTypeDetails
default ListInstanceTypeDetailsResponse listInstanceTypeDetails(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
This is a convenience which creates an instance of the
ListInstanceTypeDetailsRequest.Builderavoiding the need to create one manually viaListInstanceTypeDetailsRequest.builder()- Parameters:
listInstanceTypeDetailsRequest- AConsumerthat will call methods onListInstanceTypeDetailsRequest.Builderto create a request.- Returns:
- Result of the ListInstanceTypeDetails operation returned by the service.
-
listInstanceTypeDetailsPaginator
default ListInstanceTypeDetailsIterable listInstanceTypeDetailsPaginator(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest)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.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client.listInstanceTypeDetailsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client .listInstanceTypeDetailsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client.listInstanceTypeDetailsPaginator(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
listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest)operation.- Parameters:
listInstanceTypeDetailsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listInstanceTypeDetailsPaginator
default ListInstanceTypeDetailsIterable listInstanceTypeDetailsPaginator(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest)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.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client.listInstanceTypeDetailsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client .listInstanceTypeDetailsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client.listInstanceTypeDetailsPaginator(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
listInstanceTypeDetails(software.amazon.awssdk.services.opensearch.model.ListInstanceTypeDetailsRequest)operation.
This is a convenience which creates an instance of the
ListInstanceTypeDetailsRequest.Builderavoiding the need to create one manually viaListInstanceTypeDetailsRequest.builder()- Parameters:
listInstanceTypeDetailsRequest- AConsumerthat will call methods onListInstanceTypeDetailsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listPackagesForDomain
default ListPackagesForDomainResponse listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
listPackagesForDomainRequest- Container for the request parameters to theListPackagesForDomainoperation.- Returns:
- Result of the ListPackagesForDomain operation returned by the service.
-
listPackagesForDomain
default ListPackagesForDomainResponse listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
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 the request parameters to theListPackagesForDomainoperation.- Returns:
- Result of the ListPackagesForDomain operation returned by the service.
-
listPackagesForDomainPaginator
default ListPackagesForDomainIterable listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listPackagesForDomain(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListPackagesForDomainIterable responses = client .listPackagesForDomainPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.model.ListPackagesForDomainRequest)operation.- Parameters:
listPackagesForDomainRequest- Container for the request parameters to theListPackagesForDomainoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listPackagesForDomainPaginator
default ListPackagesForDomainIterable listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest) throws BaseException, InternalException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listPackagesForDomain(software.amazon.awssdk.services.opensearch.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.opensearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListPackagesForDomainIterable responses = client .listPackagesForDomainPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListPackagesForDomainResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.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.opensearch.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 the request parameters to theListPackagesForDomainoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listScheduledActions
default ListScheduledActionsResponse listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest) throws BaseException, InternalException, ResourceNotFoundException, InvalidPaginationTokenException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.
- Parameters:
listScheduledActionsRequest-- Returns:
- Result of the ListScheduledActions operation returned by the service.
-
listScheduledActions
default ListScheduledActionsResponse listScheduledActions(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest) throws BaseException, InternalException, ResourceNotFoundException, InvalidPaginationTokenException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.
This is a convenience which creates an instance of the
ListScheduledActionsRequest.Builderavoiding the need to create one manually viaListScheduledActionsRequest.builder()- Parameters:
listScheduledActionsRequest- AConsumerthat will call methods onListScheduledActionsRequest.Builderto create a request.- Returns:
- Result of the ListScheduledActions operation returned by the service.
-
listScheduledActionsPaginator
default ListScheduledActionsIterable listScheduledActionsPaginator(ListScheduledActionsRequest listScheduledActionsRequest) throws BaseException, InternalException, ResourceNotFoundException, InvalidPaginationTokenException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest)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.opensearch.paginators.ListScheduledActionsIterable responses = client.listScheduledActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsIterable responses = client .listScheduledActionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListScheduledActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsIterable responses = client.listScheduledActionsPaginator(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
listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest)operation.- Parameters:
listScheduledActionsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listScheduledActionsPaginator
default ListScheduledActionsIterable listScheduledActionsPaginator(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest) throws BaseException, InternalException, ResourceNotFoundException, InvalidPaginationTokenException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest)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.opensearch.paginators.ListScheduledActionsIterable responses = client.listScheduledActionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsIterable responses = client .listScheduledActionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListScheduledActionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsIterable responses = client.listScheduledActionsPaginator(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
listScheduledActions(software.amazon.awssdk.services.opensearch.model.ListScheduledActionsRequest)operation.
This is a convenience which creates an instance of the
ListScheduledActionsRequest.Builderavoiding the need to create one manually viaListScheduledActionsRequest.builder()- Parameters:
listScheduledActionsRequest- AConsumerthat will call methods onListScheduledActionsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listTags
default ListTagsResponse listTags(ListTagsRequest listTagsRequest) throws BaseException, ResourceNotFoundException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
- Parameters:
listTagsRequest- Container for the parameters to theListTagsoperation.- Returns:
- Result of the ListTags operation returned by the service.
-
listTags
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest) throws BaseException, ResourceNotFoundException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
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.- Returns:
- Result of the ListTags operation returned by the service.
-
listVersions
default ListVersionsResponse listVersions(ListVersionsRequest listVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
- Parameters:
listVersionsRequest- Container for the request parameters to theListVersionsoperation.- Returns:
- Result of the ListVersions operation returned by the service.
-
listVersions
default ListVersionsResponse listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
This is a convenience which creates an instance of the
ListVersionsRequest.Builderavoiding the need to create one manually viaListVersionsRequest.builder()- Parameters:
listVersionsRequest- AConsumerthat will call methods onListVersionsRequest.Builderto create a request. Container for the request parameters to theListVersionsoperation.- Returns:
- Result of the ListVersions operation returned by the service.
-
listVersionsPaginator
default ListVersionsIterable listVersionsPaginator(ListVersionsRequest listVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest)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.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(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
listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest)operation.- Parameters:
listVersionsRequest- Container for the request parameters to theListVersionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listVersionsPaginator
default ListVersionsIterable listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException This is a variant of
listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest)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.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request); responses.stream().forEach(....);{ @code software.amazon.awssdk.services.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request); for (software.amazon.awssdk.services.opensearch.model.ListVersionsResponse response : responses) { // do something; } }3) Use iterator directlysoftware.amazon.awssdk.services.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(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
listVersions(software.amazon.awssdk.services.opensearch.model.ListVersionsRequest)operation.
This is a convenience which creates an instance of the
ListVersionsRequest.Builderavoiding the need to create one manually viaListVersionsRequest.builder()- Parameters:
listVersionsRequest- AConsumerthat will call methods onListVersionsRequest.Builderto create a request. Container for the request parameters to theListVersionsoperation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
-
listVpcEndpointAccess
default ListVpcEndpointAccessResponse listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
- Parameters:
listVpcEndpointAccessRequest-- Returns:
- Result of the ListVpcEndpointAccess operation returned by the service.
-
listVpcEndpointAccess
default ListVpcEndpointAccessResponse listVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Retrieves information about each Amazon Web Services 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.- Returns:
- Result of the ListVpcEndpointAccess operation returned by the service.
-
listVpcEndpoints
default ListVpcEndpointsResponse listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest) throws InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
- Parameters:
listVpcEndpointsRequest-- Returns:
- Result of the ListVpcEndpoints operation returned by the service.
-
listVpcEndpoints
default ListVpcEndpointsResponse listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest) throws InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services 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.- Returns:
- Result of the ListVpcEndpoints operation returned by the service.
-
listVpcEndpointsForDomain
default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest) throws InternalException, DisabledOperationException, ResourceNotFoundException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
- Parameters:
listVpcEndpointsForDomainRequest-- Returns:
- Result of the ListVpcEndpointsForDomain operation returned by the service.
-
listVpcEndpointsForDomain
default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest) throws InternalException, DisabledOperationException, ResourceNotFoundException, BaseException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the ListVpcEndpointsForDomain operation returned by the service.
-
purchaseReservedInstanceOffering
default PurchaseReservedInstanceOfferingResponse purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Allows you to purchase Amazon OpenSearch Service Reserved Instances.
- Parameters:
purchaseReservedInstanceOfferingRequest- Container for request parameters to thePurchaseReservedInstanceOfferingoperation.- Returns:
- Result of the PurchaseReservedInstanceOffering operation returned by the service.
-
purchaseReservedInstanceOffering
default PurchaseReservedInstanceOfferingResponse purchaseReservedInstanceOffering(Consumer<PurchaseReservedInstanceOfferingRequest.Builder> purchaseReservedInstanceOfferingRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Allows you to purchase Amazon OpenSearch Service Reserved Instances.
This is a convenience which creates an instance of the
PurchaseReservedInstanceOfferingRequest.Builderavoiding the need to create one manually viaPurchaseReservedInstanceOfferingRequest.builder()- Parameters:
purchaseReservedInstanceOfferingRequest- AConsumerthat will call methods onPurchaseReservedInstanceOfferingRequest.Builderto create a request. Container for request parameters to thePurchaseReservedInstanceOfferingoperation.- Returns:
- Result of the PurchaseReservedInstanceOffering operation returned by the service.
-
rejectInboundConnection
default RejectInboundConnectionResponse rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
- Parameters:
rejectInboundConnectionRequest- Container for the request parameters to theRejectInboundConnectionoperation.- Returns:
- Result of the RejectInboundConnection operation returned by the service.
-
rejectInboundConnection
default RejectInboundConnectionResponse rejectInboundConnection(Consumer<RejectInboundConnectionRequest.Builder> rejectInboundConnectionRequest) throws ResourceNotFoundException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
This is a convenience which creates an instance of the
RejectInboundConnectionRequest.Builderavoiding the need to create one manually viaRejectInboundConnectionRequest.builder()- Parameters:
rejectInboundConnectionRequest- AConsumerthat will call methods onRejectInboundConnectionRequest.Builderto create a request. Container for the request parameters to theRejectInboundConnectionoperation.- Returns:
- Result of the RejectInboundConnection operation returned by the service.
-
removeTags
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest) throws BaseException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
- Parameters:
removeTagsRequest- Container for the request parameters to theRemoveTagsoperation.- Returns:
- Result of the RemoveTags operation returned by the service.
-
removeTags
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest) throws BaseException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
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 request parameters to theRemoveTagsoperation.- Returns:
- Result of the RemoveTags operation returned by the service.
-
revokeVpcEndpointAccess
default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
- Parameters:
revokeVpcEndpointAccessRequest-- Returns:
- Result of the RevokeVpcEndpointAccess operation returned by the service.
-
revokeVpcEndpointAccess
default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest) throws ResourceNotFoundException, ValidationException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the RevokeVpcEndpointAccess operation returned by the service.
-
startDomainMaintenance
default StartDomainMaintenanceResponse startDomainMaintenance(StartDomainMaintenanceRequest startDomainMaintenanceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.
- Parameters:
startDomainMaintenanceRequest- Container for the parameters to theStartDomainMaintenanceoperation.- Returns:
- Result of the StartDomainMaintenance operation returned by the service.
-
startDomainMaintenance
default StartDomainMaintenanceResponse startDomainMaintenance(Consumer<StartDomainMaintenanceRequest.Builder> startDomainMaintenanceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, AwsServiceException, SdkClientException, OpenSearchException Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.
This is a convenience which creates an instance of the
StartDomainMaintenanceRequest.Builderavoiding the need to create one manually viaStartDomainMaintenanceRequest.builder()- Parameters:
startDomainMaintenanceRequest- AConsumerthat will call methods onStartDomainMaintenanceRequest.Builderto create a request. Container for the parameters to theStartDomainMaintenanceoperation.- Returns:
- Result of the StartDomainMaintenance operation returned by the service.
-
startServiceSoftwareUpdate
default StartServiceSoftwareUpdateResponse startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
- Parameters:
startServiceSoftwareUpdateRequest- Container for the request parameters to theStartServiceSoftwareUpdateoperation.- Returns:
- Result of the StartServiceSoftwareUpdate operation returned by the service.
-
startServiceSoftwareUpdate
default StartServiceSoftwareUpdateResponse startServiceSoftwareUpdate(Consumer<StartServiceSoftwareUpdateRequest.Builder> startServiceSoftwareUpdateRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
This is a convenience which creates an instance of the
StartServiceSoftwareUpdateRequest.Builderavoiding the need to create one manually viaStartServiceSoftwareUpdateRequest.builder()- Parameters:
startServiceSoftwareUpdateRequest- AConsumerthat will call methods onStartServiceSoftwareUpdateRequest.Builderto create a request. Container for the request parameters to theStartServiceSoftwareUpdateoperation.- Returns:
- Result of the StartServiceSoftwareUpdate operation returned by the service.
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(UpdateDataSourceRequest updateDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.
- Parameters:
updateDataSourceRequest- Container for the parameters to theUpdateDataSourceoperation.- Returns:
- Result of the UpdateDataSource operation returned by the service.
-
updateDataSource
default UpdateDataSourceResponse updateDataSource(Consumer<UpdateDataSourceRequest.Builder> updateDataSourceRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, DisabledOperationException, DependencyFailureException, AwsServiceException, SdkClientException, OpenSearchException Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.
This is a convenience which creates an instance of the
UpdateDataSourceRequest.Builderavoiding the need to create one manually viaUpdateDataSourceRequest.builder()- Parameters:
updateDataSourceRequest- AConsumerthat will call methods onUpdateDataSourceRequest.Builderto create a request. Container for the parameters to theUpdateDataSourceoperation.- Returns:
- Result of the UpdateDataSource operation returned by the service.
-
updateDomainConfig
default UpdateDomainConfigResponse updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
- Parameters:
updateDomainConfigRequest- Container for the request parameters to theUpdateDomainoperation.- Returns:
- Result of the UpdateDomainConfig operation returned by the service.
-
updateDomainConfig
default UpdateDomainConfigResponse updateDomainConfig(Consumer<UpdateDomainConfigRequest.Builder> updateDomainConfigRequest) throws BaseException, InternalException, InvalidTypeException, LimitExceededException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
This is a convenience which creates an instance of the
UpdateDomainConfigRequest.Builderavoiding the need to create one manually viaUpdateDomainConfigRequest.builder()- Parameters:
updateDomainConfigRequest- AConsumerthat will call methods onUpdateDomainConfigRequest.Builderto create a request. Container for the request parameters to theUpdateDomainoperation.- Returns:
- Result of the UpdateDomainConfig operation returned by the service.
-
updatePackage
default UpdatePackageResponse updatePackage(UpdatePackageRequest updatePackageRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
- Parameters:
updatePackageRequest- Container for request parameters to theUpdatePackageoperation.- Returns:
- Result of the UpdatePackage operation returned by the service.
-
updatePackage
default UpdatePackageResponse updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest) throws BaseException, InternalException, LimitExceededException, ResourceNotFoundException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
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 to theUpdatePackageoperation.- Returns:
- Result of the UpdatePackage operation returned by the service.
-
updateScheduledAction
default UpdateScheduledActionResponse updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest) throws BaseException, InternalException, ResourceNotFoundException, SlotNotAvailableException, ConflictException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.
- Parameters:
updateScheduledActionRequest-- Returns:
- Result of the UpdateScheduledAction operation returned by the service.
-
updateScheduledAction
default UpdateScheduledActionResponse updateScheduledAction(Consumer<UpdateScheduledActionRequest.Builder> updateScheduledActionRequest) throws BaseException, InternalException, ResourceNotFoundException, SlotNotAvailableException, ConflictException, LimitExceededException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.
This is a convenience which creates an instance of the
UpdateScheduledActionRequest.Builderavoiding the need to create one manually viaUpdateScheduledActionRequest.builder()- Parameters:
updateScheduledActionRequest- AConsumerthat will call methods onUpdateScheduledActionRequest.Builderto create a request.- Returns:
- Result of the UpdateScheduledAction operation returned by the service.
-
updateVpcEndpoint
default UpdateVpcEndpointResponse updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, ValidationException, ConflictException, BaseException, AwsServiceException, SdkClientException, OpenSearchException Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
- Parameters:
updateVpcEndpointRequest-- Returns:
- Result of the UpdateVpcEndpoint operation returned by the service.
-
updateVpcEndpoint
default UpdateVpcEndpointResponse updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, ValidationException, ConflictException, BaseException, AwsServiceException, SdkClientException, OpenSearchException 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.- Returns:
- Result of the UpdateVpcEndpoint operation returned by the service.
-
upgradeDomain
default UpgradeDomainResponse upgradeDomain(UpgradeDomainRequest upgradeDomainRequest) throws BaseException, ResourceNotFoundException, ResourceAlreadyExistsException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
- Parameters:
upgradeDomainRequest- Container for the request parameters to theUpgradeDomainoperation.- Returns:
- Result of the UpgradeDomain operation returned by the service.
-
upgradeDomain
default UpgradeDomainResponse upgradeDomain(Consumer<UpgradeDomainRequest.Builder> upgradeDomainRequest) throws BaseException, ResourceNotFoundException, ResourceAlreadyExistsException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
This is a convenience which creates an instance of the
UpgradeDomainRequest.Builderavoiding the need to create one manually viaUpgradeDomainRequest.builder()- Parameters:
upgradeDomainRequest- AConsumerthat will call methods onUpgradeDomainRequest.Builderto create a request. Container for the request parameters to theUpgradeDomainoperation.- Returns:
- Result of the UpgradeDomain operation returned by the service.
-
create
Create aOpenSearchClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aOpenSearchClient. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-