@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface OpenSearchClient extends AwsClient
builder()
method.
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.
For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default AcceptInboundConnectionResponse |
acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest)
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search
connection request.
|
default AcceptInboundConnectionResponse |
acceptInboundConnection(Consumer<AcceptInboundConnectionRequest.Builder> acceptInboundConnectionRequest)
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search
connection request.
|
default AddTagsResponse |
addTags(AddTagsRequest addTagsRequest)
Attaches tags to an existing Amazon OpenSearch Service domain.
|
default AddTagsResponse |
addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
Attaches tags to an existing Amazon OpenSearch Service domain.
|
default AssociatePackageResponse |
associatePackage(AssociatePackageRequest associatePackageRequest)
Associates a package with an Amazon OpenSearch Service domain.
|
default AssociatePackageResponse |
associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest)
Associates a package with an Amazon OpenSearch Service domain.
|
default AuthorizeVpcEndpointAccessResponse |
authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
|
default AuthorizeVpcEndpointAccessResponse |
authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest)
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
|
static OpenSearchClientBuilder |
builder()
Create a builder that can be used to configure and create a
OpenSearchClient. |
default CancelServiceSoftwareUpdateResponse |
cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest)
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
|
default CancelServiceSoftwareUpdateResponse |
cancelServiceSoftwareUpdate(Consumer<CancelServiceSoftwareUpdateRequest.Builder> cancelServiceSoftwareUpdateRequest)
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
|
static OpenSearchClient |
create()
Create a
OpenSearchClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CreateDomainResponse |
createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
Creates an Amazon OpenSearch Service domain.
|
default CreateDomainResponse |
createDomain(CreateDomainRequest createDomainRequest)
Creates an Amazon OpenSearch Service domain.
|
default CreateOutboundConnectionResponse |
createOutboundConnection(Consumer<CreateOutboundConnectionRequest.Builder> createOutboundConnectionRequest)
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination
domain.
|
default CreateOutboundConnectionResponse |
createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest)
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination
domain.
|
default CreatePackageResponse |
createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest)
Creates a package for use with Amazon OpenSearch Service domains.
|
default CreatePackageResponse |
createPackage(CreatePackageRequest createPackageRequest)
Creates a package for use with Amazon OpenSearch Service domains.
|
default CreateVpcEndpointResponse |
createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)
Creates an Amazon OpenSearch Service-managed VPC endpoint.
|
default CreateVpcEndpointResponse |
createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
Creates an Amazon OpenSearch Service-managed VPC endpoint.
|
default DeleteDomainResponse |
deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
Deletes an Amazon OpenSearch Service domain and all of its data.
|
default DeleteDomainResponse |
deleteDomain(DeleteDomainRequest deleteDomainRequest)
Deletes an Amazon OpenSearch Service domain and all of its data.
|
default DeleteInboundConnectionResponse |
deleteInboundConnection(Consumer<DeleteInboundConnectionRequest.Builder> deleteInboundConnectionRequest)
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search
connection.
|
default DeleteInboundConnectionResponse |
deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest)
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search
connection.
|
default DeleteOutboundConnectionResponse |
deleteOutboundConnection(Consumer<DeleteOutboundConnectionRequest.Builder> deleteOutboundConnectionRequest)
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search
connection.
|
default DeleteOutboundConnectionResponse |
deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest)
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search
connection.
|
default DeletePackageResponse |
deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest)
Deletes an Amazon OpenSearch Service package.
|
default DeletePackageResponse |
deletePackage(DeletePackageRequest deletePackageRequest)
Deletes an Amazon OpenSearch Service package.
|
default DeleteVpcEndpointResponse |
deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
|
default DeleteVpcEndpointResponse |
deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
|
default DescribeDomainResponse |
describeDomain(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 DescribeDomainResponse |
describeDomain(DescribeDomainRequest describeDomainRequest)
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID,
domain service endpoint, and domain ARN.
|
default DescribeDomainAutoTunesResponse |
describeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
|
default DescribeDomainAutoTunesResponse |
describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
|
default DescribeDomainAutoTunesIterable |
describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
|
default DescribeDomainAutoTunesIterable |
describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
|
default DescribeDomainChangeProgressResponse |
describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest)
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
|
default DescribeDomainChangeProgressResponse |
describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
|
default DescribeDomainConfigResponse |
describeDomainConfig(Consumer<DescribeDomainConfigRequest.Builder> describeDomainConfigRequest)
Returns the configuration of an Amazon OpenSearch Service domain.
|
default DescribeDomainConfigResponse |
describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest)
Returns the configuration of an Amazon OpenSearch Service domain.
|
default DescribeDomainHealthResponse |
describeDomainHealth(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 DescribeDomainHealthResponse |
describeDomainHealth(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 DescribeDomainNodesResponse |
describeDomainNodes(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 DescribeDomainNodesResponse |
describeDomainNodes(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 DescribeDomainsResponse |
describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest)
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
|
default DescribeDomainsResponse |
describeDomains(DescribeDomainsRequest describeDomainsRequest)
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
|
default DescribeDryRunProgressResponse |
describeDryRunProgress(Consumer<DescribeDryRunProgressRequest.Builder> describeDryRunProgressRequest)
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
|
default DescribeDryRunProgressResponse |
describeDryRunProgress(DescribeDryRunProgressRequest describeDryRunProgressRequest)
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
|
default DescribeInboundConnectionsResponse |
describeInboundConnections(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest)
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service
domain.
|
default DescribeInboundConnectionsResponse |
describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service
domain.
|
default DescribeInboundConnectionsIterable |
describeInboundConnectionsPaginator(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest)
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service
domain.
|
default DescribeInboundConnectionsIterable |
describeInboundConnectionsPaginator(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service
domain.
|
default DescribeInstanceTypeLimitsResponse |
describeInstanceTypeLimits(Consumer<DescribeInstanceTypeLimitsRequest.Builder> describeInstanceTypeLimitsRequest)
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and
instance type.
|
default DescribeInstanceTypeLimitsResponse |
describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest)
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and
instance type.
|
default DescribeOutboundConnectionsResponse |
describeOutboundConnections(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest)
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
|
default DescribeOutboundConnectionsResponse |
describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
|
default DescribeOutboundConnectionsIterable |
describeOutboundConnectionsPaginator(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest)
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
|
default DescribeOutboundConnectionsIterable |
describeOutboundConnectionsPaginator(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
|
default DescribePackagesResponse |
describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)
Describes all packages available to OpenSearch Service.
|
default DescribePackagesResponse |
describePackages(DescribePackagesRequest describePackagesRequest)
Describes all packages available to OpenSearch Service.
|
default DescribePackagesIterable |
describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)
Describes all packages available to OpenSearch Service.
|
default DescribePackagesIterable |
describePackagesPaginator(DescribePackagesRequest describePackagesRequest)
Describes all packages available to OpenSearch Service.
|
default DescribeReservedInstanceOfferingsResponse |
describeReservedInstanceOfferings(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest)
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
|
default DescribeReservedInstanceOfferingsResponse |
describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
|
default DescribeReservedInstanceOfferingsIterable |
describeReservedInstanceOfferingsPaginator(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest)
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
|
default DescribeReservedInstanceOfferingsIterable |
describeReservedInstanceOfferingsPaginator(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
|
default DescribeReservedInstancesResponse |
describeReservedInstances(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest)
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
|
default DescribeReservedInstancesResponse |
describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
|
default DescribeReservedInstancesIterable |
describeReservedInstancesPaginator(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest)
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
|
default DescribeReservedInstancesIterable |
describeReservedInstancesPaginator(DescribeReservedInstancesRequest describeReservedInstancesRequest)
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
|
default DescribeVpcEndpointsResponse |
describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest)
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
|
default DescribeVpcEndpointsResponse |
describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
|
default DissociatePackageResponse |
dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest)
Removes a package from the specified Amazon OpenSearch Service domain.
|
default DissociatePackageResponse |
dissociatePackage(DissociatePackageRequest dissociatePackageRequest)
Removes a package from the specified Amazon OpenSearch Service domain.
|
default GetCompatibleVersionsResponse |
getCompatibleVersions(Consumer<GetCompatibleVersionsRequest.Builder> getCompatibleVersionsRequest)
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
|
default GetCompatibleVersionsResponse |
getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest)
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
|
default GetPackageVersionHistoryResponse |
getPackageVersionHistory(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 GetPackageVersionHistoryResponse |
getPackageVersionHistory(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 GetPackageVersionHistoryIterable |
getPackageVersionHistoryPaginator(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 GetPackageVersionHistoryIterable |
getPackageVersionHistoryPaginator(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 GetUpgradeHistoryResponse |
getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
|
default GetUpgradeHistoryResponse |
getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
|
default GetUpgradeHistoryIterable |
getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
|
default GetUpgradeHistoryIterable |
getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
|
default GetUpgradeStatusResponse |
getUpgradeStatus(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 GetUpgradeStatusResponse |
getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch
Service domain.
|
default ListDomainNamesResponse |
listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
|
default ListDomainNamesResponse |
listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
|
default ListDomainsForPackageResponse |
listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)
Lists all Amazon OpenSearch Service domains associated with a given package.
|
default ListDomainsForPackageResponse |
listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)
Lists all Amazon OpenSearch Service domains associated with a given package.
|
default ListDomainsForPackageIterable |
listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)
Lists all Amazon OpenSearch Service domains associated with a given package.
|
default ListDomainsForPackageIterable |
listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest)
Lists all Amazon OpenSearch Service domains associated with a given package.
|
default ListInstanceTypeDetailsResponse |
listInstanceTypeDetails(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest)
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
|
default ListInstanceTypeDetailsResponse |
listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
|
default ListInstanceTypeDetailsIterable |
listInstanceTypeDetailsPaginator(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest)
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
|
default ListInstanceTypeDetailsIterable |
listInstanceTypeDetailsPaginator(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
|
default ListPackagesForDomainResponse |
listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)
Lists all packages associated with an Amazon OpenSearch Service domain.
|
default ListPackagesForDomainResponse |
listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)
Lists all packages associated with an Amazon OpenSearch Service domain.
|
default ListPackagesForDomainIterable |
listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)
Lists all packages associated with an Amazon OpenSearch Service domain.
|
default ListPackagesForDomainIterable |
listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest)
Lists all packages associated with an Amazon OpenSearch Service domain.
|
default ListScheduledActionsResponse |
listScheduledActions(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest)
Retrieves a list of configuration changes that are scheduled for a domain.
|
default ListScheduledActionsResponse |
listScheduledActions(ListScheduledActionsRequest listScheduledActionsRequest)
Retrieves a list of configuration changes that are scheduled for a domain.
|
default ListScheduledActionsIterable |
listScheduledActionsPaginator(Consumer<ListScheduledActionsRequest.Builder> listScheduledActionsRequest)
Retrieves a list of configuration changes that are scheduled for a domain.
|
default ListScheduledActionsIterable |
listScheduledActionsPaginator(ListScheduledActionsRequest listScheduledActionsRequest)
Retrieves a list of configuration changes that are scheduled for a domain.
|
default ListTagsResponse |
listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
Returns all resource tags for an Amazon OpenSearch Service domain.
|
default ListTagsResponse |
listTags(ListTagsRequest listTagsRequest)
Returns all resource tags for an Amazon OpenSearch Service domain.
|
default ListVersionsResponse |
listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
|
default ListVersionsResponse |
listVersions(ListVersionsRequest listVersionsRequest)
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
|
default ListVersionsIterable |
listVersionsPaginator(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
|
default ListVersionsIterable |
listVersionsPaginator(ListVersionsRequest listVersionsRequest)
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
|
default ListVpcEndpointAccessResponse |
listVpcEndpointAccess(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 ListVpcEndpointAccessResponse |
listVpcEndpointAccess(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 ListVpcEndpointsResponse |
listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and
Region.
|
default ListVpcEndpointsResponse |
listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and
Region.
|
default ListVpcEndpointsForDomainResponse |
listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
|
default ListVpcEndpointsForDomainResponse |
listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
|
default PurchaseReservedInstanceOfferingResponse |
purchaseReservedInstanceOffering(Consumer<PurchaseReservedInstanceOfferingRequest.Builder> purchaseReservedInstanceOfferingRequest)
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
|
default PurchaseReservedInstanceOfferingResponse |
purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest)
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
|
default RejectInboundConnectionResponse |
rejectInboundConnection(Consumer<RejectInboundConnectionRequest.Builder> rejectInboundConnectionRequest)
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
|
default RejectInboundConnectionResponse |
rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest)
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
|
default RemoveTagsResponse |
removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
Removes the specified set of tags from an Amazon OpenSearch Service domain.
|
default RemoveTagsResponse |
removeTags(RemoveTagsRequest removeTagsRequest)
Removes the specified set of tags from an Amazon OpenSearch Service domain.
|
default RevokeVpcEndpointAccessResponse |
revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest)
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
|
default RevokeVpcEndpointAccessResponse |
revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
|
default OpenSearchServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartServiceSoftwareUpdateResponse |
startServiceSoftwareUpdate(Consumer<StartServiceSoftwareUpdateRequest.Builder> startServiceSoftwareUpdateRequest)
Schedules a service software update for an Amazon OpenSearch Service domain.
|
default StartServiceSoftwareUpdateResponse |
startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest)
Schedules a service software update for an Amazon OpenSearch Service domain.
|
default UpdateDomainConfigResponse |
updateDomainConfig(Consumer<UpdateDomainConfigRequest.Builder> updateDomainConfigRequest)
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.sl
|
default UpdateDomainConfigResponse |
updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest)
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.sl
|
default UpdatePackageResponse |
updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest)
Updates a package for use with Amazon OpenSearch Service domains.
|
default UpdatePackageResponse |
updatePackage(UpdatePackageRequest updatePackageRequest)
Updates a package for use with Amazon OpenSearch Service domains.
|
default UpdateScheduledActionResponse |
updateScheduledAction(Consumer<UpdateScheduledActionRequest.Builder> updateScheduledActionRequest)
Reschedules a planned domain configuration change for a later time.
|
default UpdateScheduledActionResponse |
updateScheduledAction(UpdateScheduledActionRequest updateScheduledActionRequest)
Reschedules a planned domain configuration change for a later time.
|
default UpdateVpcEndpointResponse |
updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
|
default UpdateVpcEndpointResponse |
updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
|
default UpgradeDomainResponse |
upgradeDomain(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 UpgradeDomainResponse |
upgradeDomain(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.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.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.
acceptInboundConnectionRequest - Container for the parameters to the AcceptInboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via AcceptInboundConnectionRequest.builder()
acceptInboundConnectionRequest - A Consumer that will call methods on AcceptInboundConnectionRequest.Builder to create a
request. Container for the parameters to the AcceptInboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
addTagsRequest - Container for the parameters to the AddTags operation. Specifies the tags to attach to the
domain.BaseException - An error occurred while processing the request.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to create
one manually via AddTagsRequest.builder()
addTagsRequest - A Consumer that will call methods on AddTagsRequest.Builder to create a request. Container
for the parameters to the AddTags operation. Specifies the tags to attach to the domain.BaseException - An error occurred while processing the request.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
associatePackageRequest - Container for the request parameters to the AssociatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via AssociatePackageRequest.builder()
associatePackageRequest - A Consumer that will call methods on AssociatePackageRequest.Builder to create a request.
Container for the request parameters to the AssociatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
authorizeVpcEndpointAccessRequest - ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via AuthorizeVpcEndpointAccessRequest.builder()
authorizeVpcEndpointAccessRequest - A Consumer that will call methods on AuthorizeVpcEndpointAccessRequest.Builder to create a
request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AutomatedUpdateDate and when the domain's UpdateStatus is
PENDING_UPDATE. For more information, see Service
software updates in Amazon OpenSearch Service.
cancelServiceSoftwareUpdateRequest - Container for the request parameters to cancel a service software update.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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 AutomatedUpdateDate and when the domain's UpdateStatus is
PENDING_UPDATE. For more information, see Service
software updates in Amazon OpenSearch Service.
This is a convenience which creates an instance of the CancelServiceSoftwareUpdateRequest.Builder
avoiding the need to create one manually via CancelServiceSoftwareUpdateRequest.builder()
cancelServiceSoftwareUpdateRequest - A Consumer that will call methods on CancelServiceSoftwareUpdateRequest.Builder to create
a request. Container for the request parameters to cancel a service software update.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createDomainRequest - BaseException - An error occurred while processing the request.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceAlreadyExistsException - An exception for creating a resource that already exists.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via CreateDomainRequest.builder()
createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.BaseException - An error occurred while processing the request.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceAlreadyExistsException - An exception for creating a resource that already exists.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createOutboundConnectionRequest - Container for the parameters to the CreateOutboundConnection operation.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceAlreadyExistsException - An exception for creating a resource that already exists.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via CreateOutboundConnectionRequest.builder()
createOutboundConnectionRequest - A Consumer that will call methods on CreateOutboundConnectionRequest.Builder to create a
request. Container for the parameters to the CreateOutboundConnection operation.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceAlreadyExistsException - An exception for creating a resource that already exists.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
createPackageRequest - Container for request parameters to the CreatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.ResourceAlreadyExistsException - An exception for creating a resource that already exists.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via CreatePackageRequest.builder()
createPackageRequest - A Consumer that will call methods on CreatePackageRequest.Builder to create a request.
Container for request parameters to the CreatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.ResourceAlreadyExistsException - An exception for creating a resource that already exists.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest) throws ConflictException, ValidationException, LimitExceededException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException
Creates an Amazon OpenSearch Service-managed VPC endpoint.
createVpcEndpointRequest - ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.ValidationException - An exception for accessing or deleting a resource that doesn't exist.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via CreateVpcEndpointRequest.builder()
createVpcEndpointRequest - A Consumer that will call methods on CreateVpcEndpointRequest.Builder to create a request.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.ValidationException - An exception for accessing or deleting a resource that doesn't exist.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteDomainRequest - Container for the parameters to the DeleteDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DeleteDomainRequest.builder()
deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request.
Container for the parameters to the DeleteDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteInboundConnectionRequest - Container for the parameters to the DeleteInboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DeleteInboundConnectionRequest.builder()
deleteInboundConnectionRequest - A Consumer that will call methods on DeleteInboundConnectionRequest.Builder to create a
request. Container for the parameters to the DeleteInboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deleteOutboundConnectionRequest - Container for the parameters to the DeleteOutboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DeleteOutboundConnectionRequest.builder()
deleteOutboundConnectionRequest - A Consumer that will call methods on DeleteOutboundConnectionRequest.Builder to create a
request. Container for the parameters to the DeleteOutboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
deletePackageRequest - Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service
domain.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DeletePackageRequest.builder()
deletePackageRequest - A Consumer that will call methods on DeletePackageRequest.Builder to create a request.
Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service
domain.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteVpcEndpointResponse deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, BaseException, AwsServiceException, SdkClientException, OpenSearchException
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
deleteVpcEndpointRequest - ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DeleteVpcEndpointRequest.builder()
deleteVpcEndpointRequest - A Consumer that will call methods on DeleteVpcEndpointRequest.Builder to create a request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeDomainRequest - Container for the parameters to the DescribeDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via DescribeDomainRequest.builder()
describeDomainRequest - A Consumer that will call methods on DescribeDomainRequest.Builder to create a request.
Container for the parameters to the DescribeDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeDomainAutoTunesRequest.builder()
describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a
request. Container for the parameters to the DescribeDomainAutoTunes operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.DescribeDomainAutoTunesIterable responses = client.describeDomainAutoTunesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via DescribeDomainAutoTunesRequest.builder()
describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a
request. Container for the parameters to the DescribeDomainAutoTunes operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeDomainChangeProgressRequest.builder()
describeDomainChangeProgressRequest - A Consumer that will call methods on DescribeDomainChangeProgressRequest.Builder to create
a request. Container for the parameters to the DescribeDomainChangeProgress operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDomainConfigResponse describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException
Returns the configuration of an Amazon OpenSearch Service domain.
describeDomainConfigRequest - Container for the parameters to the DescribeDomainConfig operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeDomainConfigRequest.builder()
describeDomainConfigRequest - A Consumer that will call methods on DescribeDomainConfigRequest.Builder to create a
request. Container for the parameters to the DescribeDomainConfig operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeDomainHealthRequest - Container for the parameters to the DescribeDomainHealth operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeDomainHealthRequest.builder()
describeDomainHealthRequest - A Consumer that will call methods on DescribeDomainHealthRequest.Builder to create a
request. Container for the parameters to the DescribeDomainHealth operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeDomainNodesRequest - Container for the parameters to the DescribeDomainNodes operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch
details about the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeDomainNodesRequest.builder()
describeDomainNodesRequest - A Consumer that will call methods on DescribeDomainNodesRequest.Builder to create a
request. Container for the parameters to the DescribeDomainNodes operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.DependencyFailureException - An exception for when a failure in one of the dependencies results in the service being unable to fetch
details about the resource.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeDomainsResponse describeDomains(DescribeDomainsRequest describeDomainsRequest) throws BaseException, InternalException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
describeDomainsRequest - Container for the parameters to the DescribeDomains operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribeDomainsRequest.builder()
describeDomainsRequest - A Consumer that will call methods on DescribeDomainsRequest.Builder to create a request.
Container for the parameters to the DescribeDomains operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeDryRunProgressRequest - BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeDryRunProgressRequest.builder()
describeDryRunProgressRequest - A Consumer that will call methods on DescribeDryRunProgressRequest.Builder to create a
request.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeInboundConnectionsRequest.builder()
describeInboundConnectionsRequest - A Consumer that will call methods on DescribeInboundConnectionsRequest.Builder to create a
request. Container for the parameters to the DescribeInboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeInboundConnectionsIterable describeInboundConnectionsPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsIterable responses = client.describeInboundConnectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeInboundConnectionsIterable describeInboundConnectionsPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.DescribeInboundConnectionsIterable responses = client.describeInboundConnectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via DescribeInboundConnectionsRequest.builder()
describeInboundConnectionsRequest - A Consumer that will call methods on DescribeInboundConnectionsRequest.Builder to create a
request. Container for the parameters to the DescribeInboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeInstanceTypeLimitsRequest - Container for the parameters to the DescribeInstanceTypeLimits operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeInstanceTypeLimitsRequest.builder()
describeInstanceTypeLimitsRequest - A Consumer that will call methods on DescribeInstanceTypeLimitsRequest.Builder to create a
request. Container for the parameters to the DescribeInstanceTypeLimits operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeOutboundConnectionsRequest.builder()
describeOutboundConnectionsRequest - A Consumer that will call methods on DescribeOutboundConnectionsRequest.Builder to create
a request. Container for the parameters to the DescribeOutboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOutboundConnectionsIterable describeOutboundConnectionsPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client.describeOutboundConnectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeOutboundConnectionsIterable describeOutboundConnectionsPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.DescribeOutboundConnectionsIterable responses = client.describeOutboundConnectionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via DescribeOutboundConnectionsRequest.builder()
describeOutboundConnectionsRequest - A Consumer that will call methods on DescribeOutboundConnectionsRequest.Builder to create
a request. Container for the parameters to the DescribeOutboundConnections operation.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describePackagesRequest - Container for the request parameters to the DescribePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DescribePackagesRequest.builder()
describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request.
Container for the request parameters to the DescribePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePackagesIterable describePackagesPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describePackagesRequest - Container for the request parameters to the DescribePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribePackagesIterable describePackagesPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.DescribePackagesIterable responses = client.describePackagesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via DescribePackagesRequest.builder()
describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request.
Container for the request parameters to the DescribePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via DescribeReservedInstanceOfferingsRequest.builder()
describeReservedInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedInstanceOfferingsRequest.Builder to
create a request. Container for the request parameters to a DescribeReservedInstanceOfferings
operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedInstanceOfferingsIterable describeReservedInstanceOfferingsPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client.describeReservedInstanceOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedInstanceOfferingsIterable describeReservedInstanceOfferingsPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstanceOfferingsIterable responses = client.describeReservedInstanceOfferingsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder
avoiding the need to create one manually via DescribeReservedInstanceOfferingsRequest.builder()
describeReservedInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedInstanceOfferingsRequest.Builder to
create a request. Container for the request parameters to a DescribeReservedInstanceOfferings
operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via DescribeReservedInstancesRequest.builder()
describeReservedInstancesRequest - A Consumer that will call methods on DescribeReservedInstancesRequest.Builder to create a
request. Container for the request parameters to the DescribeReservedInstances operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedInstancesIterable describeReservedInstancesPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesIterable responses = client.describeReservedInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeReservedInstancesIterable describeReservedInstancesPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.DescribeReservedInstancesIterable responses = client.describeReservedInstancesPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via DescribeReservedInstancesRequest.builder()
describeReservedInstancesRequest - A Consumer that will call methods on DescribeReservedInstancesRequest.Builder to create a
request. Container for the request parameters to the DescribeReservedInstances operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DescribeVpcEndpointsResponse describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest) throws ValidationException, InternalException, DisabledOperationException, BaseException, AwsServiceException, SdkClientException, OpenSearchException
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
describeVpcEndpointsRequest - ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via DescribeVpcEndpointsRequest.builder()
describeVpcEndpointsRequest - A Consumer that will call methods on DescribeVpcEndpointsRequest.Builder to create a
request.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
dissociatePackageRequest - Container for the request parameters to the DissociatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via DissociatePackageRequest.builder()
dissociatePackageRequest - A Consumer that will call methods on DissociatePackageRequest.Builder to create a request.
Container for the request parameters to the DissociatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getCompatibleVersionsRequest - Container for the request parameters to GetCompatibleVersions operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via GetCompatibleVersionsRequest.builder()
getCompatibleVersionsRequest - A Consumer that will call methods on GetCompatibleVersionsRequest.Builder to create a
request. Container for the request parameters to GetCompatibleVersions operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via GetPackageVersionHistoryRequest.builder()
getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a
request. Container for the request parameters to the GetPackageVersionHistory operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.GetPackageVersionHistoryIterable responses = client.getPackageVersionHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via GetPackageVersionHistoryRequest.builder()
getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a
request. Container for the request parameters to the GetPackageVersionHistory operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getUpgradeHistoryRequest - Container for the request parameters to the GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via GetUpgradeHistoryRequest.builder()
getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request.
Container for the request parameters to the GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeHistoryIterable getUpgradeHistoryPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
getUpgradeHistoryRequest - Container for the request parameters to the GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetUpgradeHistoryIterable getUpgradeHistoryPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.GetUpgradeHistoryIterable responses = client.getUpgradeHistoryPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need
to create one manually via GetUpgradeHistoryRequest.builder()
getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request.
Container for the request parameters to the GetUpgradeHistory operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
getUpgradeStatusRequest - Container for the request parameters to the GetUpgradeStatus operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via GetUpgradeStatusRequest.builder()
getUpgradeStatusRequest - A Consumer that will call methods on GetUpgradeStatusRequest.Builder to create a request.
Container for the request parameters to the GetUpgradeStatus operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.BaseException - An error occurred while processing the request.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ListDomainNamesRequest.builder()
listDomainNamesRequest - A Consumer that will call methods on ListDomainNamesRequest.Builder to create a request.
Container for the parameters to the ListDomainNames operation.BaseException - An error occurred while processing the request.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListDomainsForPackageRequest.builder()
listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a
request. Container for the request parameters to the ListDomainsForPackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainsForPackageIterable listDomainsForPackagePaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListDomainsForPackageIterable listDomainsForPackagePaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.ListDomainsForPackageIterable responses = client.listDomainsForPackagePaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListDomainsForPackageRequest.builder()
listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a
request. Container for the request parameters to the ListDomainsForPackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listInstanceTypeDetailsRequest - BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via ListInstanceTypeDetailsRequest.builder()
listInstanceTypeDetailsRequest - A Consumer that will call methods on ListInstanceTypeDetailsRequest.Builder to create a
request.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstanceTypeDetailsIterable listInstanceTypeDetailsPaginator(ListInstanceTypeDetailsRequest 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 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
software.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client.listInstanceTypeDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listInstanceTypeDetailsRequest - BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListInstanceTypeDetailsIterable listInstanceTypeDetailsPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.ListInstanceTypeDetailsIterable responses = client.listInstanceTypeDetailsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding
the need to create one manually via ListInstanceTypeDetailsRequest.builder()
listInstanceTypeDetailsRequest - A Consumer that will call methods on ListInstanceTypeDetailsRequest.Builder to create a
request.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListPackagesForDomainRequest.builder()
listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a
request. Container for the request parameters to the ListPackagesForDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPackagesForDomainIterable listPackagesForDomainPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListPackagesForDomainIterable listPackagesForDomainPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.ListPackagesForDomainIterable responses = client.listPackagesForDomainPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListPackagesForDomainRequest.builder()
listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a
request. Container for the request parameters to the ListPackagesForDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listScheduledActionsRequest - BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListScheduledActionsRequest.builder()
listScheduledActionsRequest - A Consumer that will call methods on ListScheduledActionsRequest.Builder to create a
request.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListScheduledActionsIterable listScheduledActionsPaginator(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.
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
software.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsIterable responses = client.listScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listScheduledActionsRequest - BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListScheduledActionsIterable listScheduledActionsPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.ListScheduledActionsIterable responses = client.listScheduledActionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the
need to create one manually via ListScheduledActionsRequest.builder()
listScheduledActionsRequest - A Consumer that will call methods on ListScheduledActionsRequest.Builder to create a
request.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.InvalidPaginationTokenException - Request processing failed because you provided an invalid pagination token.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listTagsRequest - Container for the parameters to the ListTags operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListTagsRequest.builder()
listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request.
Container for the parameters to the ListTags operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVersionsResponse listVersions(ListVersionsRequest listVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
listVersionsRequest - Container for the request parameters to the ListVersions operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via ListVersionsRequest.builder()
listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request.
Container for the request parameters to the ListVersions operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVersionsIterable listVersionsPaginator(ListVersionsRequest listVersionsRequest) throws BaseException, InternalException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, OpenSearchException
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
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
software.amazon.awssdk.services.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.
listVersionsRequest - Container for the request parameters to the ListVersions operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListVersionsIterable listVersionsPaginator(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 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
software.amazon.awssdk.services.opensearch.paginators.ListVersionsIterable responses = client.listVersionsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@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 directly
software.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.Builder avoiding the need to
create one manually via ListVersionsRequest.builder()
listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request.
Container for the request parameters to the ListVersions operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listVpcEndpointAccessRequest - ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via ListVpcEndpointAccessRequest.builder()
listVpcEndpointAccessRequest - A Consumer that will call methods on ListVpcEndpointAccessRequest.Builder to create a
request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listVpcEndpointsRequest - InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via ListVpcEndpointsRequest.builder()
listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
listVpcEndpointsForDomainRequest - InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via ListVpcEndpointsForDomainRequest.builder()
listVpcEndpointsForDomainRequest - A Consumer that will call methods on ListVpcEndpointsForDomainRequest.Builder to create a
request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PurchaseReservedInstanceOfferingResponse purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest) throws ResourceNotFoundException, ResourceAlreadyExistsException, LimitExceededException, DisabledOperationException, ValidationException, InternalException, AwsServiceException, SdkClientException, OpenSearchException
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
purchaseReservedInstanceOfferingRequest - Container for request parameters to the PurchaseReservedInstanceOffering operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ResourceAlreadyExistsException - An exception for creating a resource that already exists.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder
avoiding the need to create one manually via PurchaseReservedInstanceOfferingRequest.builder()
purchaseReservedInstanceOfferingRequest - A Consumer that will call methods on PurchaseReservedInstanceOfferingRequest.Builder to
create a request. Container for request parameters to the PurchaseReservedInstanceOffering
operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ResourceAlreadyExistsException - An exception for creating a resource that already exists.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
rejectInboundConnectionRequest - Container for the request parameters to the RejectInboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via RejectInboundConnectionRequest.builder()
rejectInboundConnectionRequest - A Consumer that will call methods on RejectInboundConnectionRequest.Builder to create a
request. Container for the request parameters to the RejectInboundConnection operation.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
removeTagsRequest - Container for the request parameters to the RemoveTags operation.BaseException - An error occurred while processing the request.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via RemoveTagsRequest.builder()
removeTagsRequest - A Consumer that will call methods on RemoveTagsRequest.Builder to create a request.
Container for the request parameters to the RemoveTags operation.BaseException - An error occurred while processing the request.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
revokeVpcEndpointAccessRequest - ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via RevokeVpcEndpointAccessRequest.builder()
revokeVpcEndpointAccessRequest - A Consumer that will call methods on RevokeVpcEndpointAccessRequest.Builder to create a
request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
startServiceSoftwareUpdateRequest - Container for the request parameters to the StartServiceSoftwareUpdate operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding
the need to create one manually via StartServiceSoftwareUpdateRequest.builder()
startServiceSoftwareUpdateRequest - A Consumer that will call methods on StartServiceSoftwareUpdateRequest.Builder to create a
request. Container for the request parameters to the StartServiceSoftwareUpdate operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.sl
updateDomainConfigRequest - Container for the request parameters to the UpdateDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.sl
This is a convenience which creates an instance of the UpdateDomainConfigRequest.Builder avoiding the
need to create one manually via UpdateDomainConfigRequest.builder()
updateDomainConfigRequest - A Consumer that will call methods on UpdateDomainConfigRequest.Builder to create a
request. Container for the request parameters to the UpdateDomain operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.InvalidTypeException - An exception for trying to create or access a sub-resource that's either invalid or not supported.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updatePackageRequest - Container for request parameters to the UpdatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UpdatePackageRequest.builder()
updatePackageRequest - A Consumer that will call methods on UpdatePackageRequest.Builder to create a request.
Container for request parameters to the UpdatePackage operation.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.AccessDeniedException - An error occurred because you don't have permissions to access the resource.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
updateScheduledActionRequest - BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.SlotNotAvailableException - An exception for attempting to schedule a domain action during an unavailable time slot.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the
need to create one manually via UpdateScheduledActionRequest.builder()
updateScheduledActionRequest - A Consumer that will call methods on UpdateScheduledActionRequest.Builder to create a
request.BaseException - An error occurred while processing the request.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.SlotNotAvailableException - An exception for attempting to schedule a domain action during an unavailable time slot.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.LimitExceededException - An exception for trying to create more than the allowed number of resources or sub-resources.ValidationException - An exception for accessing or deleting a resource that doesn't exist.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault UpdateVpcEndpointResponse updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest) throws ResourceNotFoundException, DisabledOperationException, InternalException, ValidationException, ConflictException, BaseException, AwsServiceException, SdkClientException, OpenSearchException
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
updateVpcEndpointRequest - ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need
to create one manually via UpdateVpcEndpointRequest.builder()
updateVpcEndpointRequest - A Consumer that will call methods on UpdateVpcEndpointRequest.Builder to create a request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.InternalException - Request processing failed because of an unknown error, exception, or internal failure.ValidationException - An exception for accessing or deleting a resource that doesn't exist.ConflictException - An error occurred because the client attempts to remove a resource that is currently in use.BaseException - An error occurred while processing the request.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.
upgradeDomainRequest - Container for the request parameters to the UpgradeDomain operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ResourceAlreadyExistsException - An exception for creating a resource that already exists.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault 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.Builder avoiding the need to
create one manually via UpgradeDomainRequest.builder()
upgradeDomainRequest - A Consumer that will call methods on UpgradeDomainRequest.Builder to create a request.
Container for the request parameters to the UpgradeDomain operation.BaseException - An error occurred while processing the request.ResourceNotFoundException - An exception for accessing or deleting a resource that doesn't exist.ResourceAlreadyExistsException - An exception for creating a resource that already exists.DisabledOperationException - An error occured because the client wanted to access an unsupported operation.ValidationException - An exception for accessing or deleting a resource that doesn't exist.InternalException - Request processing failed because of an unknown error, exception, or internal failure.SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic OpenSearchClient create()
OpenSearchClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static OpenSearchClientBuilder builder()
OpenSearchClient.static ServiceMetadata serviceMetadata()
default OpenSearchServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.