OpenSearchClient (AWS Java SDK :: Services

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient
```
@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface OpenSearchClient
extends SdkClient
```
Service client for accessing Amazon OpenSearch Service. This can be created using the static 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.

Field Summary

Fields
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

Fields
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`

Method Summary

All Methods Static Methods Instance Methods Default Methods
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 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 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 and commit message.
`default GetPackageVersionHistoryResponse`	`getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)` Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message.
`default GetPackageVersionHistoryIterable`	`getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)` Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message.
`default GetPackageVersionHistoryIterable`	`getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)` Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message.
`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 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.
`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.
`default UpdateDomainConfigResponse`	`updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest)` Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
`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 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.

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

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

- Field Detail
  - SERVICE_NAME
```
static final String SERVICE_NAME
```
    See Also:
    
    Constant Field Values
  - SERVICE_METADATA_ID
```
static final String SERVICE_METADATA_ID
```
    Value for looking up the service's metadata from the ServiceMetadataProvider.
    
    See Also:
    
    Constant Field Values
- Method Detail
  - create
```
static OpenSearchClient create()
```
    Create a OpenSearchClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
  - builder
```
static OpenSearchClientBuilder builder()
```
    Create a builder that can be used to configure and create a OpenSearchClient.
  - acceptInboundConnection
```
default AcceptInboundConnectionResponse acceptInboundConnection(AcceptInboundConnectionRequest acceptInboundConnectionRequest)
                                                         throws ResourceNotFoundException,
                                                                LimitExceededException,
                                                                DisabledOperationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    Parameters:
    
    acceptInboundConnectionRequest - Container for the parameters to the AcceptInboundConnection operation.
    
    Returns:
    
    Result of the AcceptInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - acceptInboundConnection
```
default AcceptInboundConnectionResponse acceptInboundConnection(Consumer<AcceptInboundConnectionRequest.Builder> acceptInboundConnectionRequest)
                                                         throws ResourceNotFoundException,
                                                                LimitExceededException,
                                                                DisabledOperationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the AcceptInboundConnectionRequest.Builder avoiding the need to create one manually via AcceptInboundConnectionRequest.builder()
    
    Parameters:
    
    acceptInboundConnectionRequest - A Consumer that will call methods on AcceptInboundConnectionRequest.Builder to create a request. Container for the parameters to the AcceptInboundConnection operation.
    
    Returns:
    
    Result of the AcceptInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - addTags
```
default AddTagsResponse addTags(AddTagsRequest addTagsRequest)
                         throws BaseException,
                                LimitExceededException,
                                ValidationException,
                                InternalException,
                                AwsServiceException,
                                SdkClientException,
                                OpenSearchException
```
    Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. An domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
    
    Parameters:
    
    addTagsRequest - Container for the parameters to the AddTags operation. Specifies the tags to attach to the domain.
    
    Returns:
    
    Result of the AddTags operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - addTags
```
default AddTagsResponse addTags(Consumer<AddTagsRequest.Builder> addTagsRequest)
                         throws BaseException,
                                LimitExceededException,
                                ValidationException,
                                InternalException,
                                AwsServiceException,
                                SdkClientException,
                                OpenSearchException
```
    Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. An 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()
    
    Parameters:
    
    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.
    
    Returns:
    
    Result of the AddTags operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - associatePackage
```
default AssociatePackageResponse associatePackage(AssociatePackageRequest associatePackageRequest)
                                           throws BaseException,
                                                  InternalException,
                                                  ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  OpenSearchException
```
    Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    associatePackageRequest - Container for the request parameters to the AssociatePackage operation.
    
    Returns:
    
    Result of the AssociatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - associatePackage
```
default AssociatePackageResponse associatePackage(Consumer<AssociatePackageRequest.Builder> associatePackageRequest)
                                           throws BaseException,
                                                  InternalException,
                                                  ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  ConflictException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  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()
    
    Parameters:
    
    associatePackageRequest - A Consumer that will call methods on AssociatePackageRequest.Builder to create a request. Container for the request parameters to the AssociatePackage operation.
    
    Returns:
    
    Result of the AssociatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - authorizeVpcEndpointAccess
```
default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest authorizeVpcEndpointAccessRequest)
                                                               throws ResourceNotFoundException,
                                                                      DisabledOperationException,
                                                                      LimitExceededException,
                                                                      ValidationException,
                                                                      InternalException,
                                                                      BaseException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      OpenSearchException
```
    Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
    
    Parameters:
    
    authorizeVpcEndpointAccessRequest -
    
    Returns:
    
    Result of the AuthorizeVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - authorizeVpcEndpointAccess
```
default AuthorizeVpcEndpointAccessResponse authorizeVpcEndpointAccess(Consumer<AuthorizeVpcEndpointAccessRequest.Builder> authorizeVpcEndpointAccessRequest)
                                                               throws ResourceNotFoundException,
                                                                      DisabledOperationException,
                                                                      LimitExceededException,
                                                                      ValidationException,
                                                                      InternalException,
                                                                      BaseException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      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()
    
    Parameters:
    
    authorizeVpcEndpointAccessRequest - A Consumer that will call methods on AuthorizeVpcEndpointAccessRequest.Builder to create a request.
    
    Returns:
    
    Result of the AuthorizeVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - cancelServiceSoftwareUpdate
```
default CancelServiceSoftwareUpdateResponse cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest cancelServiceSoftwareUpdateRequest)
                                                                 throws BaseException,
                                                                        InternalException,
                                                                        ResourceNotFoundException,
                                                                        ValidationException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        OpenSearchException
```
    Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.
    
    Parameters:
    
    cancelServiceSoftwareUpdateRequest - Container for the request parameters to cancel a service software update.
    
    Returns:
    
    Result of the CancelServiceSoftwareUpdate operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - cancelServiceSoftwareUpdate
```
default CancelServiceSoftwareUpdateResponse cancelServiceSoftwareUpdate(Consumer<CancelServiceSoftwareUpdateRequest.Builder> cancelServiceSoftwareUpdateRequest)
                                                                 throws BaseException,
                                                                        InternalException,
                                                                        ResourceNotFoundException,
                                                                        ValidationException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        OpenSearchException
```
    Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the 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()
    
    Parameters:
    
    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.
    
    Returns:
    
    Result of the CancelServiceSoftwareUpdate operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createDomain
```
default CreateDomainResponse createDomain(CreateDomainRequest createDomainRequest)
                                   throws BaseException,
                                          DisabledOperationException,
                                          InternalException,
                                          InvalidTypeException,
                                          LimitExceededException,
                                          ResourceAlreadyExistsException,
                                          ValidationException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OpenSearchException
```
    Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
    
    Parameters:
    
    createDomainRequest -
    
    Returns:
    
    Result of the CreateDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createDomain
```
default CreateDomainResponse createDomain(Consumer<CreateDomainRequest.Builder> createDomainRequest)
                                   throws BaseException,
                                          DisabledOperationException,
                                          InternalException,
                                          InvalidTypeException,
                                          LimitExceededException,
                                          ResourceAlreadyExistsException,
                                          ValidationException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OpenSearchException
```
    Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
    
    This is a convenience which creates an instance of the CreateDomainRequest.Builder avoiding the need to create one manually via CreateDomainRequest.builder()
    
    Parameters:
    
    createDomainRequest - A Consumer that will call methods on CreateDomainRequest.Builder to create a request.
    
    Returns:
    
    Result of the CreateDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createOutboundConnection
```
default CreateOutboundConnectionResponse createOutboundConnection(CreateOutboundConnectionRequest createOutboundConnectionRequest)
                                                           throws LimitExceededException,
                                                                  InternalException,
                                                                  ResourceAlreadyExistsException,
                                                                  DisabledOperationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  OpenSearchException
```
    Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    Parameters:
    
    createOutboundConnectionRequest - Container for the parameters to the CreateOutboundConnection operation.
    
    Returns:
    
    Result of the CreateOutboundConnection operation returned by the service.
    
    Throws:
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createOutboundConnection
```
default CreateOutboundConnectionResponse createOutboundConnection(Consumer<CreateOutboundConnectionRequest.Builder> createOutboundConnectionRequest)
                                                           throws LimitExceededException,
                                                                  InternalException,
                                                                  ResourceAlreadyExistsException,
                                                                  DisabledOperationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  OpenSearchException
```
    Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the CreateOutboundConnectionRequest.Builder avoiding the need to create one manually via CreateOutboundConnectionRequest.builder()
    
    Parameters:
    
    createOutboundConnectionRequest - A Consumer that will call methods on CreateOutboundConnectionRequest.Builder to create a request. Container for the parameters to the CreateOutboundConnection operation.
    
    Returns:
    
    Result of the CreateOutboundConnection operation returned by the service.
    
    Throws:
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createPackage
```
default CreatePackageResponse createPackage(CreatePackageRequest createPackageRequest)
                                     throws BaseException,
                                            InternalException,
                                            LimitExceededException,
                                            InvalidTypeException,
                                            ResourceAlreadyExistsException,
                                            AccessDeniedException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OpenSearchException
```
    Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    createPackageRequest - Container for request parameters to the CreatePackage operation.
    
    Returns:
    
    Result of the CreatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createPackage
```
default CreatePackageResponse createPackage(Consumer<CreatePackageRequest.Builder> createPackageRequest)
                                     throws BaseException,
                                            InternalException,
                                            LimitExceededException,
                                            InvalidTypeException,
                                            ResourceAlreadyExistsException,
                                            AccessDeniedException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            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()
    
    Parameters:
    
    createPackageRequest - A Consumer that will call methods on CreatePackageRequest.Builder to create a request. Container for request parameters to the CreatePackage operation.
    
    Returns:
    
    Result of the CreatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createVpcEndpoint
```
default CreateVpcEndpointResponse createVpcEndpoint(CreateVpcEndpointRequest createVpcEndpointRequest)
                                             throws ConflictException,
                                                    ValidationException,
                                                    LimitExceededException,
                                                    InternalException,
                                                    DisabledOperationException,
                                                    BaseException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    OpenSearchException
```
    Creates an Amazon OpenSearch Service-managed VPC endpoint.
    
    Parameters:
    
    createVpcEndpointRequest -
    
    Returns:
    
    Result of the CreateVpcEndpoint operation returned by the service.
    
    Throws:
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - createVpcEndpoint
```
default CreateVpcEndpointResponse createVpcEndpoint(Consumer<CreateVpcEndpointRequest.Builder> createVpcEndpointRequest)
                                             throws ConflictException,
                                                    ValidationException,
                                                    LimitExceededException,
                                                    InternalException,
                                                    DisabledOperationException,
                                                    BaseException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    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()
    
    Parameters:
    
    createVpcEndpointRequest - A Consumer that will call methods on CreateVpcEndpointRequest.Builder to create a request.
    
    Returns:
    
    Result of the CreateVpcEndpoint operation returned by the service.
    
    Throws:
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteDomain
```
default DeleteDomainResponse deleteDomain(DeleteDomainRequest deleteDomainRequest)
                                   throws BaseException,
                                          InternalException,
                                          ResourceNotFoundException,
                                          ValidationException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OpenSearchException
```
    Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
    
    Parameters:
    
    deleteDomainRequest - Container for the parameters to the DeleteDomain operation.
    
    Returns:
    
    Result of the DeleteDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteDomain
```
default DeleteDomainResponse deleteDomain(Consumer<DeleteDomainRequest.Builder> deleteDomainRequest)
                                   throws BaseException,
                                          InternalException,
                                          ResourceNotFoundException,
                                          ValidationException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OpenSearchException
```
    Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
    
    This is a convenience which creates an instance of the DeleteDomainRequest.Builder avoiding the need to create one manually via DeleteDomainRequest.builder()
    
    Parameters:
    
    deleteDomainRequest - A Consumer that will call methods on DeleteDomainRequest.Builder to create a request. Container for the parameters to the DeleteDomain operation.
    
    Returns:
    
    Result of the DeleteDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteInboundConnection
```
default DeleteInboundConnectionResponse deleteInboundConnection(DeleteInboundConnectionRequest deleteInboundConnectionRequest)
                                                         throws ResourceNotFoundException,
                                                                DisabledOperationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    Parameters:
    
    deleteInboundConnectionRequest - Container for the parameters to the DeleteInboundConnection operation.
    
    Returns:
    
    Result of the DeleteInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteInboundConnection
```
default DeleteInboundConnectionResponse deleteInboundConnection(Consumer<DeleteInboundConnectionRequest.Builder> deleteInboundConnectionRequest)
                                                         throws ResourceNotFoundException,
                                                                DisabledOperationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the DeleteInboundConnectionRequest.Builder avoiding the need to create one manually via DeleteInboundConnectionRequest.builder()
    
    Parameters:
    
    deleteInboundConnectionRequest - A Consumer that will call methods on DeleteInboundConnectionRequest.Builder to create a request. Container for the parameters to the DeleteInboundConnection operation.
    
    Returns:
    
    Result of the DeleteInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteOutboundConnection
```
default DeleteOutboundConnectionResponse deleteOutboundConnection(DeleteOutboundConnectionRequest deleteOutboundConnectionRequest)
                                                           throws ResourceNotFoundException,
                                                                  DisabledOperationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  OpenSearchException
```
    Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    Parameters:
    
    deleteOutboundConnectionRequest - Container for the parameters to the DeleteOutboundConnection operation.
    
    Returns:
    
    Result of the DeleteOutboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteOutboundConnection
```
default DeleteOutboundConnectionResponse deleteOutboundConnection(Consumer<DeleteOutboundConnectionRequest.Builder> deleteOutboundConnectionRequest)
                                                           throws ResourceNotFoundException,
                                                                  DisabledOperationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  OpenSearchException
```
    Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the DeleteOutboundConnectionRequest.Builder avoiding the need to create one manually via DeleteOutboundConnectionRequest.builder()
    
    Parameters:
    
    deleteOutboundConnectionRequest - A Consumer that will call methods on DeleteOutboundConnectionRequest.Builder to create a request. Container for the parameters to the DeleteOutboundConnection operation.
    
    Returns:
    
    Result of the DeleteOutboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deletePackage
```
default DeletePackageResponse deletePackage(DeletePackageRequest deletePackageRequest)
                                     throws BaseException,
                                            InternalException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OpenSearchException
```
    Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    deletePackageRequest - Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.
    
    Returns:
    
    Result of the DeletePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deletePackage
```
default DeletePackageResponse deletePackage(Consumer<DeletePackageRequest.Builder> deletePackageRequest)
                                     throws BaseException,
                                            InternalException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            ConflictException,
                                            AwsServiceException,
                                            SdkClientException,
                                            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()
    
    Parameters:
    
    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.
    
    Returns:
    
    Result of the DeletePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteVpcEndpoint
```
default DeleteVpcEndpointResponse deleteVpcEndpoint(DeleteVpcEndpointRequest deleteVpcEndpointRequest)
                                             throws ResourceNotFoundException,
                                                    DisabledOperationException,
                                                    InternalException,
                                                    BaseException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    OpenSearchException
```
    Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Parameters:
    
    deleteVpcEndpointRequest -
    
    Returns:
    
    Result of the DeleteVpcEndpoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - deleteVpcEndpoint
```
default DeleteVpcEndpointResponse deleteVpcEndpoint(Consumer<DeleteVpcEndpointRequest.Builder> deleteVpcEndpointRequest)
                                             throws ResourceNotFoundException,
                                                    DisabledOperationException,
                                                    InternalException,
                                                    BaseException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    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()
    
    Parameters:
    
    deleteVpcEndpointRequest - A Consumer that will call methods on DeleteVpcEndpointRequest.Builder to create a request.
    
    Returns:
    
    Result of the DeleteVpcEndpoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomain
```
default DescribeDomainResponse describeDomain(DescribeDomainRequest describeDomainRequest)
                                       throws BaseException,
                                              InternalException,
                                              ResourceNotFoundException,
                                              ValidationException,
                                              AwsServiceException,
                                              SdkClientException,
                                              OpenSearchException
```
    Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
    
    Parameters:
    
    describeDomainRequest - Container for the parameters to the DescribeDomain operation.
    
    Returns:
    
    Result of the DescribeDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomain
```
default DescribeDomainResponse describeDomain(Consumer<DescribeDomainRequest.Builder> describeDomainRequest)
                                       throws BaseException,
                                              InternalException,
                                              ResourceNotFoundException,
                                              ValidationException,
                                              AwsServiceException,
                                              SdkClientException,
                                              OpenSearchException
```
    Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
    
    This is a convenience which creates an instance of the DescribeDomainRequest.Builder avoiding the need to create one manually via DescribeDomainRequest.builder()
    
    Parameters:
    
    describeDomainRequest - A Consumer that will call methods on DescribeDomainRequest.Builder to create a request. Container for the parameters to the DescribeDomain operation.
    
    Returns:
    
    Result of the DescribeDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainAutoTunes
```
default DescribeDomainAutoTunesResponse describeDomainAutoTunes(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)
                                                         throws BaseException,
                                                                InternalException,
                                                                ResourceNotFoundException,
                                                                ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
    
    Parameters:
    
    describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.
    
    Returns:
    
    Result of the DescribeDomainAutoTunes operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainAutoTunes
```
default DescribeDomainAutoTunesResponse describeDomainAutoTunes(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)
                                                         throws BaseException,
                                                                InternalException,
                                                                ResourceNotFoundException,
                                                                ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                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()
    
    Parameters:
    
    describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a request. Container for the parameters to the DescribeDomainAutoTunes operation.
    
    Returns:
    
    Result of the DescribeDomainAutoTunes operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainAutoTunesPaginator
```
default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(DescribeDomainAutoTunesRequest describeDomainAutoTunesRequest)
                                                                  throws BaseException,
                                                                         InternalException,
                                                                         ResourceNotFoundException,
                                                                         ValidationException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         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.
    Parameters:
    
    describeDomainAutoTunesRequest - Container for the parameters to the DescribeDomainAutoTunes operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainAutoTunesPaginator
```
default DescribeDomainAutoTunesIterable describeDomainAutoTunesPaginator(Consumer<DescribeDomainAutoTunesRequest.Builder> describeDomainAutoTunesRequest)
                                                                  throws BaseException,
                                                                         InternalException,
                                                                         ResourceNotFoundException,
                                                                         ValidationException,
                                                                         AwsServiceException,
                                                                         SdkClientException,
                                                                         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()
    Parameters:
    
    describeDomainAutoTunesRequest - A Consumer that will call methods on DescribeDomainAutoTunesRequest.Builder to create a request. Container for the parameters to the DescribeDomainAutoTunes operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainChangeProgress
```
default DescribeDomainChangeProgressResponse describeDomainChangeProgress(DescribeDomainChangeProgressRequest describeDomainChangeProgressRequest)
                                                                   throws BaseException,
                                                                          InternalException,
                                                                          ResourceNotFoundException,
                                                                          ValidationException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          OpenSearchException
```
    Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
    
    Parameters:
    
    describeDomainChangeProgressRequest - Container for the parameters to the DescribeDomainChangeProgress operation.
    
    Returns:
    
    Result of the DescribeDomainChangeProgress operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainChangeProgress
```
default DescribeDomainChangeProgressResponse describeDomainChangeProgress(Consumer<DescribeDomainChangeProgressRequest.Builder> describeDomainChangeProgressRequest)
                                                                   throws BaseException,
                                                                          InternalException,
                                                                          ResourceNotFoundException,
                                                                          ValidationException,
                                                                          AwsServiceException,
                                                                          SdkClientException,
                                                                          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()
    
    Parameters:
    
    describeDomainChangeProgressRequest - A Consumer that will call methods on DescribeDomainChangeProgressRequest.Builder to create a request. Container for the parameters to the DescribeDomainChangeProgress operation.
    
    Returns:
    
    Result of the DescribeDomainChangeProgress operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainConfig
```
default DescribeDomainConfigResponse describeDomainConfig(DescribeDomainConfigRequest describeDomainConfigRequest)
                                                   throws BaseException,
                                                          InternalException,
                                                          ResourceNotFoundException,
                                                          ValidationException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          OpenSearchException
```
    Returns the configuration of an Amazon OpenSearch Service domain.
    
    Parameters:
    
    describeDomainConfigRequest - Container for the parameters to the DescribeDomainConfig operation.
    
    Returns:
    
    Result of the DescribeDomainConfig operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomainConfig
```
default DescribeDomainConfigResponse describeDomainConfig(Consumer<DescribeDomainConfigRequest.Builder> describeDomainConfigRequest)
                                                   throws BaseException,
                                                          InternalException,
                                                          ResourceNotFoundException,
                                                          ValidationException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          OpenSearchException
```
    Returns the configuration of an Amazon OpenSearch Service domain.
    
    This is a convenience which creates an instance of the DescribeDomainConfigRequest.Builder avoiding the need to create one manually via DescribeDomainConfigRequest.builder()
    
    Parameters:
    
    describeDomainConfigRequest - A Consumer that will call methods on DescribeDomainConfigRequest.Builder to create a request. Container for the parameters to the DescribeDomainConfig operation.
    
    Returns:
    
    Result of the DescribeDomainConfig operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomains
```
default DescribeDomainsResponse describeDomains(DescribeDomainsRequest describeDomainsRequest)
                                         throws BaseException,
                                                InternalException,
                                                ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                OpenSearchException
```
    Returns domain configuration information about the specified Amazon OpenSearch Service domains.
    
    Parameters:
    
    describeDomainsRequest - Container for the parameters to the DescribeDomains operation.
    
    Returns:
    
    Result of the DescribeDomains operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeDomains
```
default DescribeDomainsResponse describeDomains(Consumer<DescribeDomainsRequest.Builder> describeDomainsRequest)
                                         throws BaseException,
                                                InternalException,
                                                ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                OpenSearchException
```
    Returns domain configuration information about the specified Amazon OpenSearch Service domains.
    
    This is a convenience which creates an instance of the DescribeDomainsRequest.Builder avoiding the need to create one manually via DescribeDomainsRequest.builder()
    
    Parameters:
    
    describeDomainsRequest - A Consumer that will call methods on DescribeDomainsRequest.Builder to create a request. Container for the parameters to the DescribeDomains operation.
    
    Returns:
    
    Result of the DescribeDomains operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeInboundConnections
```
default DescribeInboundConnectionsResponse describeInboundConnections(DescribeInboundConnectionsRequest describeInboundConnectionsRequest)
                                                               throws InvalidPaginationTokenException,
                                                                      DisabledOperationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      OpenSearchException
```
    Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    Parameters:
    
    describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.
    
    Returns:
    
    Result of the DescribeInboundConnections operation returned by the service.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeInboundConnections
```
default DescribeInboundConnectionsResponse describeInboundConnections(Consumer<DescribeInboundConnectionsRequest.Builder> describeInboundConnectionsRequest)
                                                               throws InvalidPaginationTokenException,
                                                                      DisabledOperationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      OpenSearchException
```
    Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the DescribeInboundConnectionsRequest.Builder avoiding the need to create one manually via DescribeInboundConnectionsRequest.builder()
    
    Parameters:
    
    describeInboundConnectionsRequest - A Consumer that will call methods on DescribeInboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeInboundConnections operation.
    
    Returns:
    
    Result of the DescribeInboundConnections operation returned by the service.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeInboundConnectionsPaginator
```
default 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.
    Parameters:
    
    describeInboundConnectionsRequest - Container for the parameters to the DescribeInboundConnections operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeInboundConnectionsPaginator
```
default 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()
    Parameters:
    
    describeInboundConnectionsRequest - A Consumer that will call methods on DescribeInboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeInboundConnections operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeInstanceTypeLimits
```
default DescribeInstanceTypeLimitsResponse describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest describeInstanceTypeLimitsRequest)
                                                               throws BaseException,
                                                                      InternalException,
                                                                      InvalidTypeException,
                                                                      LimitExceededException,
                                                                      ResourceNotFoundException,
                                                                      ValidationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      OpenSearchException
```
    Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
    
    Parameters:
    
    describeInstanceTypeLimitsRequest - Container for the parameters to the DescribeInstanceTypeLimits operation.
    
    Returns:
    
    Result of the DescribeInstanceTypeLimits operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeInstanceTypeLimits
```
default DescribeInstanceTypeLimitsResponse describeInstanceTypeLimits(Consumer<DescribeInstanceTypeLimitsRequest.Builder> describeInstanceTypeLimitsRequest)
                                                               throws BaseException,
                                                                      InternalException,
                                                                      InvalidTypeException,
                                                                      LimitExceededException,
                                                                      ResourceNotFoundException,
                                                                      ValidationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      OpenSearchException
```
    Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
    
    This is a convenience which creates an instance of the DescribeInstanceTypeLimitsRequest.Builder avoiding the need to create one manually via DescribeInstanceTypeLimitsRequest.builder()
    
    Parameters:
    
    describeInstanceTypeLimitsRequest - A Consumer that will call methods on DescribeInstanceTypeLimitsRequest.Builder to create a request. Container for the parameters to the DescribeInstanceTypeLimits operation.
    
    Returns:
    
    Result of the DescribeInstanceTypeLimits operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeOutboundConnections
```
default DescribeOutboundConnectionsResponse describeOutboundConnections(DescribeOutboundConnectionsRequest describeOutboundConnectionsRequest)
                                                                 throws InvalidPaginationTokenException,
                                                                        DisabledOperationException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        OpenSearchException
```
    Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    Parameters:
    
    describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.
    
    Returns:
    
    Result of the DescribeOutboundConnections operation returned by the service.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeOutboundConnections
```
default DescribeOutboundConnectionsResponse describeOutboundConnections(Consumer<DescribeOutboundConnectionsRequest.Builder> describeOutboundConnectionsRequest)
                                                                 throws InvalidPaginationTokenException,
                                                                        DisabledOperationException,
                                                                        AwsServiceException,
                                                                        SdkClientException,
                                                                        OpenSearchException
```
    Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the DescribeOutboundConnectionsRequest.Builder avoiding the need to create one manually via DescribeOutboundConnectionsRequest.builder()
    
    Parameters:
    
    describeOutboundConnectionsRequest - A Consumer that will call methods on DescribeOutboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeOutboundConnections operation.
    
    Returns:
    
    Result of the DescribeOutboundConnections operation returned by the service.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeOutboundConnectionsPaginator
```
default 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.
    Parameters:
    
    describeOutboundConnectionsRequest - Container for the parameters to the DescribeOutboundConnections operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeOutboundConnectionsPaginator
```
default 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()
    Parameters:
    
    describeOutboundConnectionsRequest - A Consumer that will call methods on DescribeOutboundConnectionsRequest.Builder to create a request. Container for the parameters to the DescribeOutboundConnections operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    InvalidPaginationTokenException - The request processing has failed because of invalid pagination token provided by customer. Returns an HTTP status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describePackages
```
default DescribePackagesResponse describePackages(DescribePackagesRequest describePackagesRequest)
                                           throws BaseException,
                                                  InternalException,
                                                  ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  OpenSearchException
```
    Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    describePackagesRequest - Container for the request parameters to the DescribePackage operation.
    
    Returns:
    
    Result of the DescribePackages operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describePackages
```
default DescribePackagesResponse describePackages(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)
                                           throws BaseException,
                                                  InternalException,
                                                  ResourceNotFoundException,
                                                  AccessDeniedException,
                                                  ValidationException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  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()
    
    Parameters:
    
    describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request. Container for the request parameters to the DescribePackage operation.
    
    Returns:
    
    Result of the DescribePackages operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describePackagesPaginator
```
default DescribePackagesIterable describePackagesPaginator(DescribePackagesRequest describePackagesRequest)
                                                    throws BaseException,
                                                           InternalException,
                                                           ResourceNotFoundException,
                                                           AccessDeniedException,
                                                           ValidationException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           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.
    Parameters:
    
    describePackagesRequest - Container for the request parameters to the DescribePackage operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describePackagesPaginator
```
default DescribePackagesIterable describePackagesPaginator(Consumer<DescribePackagesRequest.Builder> describePackagesRequest)
                                                    throws BaseException,
                                                           InternalException,
                                                           ResourceNotFoundException,
                                                           AccessDeniedException,
                                                           ValidationException,
                                                           AwsServiceException,
                                                           SdkClientException,
                                                           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()
    Parameters:
    
    describePackagesRequest - A Consumer that will call methods on DescribePackagesRequest.Builder to create a request. Container for the request parameters to the DescribePackage operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstanceOfferings
```
default DescribeReservedInstanceOfferingsResponse describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest describeReservedInstanceOfferingsRequest)
                                                                             throws ResourceNotFoundException,
                                                                                    ValidationException,
                                                                                    DisabledOperationException,
                                                                                    InternalException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    OpenSearchException
```
    Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
    
    Parameters:
    
    describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.
    
    Returns:
    
    Result of the DescribeReservedInstanceOfferings operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstanceOfferings
```
default DescribeReservedInstanceOfferingsResponse describeReservedInstanceOfferings(Consumer<DescribeReservedInstanceOfferingsRequest.Builder> describeReservedInstanceOfferingsRequest)
                                                                             throws ResourceNotFoundException,
                                                                                    ValidationException,
                                                                                    DisabledOperationException,
                                                                                    InternalException,
                                                                                    AwsServiceException,
                                                                                    SdkClientException,
                                                                                    OpenSearchException
```
    Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the DescribeReservedInstanceOfferingsRequest.Builder avoiding the need to create one manually via DescribeReservedInstanceOfferingsRequest.builder()
    
    Parameters:
    
    describeReservedInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedInstanceOfferingsRequest.Builder to create a request. Container for the request parameters to a DescribeReservedInstanceOfferings operation.
    
    Returns:
    
    Result of the DescribeReservedInstanceOfferings operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstanceOfferingsPaginator
```
default 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.
    Parameters:
    
    describeReservedInstanceOfferingsRequest - Container for the request parameters to a DescribeReservedInstanceOfferings operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstanceOfferingsPaginator
```
default 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()
    Parameters:
    
    describeReservedInstanceOfferingsRequest - A Consumer that will call methods on DescribeReservedInstanceOfferingsRequest.Builder to create a request. Container for the request parameters to a DescribeReservedInstanceOfferings operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstances
```
default DescribeReservedInstancesResponse describeReservedInstances(DescribeReservedInstancesRequest describeReservedInstancesRequest)
                                                             throws ResourceNotFoundException,
                                                                    InternalException,
                                                                    ValidationException,
                                                                    DisabledOperationException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    OpenSearchException
```
    Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
    
    Parameters:
    
    describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.
    
    Returns:
    
    Result of the DescribeReservedInstances operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstances
```
default DescribeReservedInstancesResponse describeReservedInstances(Consumer<DescribeReservedInstancesRequest.Builder> describeReservedInstancesRequest)
                                                             throws ResourceNotFoundException,
                                                                    InternalException,
                                                                    ValidationException,
                                                                    DisabledOperationException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    OpenSearchException
```
    Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the DescribeReservedInstancesRequest.Builder avoiding the need to create one manually via DescribeReservedInstancesRequest.builder()
    
    Parameters:
    
    describeReservedInstancesRequest - A Consumer that will call methods on DescribeReservedInstancesRequest.Builder to create a request. Container for the request parameters to the DescribeReservedInstances operation.
    
    Returns:
    
    Result of the DescribeReservedInstances operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstancesPaginator
```
default 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.
    Parameters:
    
    describeReservedInstancesRequest - Container for the request parameters to the DescribeReservedInstances operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeReservedInstancesPaginator
```
default 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()
    Parameters:
    
    describeReservedInstancesRequest - A Consumer that will call methods on DescribeReservedInstancesRequest.Builder to create a request. Container for the request parameters to the DescribeReservedInstances operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeVpcEndpoints
```
default DescribeVpcEndpointsResponse describeVpcEndpoints(DescribeVpcEndpointsRequest describeVpcEndpointsRequest)
                                                   throws ValidationException,
                                                          InternalException,
                                                          DisabledOperationException,
                                                          BaseException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          OpenSearchException
```
    Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
    
    Parameters:
    
    describeVpcEndpointsRequest -
    
    Returns:
    
    Result of the DescribeVpcEndpoints operation returned by the service.
    
    Throws:
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - describeVpcEndpoints
```
default DescribeVpcEndpointsResponse describeVpcEndpoints(Consumer<DescribeVpcEndpointsRequest.Builder> describeVpcEndpointsRequest)
                                                   throws ValidationException,
                                                          InternalException,
                                                          DisabledOperationException,
                                                          BaseException,
                                                          AwsServiceException,
                                                          SdkClientException,
                                                          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()
    
    Parameters:
    
    describeVpcEndpointsRequest - A Consumer that will call methods on DescribeVpcEndpointsRequest.Builder to create a request.
    
    Returns:
    
    Result of the DescribeVpcEndpoints operation returned by the service.
    
    Throws:
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - dissociatePackage
```
default DissociatePackageResponse dissociatePackage(DissociatePackageRequest dissociatePackageRequest)
                                             throws BaseException,
                                                    InternalException,
                                                    ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    ConflictException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    OpenSearchException
```
    Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    dissociatePackageRequest - Container for the request parameters to the DissociatePackage operation.
    
    Returns:
    
    Result of the DissociatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - dissociatePackage
```
default DissociatePackageResponse dissociatePackage(Consumer<DissociatePackageRequest.Builder> dissociatePackageRequest)
                                             throws BaseException,
                                                    InternalException,
                                                    ResourceNotFoundException,
                                                    AccessDeniedException,
                                                    ValidationException,
                                                    ConflictException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    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()
    
    Parameters:
    
    dissociatePackageRequest - A Consumer that will call methods on DissociatePackageRequest.Builder to create a request. Container for the request parameters to the DissociatePackage operation.
    
    Returns:
    
    Result of the DissociatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getCompatibleVersions
```
default GetCompatibleVersionsResponse getCompatibleVersions(GetCompatibleVersionsRequest getCompatibleVersionsRequest)
                                                     throws BaseException,
                                                            ResourceNotFoundException,
                                                            DisabledOperationException,
                                                            ValidationException,
                                                            InternalException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            OpenSearchException
```
    Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
    
    Parameters:
    
    getCompatibleVersionsRequest - Container for the request parameters to GetCompatibleVersions operation.
    
    Returns:
    
    Result of the GetCompatibleVersions operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getCompatibleVersions
```
default GetCompatibleVersionsResponse getCompatibleVersions(Consumer<GetCompatibleVersionsRequest.Builder> getCompatibleVersionsRequest)
                                                     throws BaseException,
                                                            ResourceNotFoundException,
                                                            DisabledOperationException,
                                                            ValidationException,
                                                            InternalException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            OpenSearchException
```
    Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
    
    This is a convenience which creates an instance of the GetCompatibleVersionsRequest.Builder avoiding the need to create one manually via GetCompatibleVersionsRequest.builder()
    
    Parameters:
    
    getCompatibleVersionsRequest - A Consumer that will call methods on GetCompatibleVersionsRequest.Builder to create a request. Container for the request parameters to GetCompatibleVersions operation.
    
    Returns:
    
    Result of the GetCompatibleVersions operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getPackageVersionHistory
```
default GetPackageVersionHistoryResponse getPackageVersionHistory(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)
                                                           throws BaseException,
                                                                  InternalException,
                                                                  ResourceNotFoundException,
                                                                  AccessDeniedException,
                                                                  ValidationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  OpenSearchException
```
    Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.
    
    Returns:
    
    Result of the GetPackageVersionHistory operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getPackageVersionHistory
```
default GetPackageVersionHistoryResponse getPackageVersionHistory(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)
                                                           throws BaseException,
                                                                  InternalException,
                                                                  ResourceNotFoundException,
                                                                  AccessDeniedException,
                                                                  ValidationException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  OpenSearchException
```
    Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. 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()
    
    Parameters:
    
    getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a request. Container for the request parameters to the GetPackageVersionHistory operation.
    
    Returns:
    
    Result of the GetPackageVersionHistory operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getPackageVersionHistoryPaginator
```
default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(GetPackageVersionHistoryRequest getPackageVersionHistoryRequest)
                                                                    throws BaseException,
                                                                           InternalException,
                                                                           ResourceNotFoundException,
                                                                           AccessDeniedException,
                                                                           ValidationException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           OpenSearchException
```
    Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. 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.
    Parameters:
    
    getPackageVersionHistoryRequest - Container for the request parameters to the GetPackageVersionHistory operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getPackageVersionHistoryPaginator
```
default GetPackageVersionHistoryIterable getPackageVersionHistoryPaginator(Consumer<GetPackageVersionHistoryRequest.Builder> getPackageVersionHistoryRequest)
                                                                    throws BaseException,
                                                                           InternalException,
                                                                           ResourceNotFoundException,
                                                                           AccessDeniedException,
                                                                           ValidationException,
                                                                           AwsServiceException,
                                                                           SdkClientException,
                                                                           OpenSearchException
```
    Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. 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()
    Parameters:
    
    getPackageVersionHistoryRequest - A Consumer that will call methods on GetPackageVersionHistoryRequest.Builder to create a request. Container for the request parameters to the GetPackageVersionHistory operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getUpgradeHistory
```
default GetUpgradeHistoryResponse getUpgradeHistory(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
                                             throws BaseException,
                                                    ResourceNotFoundException,
                                                    DisabledOperationException,
                                                    ValidationException,
                                                    InternalException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    OpenSearchException
```
    Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
    
    Parameters:
    
    getUpgradeHistoryRequest - Container for the request parameters to the GetUpgradeHistory operation.
    
    Returns:
    
    Result of the GetUpgradeHistory operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getUpgradeHistory
```
default GetUpgradeHistoryResponse getUpgradeHistory(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
                                             throws BaseException,
                                                    ResourceNotFoundException,
                                                    DisabledOperationException,
                                                    ValidationException,
                                                    InternalException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    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()
    
    Parameters:
    
    getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request. Container for the request parameters to the GetUpgradeHistory operation.
    
    Returns:
    
    Result of the GetUpgradeHistory operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getUpgradeHistoryPaginator
```
default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(GetUpgradeHistoryRequest getUpgradeHistoryRequest)
                                                      throws BaseException,
                                                             ResourceNotFoundException,
                                                             DisabledOperationException,
                                                             ValidationException,
                                                             InternalException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             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.
    Parameters:
    
    getUpgradeHistoryRequest - Container for the request parameters to the GetUpgradeHistory operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getUpgradeHistoryPaginator
```
default GetUpgradeHistoryIterable getUpgradeHistoryPaginator(Consumer<GetUpgradeHistoryRequest.Builder> getUpgradeHistoryRequest)
                                                      throws BaseException,
                                                             ResourceNotFoundException,
                                                             DisabledOperationException,
                                                             ValidationException,
                                                             InternalException,
                                                             AwsServiceException,
                                                             SdkClientException,
                                                             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()
    Parameters:
    
    getUpgradeHistoryRequest - A Consumer that will call methods on GetUpgradeHistoryRequest.Builder to create a request. Container for the request parameters to the GetUpgradeHistory operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getUpgradeStatus
```
default GetUpgradeStatusResponse getUpgradeStatus(GetUpgradeStatusRequest getUpgradeStatusRequest)
                                           throws BaseException,
                                                  ResourceNotFoundException,
                                                  DisabledOperationException,
                                                  ValidationException,
                                                  InternalException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  OpenSearchException
```
    Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
    
    Parameters:
    
    getUpgradeStatusRequest - Container for the request parameters to the GetUpgradeStatus operation.
    
    Returns:
    
    Result of the GetUpgradeStatus operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - getUpgradeStatus
```
default GetUpgradeStatusResponse getUpgradeStatus(Consumer<GetUpgradeStatusRequest.Builder> getUpgradeStatusRequest)
                                           throws BaseException,
                                                  ResourceNotFoundException,
                                                  DisabledOperationException,
                                                  ValidationException,
                                                  InternalException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  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()
    
    Parameters:
    
    getUpgradeStatusRequest - A Consumer that will call methods on GetUpgradeStatusRequest.Builder to create a request. Container for the request parameters to the GetUpgradeStatus operation.
    
    Returns:
    
    Result of the GetUpgradeStatus operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listDomainNames
```
default ListDomainNamesResponse listDomainNames(ListDomainNamesRequest listDomainNamesRequest)
                                         throws BaseException,
                                                ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                OpenSearchException
```
    Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
    
    Parameters:
    
    listDomainNamesRequest - Container for the parameters to the ListDomainNames operation.
    
    Returns:
    
    Result of the ListDomainNames operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listDomainNames
```
default ListDomainNamesResponse listDomainNames(Consumer<ListDomainNamesRequest.Builder> listDomainNamesRequest)
                                         throws BaseException,
                                                ValidationException,
                                                AwsServiceException,
                                                SdkClientException,
                                                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()
    
    Parameters:
    
    listDomainNamesRequest - A Consumer that will call methods on ListDomainNamesRequest.Builder to create a request. Container for the parameters to the ListDomainNames operation.
    
    Returns:
    
    Result of the ListDomainNames operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listDomainsForPackage
```
default ListDomainsForPackageResponse listDomainsForPackage(ListDomainsForPackageRequest listDomainsForPackageRequest)
                                                     throws BaseException,
                                                            InternalException,
                                                            ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            ValidationException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            OpenSearchException
```
    Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.
    
    Returns:
    
    Result of the ListDomainsForPackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listDomainsForPackage
```
default ListDomainsForPackageResponse listDomainsForPackage(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)
                                                     throws BaseException,
                                                            InternalException,
                                                            ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            ValidationException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            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()
    
    Parameters:
    
    listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a request. Container for the request parameters to the ListDomainsForPackage operation.
    
    Returns:
    
    Result of the ListDomainsForPackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listDomainsForPackagePaginator
```
default ListDomainsForPackageIterable listDomainsForPackagePaginator(ListDomainsForPackageRequest listDomainsForPackageRequest)
                                                              throws BaseException,
                                                                     InternalException,
                                                                     ResourceNotFoundException,
                                                                     AccessDeniedException,
                                                                     ValidationException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     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.
    Parameters:
    
    listDomainsForPackageRequest - Container for the request parameters to the ListDomainsForPackage operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listDomainsForPackagePaginator
```
default ListDomainsForPackageIterable listDomainsForPackagePaginator(Consumer<ListDomainsForPackageRequest.Builder> listDomainsForPackageRequest)
                                                              throws BaseException,
                                                                     InternalException,
                                                                     ResourceNotFoundException,
                                                                     AccessDeniedException,
                                                                     ValidationException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     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()
    Parameters:
    
    listDomainsForPackageRequest - A Consumer that will call methods on ListDomainsForPackageRequest.Builder to create a request. Container for the request parameters to the ListDomainsForPackage operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listInstanceTypeDetails
```
default ListInstanceTypeDetailsResponse listInstanceTypeDetails(ListInstanceTypeDetailsRequest listInstanceTypeDetailsRequest)
                                                         throws BaseException,
                                                                InternalException,
                                                                ResourceNotFoundException,
                                                                ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
    
    Parameters:
    
    listInstanceTypeDetailsRequest -
    
    Returns:
    
    Result of the ListInstanceTypeDetails operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listInstanceTypeDetails
```
default ListInstanceTypeDetailsResponse listInstanceTypeDetails(Consumer<ListInstanceTypeDetailsRequest.Builder> listInstanceTypeDetailsRequest)
                                                         throws BaseException,
                                                                InternalException,
                                                                ResourceNotFoundException,
                                                                ValidationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
    
    This is a convenience which creates an instance of the ListInstanceTypeDetailsRequest.Builder avoiding the need to create one manually via ListInstanceTypeDetailsRequest.builder()
    
    Parameters:
    
    listInstanceTypeDetailsRequest - A Consumer that will call methods on ListInstanceTypeDetailsRequest.Builder to create a request.
    
    Returns:
    
    Result of the ListInstanceTypeDetails operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listInstanceTypeDetailsPaginator
```
default 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.
    Parameters:
    
    listInstanceTypeDetailsRequest -
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listInstanceTypeDetailsPaginator
```
default 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()
    Parameters:
    
    listInstanceTypeDetailsRequest - A Consumer that will call methods on ListInstanceTypeDetailsRequest.Builder to create a request.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listPackagesForDomain
```
default ListPackagesForDomainResponse listPackagesForDomain(ListPackagesForDomainRequest listPackagesForDomainRequest)
                                                     throws BaseException,
                                                            InternalException,
                                                            ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            ValidationException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            OpenSearchException
```
    Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.
    
    Returns:
    
    Result of the ListPackagesForDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listPackagesForDomain
```
default ListPackagesForDomainResponse listPackagesForDomain(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)
                                                     throws BaseException,
                                                            InternalException,
                                                            ResourceNotFoundException,
                                                            AccessDeniedException,
                                                            ValidationException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            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()
    
    Parameters:
    
    listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a request. Container for the request parameters to the ListPackagesForDomain operation.
    
    Returns:
    
    Result of the ListPackagesForDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listPackagesForDomainPaginator
```
default ListPackagesForDomainIterable listPackagesForDomainPaginator(ListPackagesForDomainRequest listPackagesForDomainRequest)
                                                              throws BaseException,
                                                                     InternalException,
                                                                     ResourceNotFoundException,
                                                                     AccessDeniedException,
                                                                     ValidationException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     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.
    Parameters:
    
    listPackagesForDomainRequest - Container for the request parameters to the ListPackagesForDomain operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listPackagesForDomainPaginator
```
default ListPackagesForDomainIterable listPackagesForDomainPaginator(Consumer<ListPackagesForDomainRequest.Builder> listPackagesForDomainRequest)
                                                              throws BaseException,
                                                                     InternalException,
                                                                     ResourceNotFoundException,
                                                                     AccessDeniedException,
                                                                     ValidationException,
                                                                     AwsServiceException,
                                                                     SdkClientException,
                                                                     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()
    Parameters:
    
    listPackagesForDomainRequest - A Consumer that will call methods on ListPackagesForDomainRequest.Builder to create a request. Container for the request parameters to the ListPackagesForDomain operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listTags
```
default ListTagsResponse listTags(ListTagsRequest listTagsRequest)
                           throws BaseException,
                                  ResourceNotFoundException,
                                  ValidationException,
                                  InternalException,
                                  AwsServiceException,
                                  SdkClientException,
                                  OpenSearchException
```
    Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
    
    Parameters:
    
    listTagsRequest - Container for the parameters to the ListTags operation.
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listTags
```
default ListTagsResponse listTags(Consumer<ListTagsRequest.Builder> listTagsRequest)
                           throws BaseException,
                                  ResourceNotFoundException,
                                  ValidationException,
                                  InternalException,
                                  AwsServiceException,
                                  SdkClientException,
                                  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()
    
    Parameters:
    
    listTagsRequest - A Consumer that will call methods on ListTagsRequest.Builder to create a request. Container for the parameters to the ListTags operation.
    
    Returns:
    
    Result of the ListTags operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVersions
```
default ListVersionsResponse listVersions(ListVersionsRequest listVersionsRequest)
                                   throws BaseException,
                                          InternalException,
                                          ResourceNotFoundException,
                                          ValidationException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OpenSearchException
```
    Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
    
    Parameters:
    
    listVersionsRequest - Container for the request parameters to the ListVersions operation.
    
    Returns:
    
    Result of the ListVersions operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVersions
```
default ListVersionsResponse listVersions(Consumer<ListVersionsRequest.Builder> listVersionsRequest)
                                   throws BaseException,
                                          InternalException,
                                          ResourceNotFoundException,
                                          ValidationException,
                                          AwsServiceException,
                                          SdkClientException,
                                          OpenSearchException
```
    Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
    
    This is a convenience which creates an instance of the ListVersionsRequest.Builder avoiding the need to create one manually via ListVersionsRequest.builder()
    
    Parameters:
    
    listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request. Container for the request parameters to the ListVersions operation.
    
    Returns:
    
    Result of the ListVersions operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVersionsPaginator
```
default 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.
    Parameters:
    
    listVersionsRequest - Container for the request parameters to the ListVersions operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVersionsPaginator
```
default 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()
    Parameters:
    
    listVersionsRequest - A Consumer that will call methods on ListVersionsRequest.Builder to create a request. Container for the request parameters to the ListVersions operation.
    
    Returns:
    
    A custom iterable that can be used to iterate through all the response pages.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVpcEndpointAccess
```
default ListVpcEndpointAccessResponse listVpcEndpointAccess(ListVpcEndpointAccessRequest listVpcEndpointAccessRequest)
                                                     throws ResourceNotFoundException,
                                                            DisabledOperationException,
                                                            InternalException,
                                                            BaseException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            OpenSearchException
```
    Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
    
    Parameters:
    
    listVpcEndpointAccessRequest -
    
    Returns:
    
    Result of the ListVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVpcEndpointAccess
```
default ListVpcEndpointAccessResponse listVpcEndpointAccess(Consumer<ListVpcEndpointAccessRequest.Builder> listVpcEndpointAccessRequest)
                                                     throws ResourceNotFoundException,
                                                            DisabledOperationException,
                                                            InternalException,
                                                            BaseException,
                                                            AwsServiceException,
                                                            SdkClientException,
                                                            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()
    
    Parameters:
    
    listVpcEndpointAccessRequest - A Consumer that will call methods on ListVpcEndpointAccessRequest.Builder to create a request.
    
    Returns:
    
    Result of the ListVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVpcEndpoints
```
default ListVpcEndpointsResponse listVpcEndpoints(ListVpcEndpointsRequest listVpcEndpointsRequest)
                                           throws InternalException,
                                                  DisabledOperationException,
                                                  BaseException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  OpenSearchException
```
    Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
    
    Parameters:
    
    listVpcEndpointsRequest -
    
    Returns:
    
    Result of the ListVpcEndpoints operation returned by the service.
    
    Throws:
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVpcEndpoints
```
default ListVpcEndpointsResponse listVpcEndpoints(Consumer<ListVpcEndpointsRequest.Builder> listVpcEndpointsRequest)
                                           throws InternalException,
                                                  DisabledOperationException,
                                                  BaseException,
                                                  AwsServiceException,
                                                  SdkClientException,
                                                  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()
    
    Parameters:
    
    listVpcEndpointsRequest - A Consumer that will call methods on ListVpcEndpointsRequest.Builder to create a request.
    
    Returns:
    
    Result of the ListVpcEndpoints operation returned by the service.
    
    Throws:
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVpcEndpointsForDomain
```
default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest listVpcEndpointsForDomainRequest)
                                                             throws InternalException,
                                                                    DisabledOperationException,
                                                                    ResourceNotFoundException,
                                                                    BaseException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    OpenSearchException
```
    Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
    
    Parameters:
    
    listVpcEndpointsForDomainRequest -
    
    Returns:
    
    Result of the ListVpcEndpointsForDomain operation returned by the service.
    
    Throws:
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - listVpcEndpointsForDomain
```
default ListVpcEndpointsForDomainResponse listVpcEndpointsForDomain(Consumer<ListVpcEndpointsForDomainRequest.Builder> listVpcEndpointsForDomainRequest)
                                                             throws InternalException,
                                                                    DisabledOperationException,
                                                                    ResourceNotFoundException,
                                                                    BaseException,
                                                                    AwsServiceException,
                                                                    SdkClientException,
                                                                    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()
    
    Parameters:
    
    listVpcEndpointsForDomainRequest - A Consumer that will call methods on ListVpcEndpointsForDomainRequest.Builder to create a request.
    
    Returns:
    
    Result of the ListVpcEndpointsForDomain operation returned by the service.
    
    Throws:
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - purchaseReservedInstanceOffering
```
default PurchaseReservedInstanceOfferingResponse purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest purchaseReservedInstanceOfferingRequest)
                                                                           throws ResourceNotFoundException,
                                                                                  ResourceAlreadyExistsException,
                                                                                  LimitExceededException,
                                                                                  DisabledOperationException,
                                                                                  ValidationException,
                                                                                  InternalException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  OpenSearchException
```
    Allows you to purchase Amazon OpenSearch Service Reserved Instances.
    
    Parameters:
    
    purchaseReservedInstanceOfferingRequest - Container for request parameters to the PurchaseReservedInstanceOffering operation.
    
    Returns:
    
    Result of the PurchaseReservedInstanceOffering operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - purchaseReservedInstanceOffering
```
default PurchaseReservedInstanceOfferingResponse purchaseReservedInstanceOffering(Consumer<PurchaseReservedInstanceOfferingRequest.Builder> purchaseReservedInstanceOfferingRequest)
                                                                           throws ResourceNotFoundException,
                                                                                  ResourceAlreadyExistsException,
                                                                                  LimitExceededException,
                                                                                  DisabledOperationException,
                                                                                  ValidationException,
                                                                                  InternalException,
                                                                                  AwsServiceException,
                                                                                  SdkClientException,
                                                                                  OpenSearchException
```
    Allows you to purchase Amazon OpenSearch Service Reserved Instances.
    
    This is a convenience which creates an instance of the PurchaseReservedInstanceOfferingRequest.Builder avoiding the need to create one manually via PurchaseReservedInstanceOfferingRequest.builder()
    
    Parameters:
    
    purchaseReservedInstanceOfferingRequest - A Consumer that will call methods on PurchaseReservedInstanceOfferingRequest.Builder to create a request. Container for request parameters to the PurchaseReservedInstanceOffering operation.
    
    Returns:
    
    Result of the PurchaseReservedInstanceOffering operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - rejectInboundConnection
```
default RejectInboundConnectionResponse rejectInboundConnection(RejectInboundConnectionRequest rejectInboundConnectionRequest)
                                                         throws ResourceNotFoundException,
                                                                DisabledOperationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
    
    Parameters:
    
    rejectInboundConnectionRequest - Container for the request parameters to the RejectInboundConnection operation.
    
    Returns:
    
    Result of the RejectInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - rejectInboundConnection
```
default RejectInboundConnectionResponse rejectInboundConnection(Consumer<RejectInboundConnectionRequest.Builder> rejectInboundConnectionRequest)
                                                         throws ResourceNotFoundException,
                                                                DisabledOperationException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
    
    This is a convenience which creates an instance of the RejectInboundConnectionRequest.Builder avoiding the need to create one manually via RejectInboundConnectionRequest.builder()
    
    Parameters:
    
    rejectInboundConnectionRequest - A Consumer that will call methods on RejectInboundConnectionRequest.Builder to create a request. Container for the request parameters to the RejectInboundConnection operation.
    
    Returns:
    
    Result of the RejectInboundConnection operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - removeTags
```
default RemoveTagsResponse removeTags(RemoveTagsRequest removeTagsRequest)
                               throws BaseException,
                                      ValidationException,
                                      InternalException,
                                      AwsServiceException,
                                      SdkClientException,
                                      OpenSearchException
```
    Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
    
    Parameters:
    
    removeTagsRequest - Container for the request parameters to the RemoveTags operation.
    
    Returns:
    
    Result of the RemoveTags operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - removeTags
```
default RemoveTagsResponse removeTags(Consumer<RemoveTagsRequest.Builder> removeTagsRequest)
                               throws BaseException,
                                      ValidationException,
                                      InternalException,
                                      AwsServiceException,
                                      SdkClientException,
                                      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()
    
    Parameters:
    
    removeTagsRequest - A Consumer that will call methods on RemoveTagsRequest.Builder to create a request. Container for the request parameters to the RemoveTags operation.
    
    Returns:
    
    Result of the RemoveTags operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - revokeVpcEndpointAccess
```
default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest revokeVpcEndpointAccessRequest)
                                                         throws ResourceNotFoundException,
                                                                ValidationException,
                                                                DisabledOperationException,
                                                                InternalException,
                                                                BaseException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                OpenSearchException
```
    Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
    
    Parameters:
    
    revokeVpcEndpointAccessRequest -
    
    Returns:
    
    Result of the RevokeVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - revokeVpcEndpointAccess
```
default RevokeVpcEndpointAccessResponse revokeVpcEndpointAccess(Consumer<RevokeVpcEndpointAccessRequest.Builder> revokeVpcEndpointAccessRequest)
                                                         throws ResourceNotFoundException,
                                                                ValidationException,
                                                                DisabledOperationException,
                                                                InternalException,
                                                                BaseException,
                                                                AwsServiceException,
                                                                SdkClientException,
                                                                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()
    
    Parameters:
    
    revokeVpcEndpointAccessRequest - A Consumer that will call methods on RevokeVpcEndpointAccessRequest.Builder to create a request.
    
    Returns:
    
    Result of the RevokeVpcEndpointAccess operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - startServiceSoftwareUpdate
```
default StartServiceSoftwareUpdateResponse startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest startServiceSoftwareUpdateRequest)
                                                               throws BaseException,
                                                                      InternalException,
                                                                      ResourceNotFoundException,
                                                                      ValidationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      OpenSearchException
```
    Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
    
    Parameters:
    
    startServiceSoftwareUpdateRequest - Container for the request parameters to the StartServiceSoftwareUpdate operation.
    
    Returns:
    
    Result of the StartServiceSoftwareUpdate operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - startServiceSoftwareUpdate
```
default StartServiceSoftwareUpdateResponse startServiceSoftwareUpdate(Consumer<StartServiceSoftwareUpdateRequest.Builder> startServiceSoftwareUpdateRequest)
                                                               throws BaseException,
                                                                      InternalException,
                                                                      ResourceNotFoundException,
                                                                      ValidationException,
                                                                      AwsServiceException,
                                                                      SdkClientException,
                                                                      OpenSearchException
```
    Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
    
    This is a convenience which creates an instance of the StartServiceSoftwareUpdateRequest.Builder avoiding the need to create one manually via StartServiceSoftwareUpdateRequest.builder()
    
    Parameters:
    
    startServiceSoftwareUpdateRequest - A Consumer that will call methods on StartServiceSoftwareUpdateRequest.Builder to create a request. Container for the request parameters to the StartServiceSoftwareUpdate operation.
    
    Returns:
    
    Result of the StartServiceSoftwareUpdate operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - updateDomainConfig
```
default UpdateDomainConfigResponse updateDomainConfig(UpdateDomainConfigRequest updateDomainConfigRequest)
                                               throws BaseException,
                                                      InternalException,
                                                      InvalidTypeException,
                                                      LimitExceededException,
                                                      ResourceNotFoundException,
                                                      ValidationException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      OpenSearchException
```
    Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
    
    Parameters:
    
    updateDomainConfigRequest - Container for the request parameters to the UpdateDomain operation.
    
    Returns:
    
    Result of the UpdateDomainConfig operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - updateDomainConfig
```
default UpdateDomainConfigResponse updateDomainConfig(Consumer<UpdateDomainConfigRequest.Builder> updateDomainConfigRequest)
                                               throws BaseException,
                                                      InternalException,
                                                      InvalidTypeException,
                                                      LimitExceededException,
                                                      ResourceNotFoundException,
                                                      ValidationException,
                                                      AwsServiceException,
                                                      SdkClientException,
                                                      OpenSearchException
```
    Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
    
    This is a convenience which creates an instance of the UpdateDomainConfigRequest.Builder avoiding the need to create one manually via UpdateDomainConfigRequest.builder()
    
    Parameters:
    
    updateDomainConfigRequest - A Consumer that will call methods on UpdateDomainConfigRequest.Builder to create a request. Container for the request parameters to the UpdateDomain operation.
    
    Returns:
    
    Result of the UpdateDomainConfig operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    InvalidTypeException - An exception for trying to create or access sub-resource that is either invalid or not supported. Gives http status code of 409.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - updatePackage
```
default UpdatePackageResponse updatePackage(UpdatePackageRequest updatePackageRequest)
                                     throws BaseException,
                                            InternalException,
                                            LimitExceededException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OpenSearchException
```
    Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
    
    Parameters:
    
    updatePackageRequest - Container for request parameters to the UpdatePackage operation.
    
    Returns:
    
    Result of the UpdatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - updatePackage
```
default UpdatePackageResponse updatePackage(Consumer<UpdatePackageRequest.Builder> updatePackageRequest)
                                     throws BaseException,
                                            InternalException,
                                            LimitExceededException,
                                            ResourceNotFoundException,
                                            AccessDeniedException,
                                            ValidationException,
                                            AwsServiceException,
                                            SdkClientException,
                                            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()
    
    Parameters:
    
    updatePackageRequest - A Consumer that will call methods on UpdatePackageRequest.Builder to create a request. Container for request parameters to the UpdatePackage operation.
    
    Returns:
    
    Result of the UpdatePackage operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    LimitExceededException - An exception for trying to create more than allowed resources or sub-resources. Gives http status code of 409.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    AccessDeniedException - An error occurred because user does not have permissions to access the resource. Returns HTTP status code 403.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - updateVpcEndpoint
```
default UpdateVpcEndpointResponse updateVpcEndpoint(UpdateVpcEndpointRequest updateVpcEndpointRequest)
                                             throws ResourceNotFoundException,
                                                    DisabledOperationException,
                                                    InternalException,
                                                    ValidationException,
                                                    ConflictException,
                                                    BaseException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    OpenSearchException
```
    Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
    
    Parameters:
    
    updateVpcEndpointRequest -
    
    Returns:
    
    Result of the UpdateVpcEndpoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - updateVpcEndpoint
```
default UpdateVpcEndpointResponse updateVpcEndpoint(Consumer<UpdateVpcEndpointRequest.Builder> updateVpcEndpointRequest)
                                             throws ResourceNotFoundException,
                                                    DisabledOperationException,
                                                    InternalException,
                                                    ValidationException,
                                                    ConflictException,
                                                    BaseException,
                                                    AwsServiceException,
                                                    SdkClientException,
                                                    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()
    
    Parameters:
    
    updateVpcEndpointRequest - A Consumer that will call methods on UpdateVpcEndpointRequest.Builder to create a request.
    
    Returns:
    
    Result of the UpdateVpcEndpoint operation returned by the service.
    
    Throws:
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    ConflictException - An error occurred because the client attempts to remove a resource that is currently in use. Returns HTTP status code 409.
    
    BaseException - An error occurred while processing the request.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - upgradeDomain
```
default UpgradeDomainResponse upgradeDomain(UpgradeDomainRequest upgradeDomainRequest)
                                     throws BaseException,
                                            ResourceNotFoundException,
                                            ResourceAlreadyExistsException,
                                            DisabledOperationException,
                                            ValidationException,
                                            InternalException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OpenSearchException
```
    Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
    
    Parameters:
    
    upgradeDomainRequest - Container for the request parameters to the UpgradeDomain operation.
    
    Returns:
    
    Result of the UpgradeDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - upgradeDomain
```
default UpgradeDomainResponse upgradeDomain(Consumer<UpgradeDomainRequest.Builder> upgradeDomainRequest)
                                     throws BaseException,
                                            ResourceNotFoundException,
                                            ResourceAlreadyExistsException,
                                            DisabledOperationException,
                                            ValidationException,
                                            InternalException,
                                            AwsServiceException,
                                            SdkClientException,
                                            OpenSearchException
```
    Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
    
    This is a convenience which creates an instance of the UpgradeDomainRequest.Builder avoiding the need to create one manually via UpgradeDomainRequest.builder()
    
    Parameters:
    
    upgradeDomainRequest - A Consumer that will call methods on UpgradeDomainRequest.Builder to create a request. Container for the request parameters to the UpgradeDomain operation.
    
    Returns:
    
    Result of the UpgradeDomain operation returned by the service.
    
    Throws:
    
    BaseException - An error occurred while processing the request.
    
    ResourceNotFoundException - An exception for accessing or deleting a resource that does not exist. Gives http status code of 400.
    
    ResourceAlreadyExistsException - An exception for creating a resource that already exists. Gives http status code of 400.
    
    DisabledOperationException - An error occured because the client wanted to access a not supported operation. Gives http status code of 409.
    
    ValidationException - An exception for missing / invalid input fields. Gives http status code of 400.
    
    InternalException - The request processing has failed because of an unknown error, exception or failure (the failure is internal to the service) . Gives http status code of 500.
    
    SdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
    
    SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.
    
    OpenSearchException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
    
    AwsServiceException
  - serviceMetadata
```
static ServiceMetadata serviceMetadata()
```

Interface OpenSearchClient

Field Summary

Method Summary

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

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

Field Detail

SERVICE_NAME

SERVICE_METADATA_ID

Method Detail

create

builder

acceptInboundConnection

acceptInboundConnection

addTags

addTags

associatePackage

associatePackage

authorizeVpcEndpointAccess

authorizeVpcEndpointAccess

cancelServiceSoftwareUpdate

cancelServiceSoftwareUpdate

createDomain

createDomain

createOutboundConnection

createOutboundConnection

createPackage

createPackage

createVpcEndpoint

createVpcEndpoint

deleteDomain

deleteDomain

deleteInboundConnection

deleteInboundConnection

deleteOutboundConnection

deleteOutboundConnection

deletePackage

deletePackage

deleteVpcEndpoint

deleteVpcEndpoint

describeDomain

describeDomain

describeDomainAutoTunes

describeDomainAutoTunes

describeDomainAutoTunesPaginator

describeDomainAutoTunesPaginator

describeDomainChangeProgress

describeDomainChangeProgress

describeDomainConfig

describeDomainConfig

describeDomains

describeDomains

describeInboundConnections

describeInboundConnections

describeInboundConnectionsPaginator

describeInboundConnectionsPaginator

describeInstanceTypeLimits

describeInstanceTypeLimits

describeOutboundConnections

describeOutboundConnections

describeOutboundConnectionsPaginator

describeOutboundConnectionsPaginator

describePackages

describePackages

describePackagesPaginator

describePackagesPaginator

describeReservedInstanceOfferings

describeReservedInstanceOfferings

describeReservedInstanceOfferingsPaginator

describeReservedInstanceOfferingsPaginator

describeReservedInstances

describeReservedInstances

describeReservedInstancesPaginator

describeReservedInstancesPaginator

describeVpcEndpoints

describeVpcEndpoints

dissociatePackage

dissociatePackage

getCompatibleVersions

getCompatibleVersions

getPackageVersionHistory