All Implemented Interfaces:

AmazonOpenSearch

Direct Known Subclasses:

AbstractAmazonOpenSearchAsync

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAmazonOpenSearch
extends Object
implements AmazonOpenSearch 

• Field Summary

  • Fields inherited from interface com.amazonaws.services.opensearch.AmazonOpenSearch

    ENDPOINT_PREFIX

• Method Summary

  All Methods

  Modifier and Type	Method and Description
  AcceptInboundConnectionResult	acceptInboundConnection (AcceptInboundConnectionRequest request) Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
  AddDataSourceResult	addDataSource (AddDataSourceRequest request) Creates a new direct-query data source to the specified domain.
  AddTagsResult	addTags (AddTagsRequest request) Attaches tags to an existing Amazon OpenSearch Service domain.
  AssociatePackageResult	associatePackage (AssociatePackageRequest request) Associates a package with an Amazon OpenSearch Service domain.
  AuthorizeVpcEndpointAccessResult	authorizeVpcEndpointAccess (AuthorizeVpcEndpointAccessRequest request) Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
  CancelDomainConfigChangeResult	cancelDomainConfigChange (CancelDomainConfigChangeRequest request) Cancels a pending configuration change on an Amazon OpenSearch Service domain.
  CancelServiceSoftwareUpdateResult	cancelServiceSoftwareUpdate (CancelServiceSoftwareUpdateRequest request) Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
  CreateDomainResult	createDomain (CreateDomainRequest request) Creates an Amazon OpenSearch Service domain.
  CreateOutboundConnectionResult	createOutboundConnection (CreateOutboundConnectionRequest request) Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
  CreatePackageResult	createPackage (CreatePackageRequest request) Creates a package for use with Amazon OpenSearch Service domains.
  CreateVpcEndpointResult	createVpcEndpoint (CreateVpcEndpointRequest request) Creates an Amazon OpenSearch Service-managed VPC endpoint.
  DeleteDataSourceResult	deleteDataSource (DeleteDataSourceRequest request) Deletes a direct-query data source.
  DeleteDomainResult	deleteDomain (DeleteDomainRequest request) Deletes an Amazon OpenSearch Service domain and all of its data.
  DeleteInboundConnectionResult	deleteInboundConnection (DeleteInboundConnectionRequest request) Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
  DeleteOutboundConnectionResult	deleteOutboundConnection (DeleteOutboundConnectionRequest request) Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
  DeletePackageResult	deletePackage (DeletePackageRequest request) Deletes an Amazon OpenSearch Service package.
  DeleteVpcEndpointResult	deleteVpcEndpoint (DeleteVpcEndpointRequest request) Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
  DescribeDomainResult	describeDomain (DescribeDomainRequest request) Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
  DescribeDomainAutoTunesResult	describeDomainAutoTunes (DescribeDomainAutoTunesRequest request) Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
  DescribeDomainChangeProgressResult	describeDomainChangeProgress (DescribeDomainChangeProgressRequest request) Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
  DescribeDomainConfigResult	describeDomainConfig (DescribeDomainConfigRequest request) Returns the configuration of an Amazon OpenSearch Service domain.
  DescribeDomainHealthResult	describeDomainHealth (DescribeDomainHealthRequest request) Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
  DescribeDomainNodesResult	describeDomainNodes (DescribeDomainNodesRequest request) Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
  DescribeDomainsResult	describeDomains (DescribeDomainsRequest request) Returns domain configuration information about the specified Amazon OpenSearch Service domains.
  DescribeDryRunProgressResult	describeDryRunProgress (DescribeDryRunProgressRequest request) Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
  DescribeInboundConnectionsResult	describeInboundConnections (DescribeInboundConnectionsRequest request) Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
  DescribeInstanceTypeLimitsResult	describeInstanceTypeLimits (DescribeInstanceTypeLimitsRequest request) Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
  DescribeOutboundConnectionsResult	describeOutboundConnections (DescribeOutboundConnectionsRequest request) Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
  DescribePackagesResult	describePackages (DescribePackagesRequest request) Describes all packages available to OpenSearch Service.
  DescribeReservedInstanceOfferingsResult	describeReservedInstanceOfferings (DescribeReservedInstanceOfferingsRequest request) Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
  DescribeReservedInstancesResult	describeReservedInstances (DescribeReservedInstancesRequest request) Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
  DescribeVpcEndpointsResult	describeVpcEndpoints (DescribeVpcEndpointsRequest request) Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
  DissociatePackageResult	dissociatePackage (DissociatePackageRequest request) Removes a package from the specified Amazon OpenSearch Service domain.
  ResponseMetadata	getCachedResponseMetadata (AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.
  GetCompatibleVersionsResult	getCompatibleVersions (GetCompatibleVersionsRequest request) Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
  GetDataSourceResult	getDataSource (GetDataSourceRequest request) Retrieves information about a direct query data source.
  GetDomainMaintenanceStatusResult	getDomainMaintenanceStatus (GetDomainMaintenanceStatusRequest request) The status of the maintenance action.
  GetPackageVersionHistoryResult	getPackageVersionHistory (GetPackageVersionHistoryRequest request) Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).
  GetUpgradeHistoryResult	getUpgradeHistory (GetUpgradeHistoryRequest request) Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
  GetUpgradeStatusResult	getUpgradeStatus (GetUpgradeStatusRequest request) Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
  ListDataSourcesResult	listDataSources (ListDataSourcesRequest request) Lists direct-query data sources for a specific domain.
  ListDomainMaintenancesResult	listDomainMaintenances (ListDomainMaintenancesRequest request) A list of maintenance actions for the domain.
  ListDomainNamesResult	listDomainNames (ListDomainNamesRequest request) Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
  ListDomainsForPackageResult	listDomainsForPackage (ListDomainsForPackageRequest request) Lists all Amazon OpenSearch Service domains associated with a given package.
  ListInstanceTypeDetailsResult	listInstanceTypeDetails (ListInstanceTypeDetailsRequest request) Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
  ListPackagesForDomainResult	listPackagesForDomain (ListPackagesForDomainRequest request) Lists all packages associated with an Amazon OpenSearch Service domain.
  ListScheduledActionsResult	listScheduledActions (ListScheduledActionsRequest request) Retrieves a list of configuration changes that are scheduled for a domain.
  ListTagsResult	listTags (ListTagsRequest request) Returns all resource tags for an Amazon OpenSearch Service domain.
  ListVersionsResult	listVersions (ListVersionsRequest request) Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
  ListVpcEndpointAccessResult	listVpcEndpointAccess (ListVpcEndpointAccessRequest request) 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.
  ListVpcEndpointsResult	listVpcEndpoints (ListVpcEndpointsRequest request) Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
  ListVpcEndpointsForDomainResult	listVpcEndpointsForDomain (ListVpcEndpointsForDomainRequest request) Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
  PurchaseReservedInstanceOfferingResult	purchaseReservedInstanceOffering (PurchaseReservedInstanceOfferingRequest request) Allows you to purchase Amazon OpenSearch Service Reserved Instances.
  RejectInboundConnectionResult	rejectInboundConnection (RejectInboundConnectionRequest request) Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
  RemoveTagsResult	removeTags (RemoveTagsRequest request) Removes the specified set of tags from an Amazon OpenSearch Service domain.
  RevokeVpcEndpointAccessResult	revokeVpcEndpointAccess (RevokeVpcEndpointAccessRequest request) Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
  void	shutdown () Shuts down this client object, releasing any resources that might be held open.
  StartDomainMaintenanceResult	startDomainMaintenance (StartDomainMaintenanceRequest request) Starts the node maintenance process on the data node.
  StartServiceSoftwareUpdateResult	startServiceSoftwareUpdate (StartServiceSoftwareUpdateRequest request) Schedules a service software update for an Amazon OpenSearch Service domain.
  UpdateDataSourceResult	updateDataSource (UpdateDataSourceRequest request) Updates a direct-query data source.
  UpdateDomainConfigResult	updateDomainConfig (UpdateDomainConfigRequest request) Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
  UpdatePackageResult	updatePackage (UpdatePackageRequest request) Updates a package for use with Amazon OpenSearch Service domains.
  UpdateScheduledActionResult	updateScheduledAction (UpdateScheduledActionRequest request) Reschedules a planned domain configuration change for a later time.
  UpdateVpcEndpointResult	updateVpcEndpoint (UpdateVpcEndpointRequest request) Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
  UpgradeDomainResult	upgradeDomain (UpgradeDomainRequest request) 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 class java.lang.Object

    equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

• Method Detail

  • acceptInboundConnection

    public AcceptInboundConnectionResult acceptInboundConnection(AcceptInboundConnectionRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    acceptInboundConnection in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the AcceptInboundConnection operation.

    Returns:

    Result of the AcceptInboundConnection operation returned by the service.

  • addDataSource

    public AddDataSourceResult addDataSource(AddDataSourceRequest request)

    Description copied from interface: AmazonOpenSearch

    Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.

    Specified by:

    addDataSource in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the AddDataSource operation.

    Returns:

    Result of the AddDataSource operation returned by the service.

  • addTags

    public AddTagsResult addTags(AddTagsRequest request)

    Description copied from interface: AmazonOpenSearch

    Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

    Specified by:

    addTags in interface AmazonOpenSearch

    Parameters:

    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.

  • associatePackage

    public AssociatePackageResult associatePackage(AssociatePackageRequest request)

    Description copied from interface: AmazonOpenSearch

    Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    associatePackage in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the AssociatePackage operation.

    Returns:

    Result of the AssociatePackage operation returned by the service.

  • authorizeVpcEndpointAccess

    public AuthorizeVpcEndpointAccessResult authorizeVpcEndpointAccess(AuthorizeVpcEndpointAccessRequest request)

    Description copied from interface: AmazonOpenSearch

    Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

    Specified by:

    authorizeVpcEndpointAccess in interface AmazonOpenSearch

    Returns:

    Result of the AuthorizeVpcEndpointAccess operation returned by the service.

  • cancelDomainConfigChange

    public CancelDomainConfigChangeResult cancelDomainConfigChange(CancelDomainConfigChangeRequest request)

    Description copied from interface: AmazonOpenSearch

    Cancels a pending configuration change on an Amazon OpenSearch Service domain.

    Specified by:

    cancelDomainConfigChange in interface AmazonOpenSearch

    Returns:

    Result of the CancelDomainConfigChange operation returned by the service.

  • cancelServiceSoftwareUpdate

    public CancelServiceSoftwareUpdateResult cancelServiceSoftwareUpdate(CancelServiceSoftwareUpdateRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    cancelServiceSoftwareUpdate in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to cancel a service software update.

    Returns:

    Result of the CancelServiceSoftwareUpdate operation returned by the service.

  • createDomain

    public CreateDomainResult createDomain(CreateDomainRequest request)

    Description copied from interface: AmazonOpenSearch

    Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

    Specified by:

    createDomain in interface AmazonOpenSearch

    Returns:

    Result of the CreateDomain operation returned by the service.

  • createOutboundConnection

    public CreateOutboundConnectionResult createOutboundConnection(CreateOutboundConnectionRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    createOutboundConnection in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the CreateOutboundConnection operation.

    Returns:

    Result of the CreateOutboundConnection operation returned by the service.

  • createPackage

    public CreatePackageResult createPackage(CreatePackageRequest request)

    Description copied from interface: AmazonOpenSearch

    Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    createPackage in interface AmazonOpenSearch

    Parameters:

    request - Container for request parameters to the CreatePackage operation.

    Returns:

    Result of the CreatePackage operation returned by the service.

  • createVpcEndpoint

    public CreateVpcEndpointResult createVpcEndpoint(CreateVpcEndpointRequest request)

    Description copied from interface: AmazonOpenSearch

    Creates an Amazon OpenSearch Service-managed VPC endpoint.

    Specified by:

    createVpcEndpoint in interface AmazonOpenSearch

    Returns:

    Result of the CreateVpcEndpoint operation returned by the service.

  • deleteDataSource

    public DeleteDataSourceResult deleteDataSource(DeleteDataSourceRequest request)

    Description copied from interface: AmazonOpenSearch

    Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

    Specified by:

    deleteDataSource in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DeleteDataSource operation.

    Returns:

    Result of the DeleteDataSource operation returned by the service.

  • deleteDomain

    public DeleteDomainResult deleteDomain(DeleteDomainRequest request)

    Description copied from interface: AmazonOpenSearch

    Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

    Specified by:

    deleteDomain in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DeleteDomain operation.

    Returns:

    Result of the DeleteDomain operation returned by the service.

  • deleteInboundConnection

    public DeleteInboundConnectionResult deleteInboundConnection(DeleteInboundConnectionRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    deleteInboundConnection in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DeleteInboundConnection operation.

    Returns:

    Result of the DeleteInboundConnection operation returned by the service.

  • deleteOutboundConnection

    public DeleteOutboundConnectionResult deleteOutboundConnection(DeleteOutboundConnectionRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    deleteOutboundConnection in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DeleteOutboundConnection operation.

    Returns:

    Result of the DeleteOutboundConnection operation returned by the service.

  • deletePackage

    public DeletePackageResult deletePackage(DeletePackageRequest request)

    Description copied from interface: AmazonOpenSearch

    Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    deletePackage in interface AmazonOpenSearch

    Parameters:

    request - Deletes a package from OpenSearch Service. The package can't be associated with any OpenSearch Service domain.

    Returns:

    Result of the DeletePackage operation returned by the service.

  • deleteVpcEndpoint

    public DeleteVpcEndpointResult deleteVpcEndpoint(DeleteVpcEndpointRequest request)

    Description copied from interface: AmazonOpenSearch

    Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

    Specified by:

    deleteVpcEndpoint in interface AmazonOpenSearch

    Returns:

    Result of the DeleteVpcEndpoint operation returned by the service.

  • describeDomain

    public DescribeDomainResult describeDomain(DescribeDomainRequest request)

    Description copied from interface: AmazonOpenSearch

    Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

    Specified by:

    describeDomain in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeDomain operation.

    Returns:

    Result of the DescribeDomain operation returned by the service.

  • describeDomainAutoTunes

    public DescribeDomainAutoTunesResult describeDomainAutoTunes(DescribeDomainAutoTunesRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    describeDomainAutoTunes in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeDomainAutoTunes operation.

    Returns:

    Result of the DescribeDomainAutoTunes operation returned by the service.

  • describeDomainChangeProgress

    public DescribeDomainChangeProgressResult describeDomainChangeProgress(DescribeDomainChangeProgressRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    describeDomainChangeProgress in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeDomainChangeProgress operation.

    Returns:

    Result of the DescribeDomainChangeProgress operation returned by the service.

  • describeDomainConfig

    public DescribeDomainConfigResult describeDomainConfig(DescribeDomainConfigRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns the configuration of an Amazon OpenSearch Service domain.

    Specified by:

    describeDomainConfig in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeDomainConfig operation.

    Returns:

    Result of the DescribeDomainConfig operation returned by the service.

  • describeDomainHealth

    public DescribeDomainHealthResult describeDomainHealth(DescribeDomainHealthRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.

    Specified by:

    describeDomainHealth in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeDomainHealth operation.

    Returns:

    Result of the DescribeDomainHealth operation returned by the service.

  • describeDomainNodes

    public DescribeDomainNodesResult describeDomainNodes(DescribeDomainNodesRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.

    Specified by:

    describeDomainNodes in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeDomainNodes operation.

    Returns:

    Result of the DescribeDomainNodes operation returned by the service.

  • describeDomains

    public DescribeDomainsResult describeDomains(DescribeDomainsRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns domain configuration information about the specified Amazon OpenSearch Service domains.

    Specified by:

    describeDomains in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeDomains operation.

    Returns:

    Result of the DescribeDomains operation returned by the service.

  • describeDryRunProgress

    public DescribeDryRunProgressResult describeDryRunProgress(DescribeDryRunProgressRequest request)

    Description copied from interface: AmazonOpenSearch

    Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

    Specified by:

    describeDryRunProgress in interface AmazonOpenSearch

    Returns:

    Result of the DescribeDryRunProgress operation returned by the service.

  • describeInboundConnections

    public DescribeInboundConnectionsResult describeInboundConnections(DescribeInboundConnectionsRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    describeInboundConnections in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeInboundConnections operation.

    Returns:

    Result of the DescribeInboundConnections operation returned by the service.

  • describeInstanceTypeLimits

    public DescribeInstanceTypeLimitsResult describeInstanceTypeLimits(DescribeInstanceTypeLimitsRequest request)

    Description copied from interface: AmazonOpenSearch

    Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

    Specified by:

    describeInstanceTypeLimits in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeInstanceTypeLimits operation.

    Returns:

    Result of the DescribeInstanceTypeLimits operation returned by the service.

  • describeOutboundConnections

    public DescribeOutboundConnectionsResult describeOutboundConnections(DescribeOutboundConnectionsRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    describeOutboundConnections in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the DescribeOutboundConnections operation.

    Returns:

    Result of the DescribeOutboundConnections operation returned by the service.

  • describePackages

    public DescribePackagesResult describePackages(DescribePackagesRequest request)

    Description copied from interface: AmazonOpenSearch

    Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    describePackages in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the DescribePackage operation.

    Returns:

    Result of the DescribePackages operation returned by the service.

  • describeReservedInstanceOfferings

    public DescribeReservedInstanceOfferingsResult describeReservedInstanceOfferings(DescribeReservedInstanceOfferingsRequest request)

    Description copied from interface: AmazonOpenSearch

    Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

    Specified by:

    describeReservedInstanceOfferings in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to a DescribeReservedInstanceOfferings operation.

    Returns:

    Result of the DescribeReservedInstanceOfferings operation returned by the service.

  • describeReservedInstances

    public DescribeReservedInstancesResult describeReservedInstances(DescribeReservedInstancesRequest request)

    Description copied from interface: AmazonOpenSearch

    Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

    Specified by:

    describeReservedInstances in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the DescribeReservedInstances operation.

    Returns:

    Result of the DescribeReservedInstances operation returned by the service.

  • describeVpcEndpoints

    public DescribeVpcEndpointsResult describeVpcEndpoints(DescribeVpcEndpointsRequest request)

    Description copied from interface: AmazonOpenSearch

    Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

    Specified by:

    describeVpcEndpoints in interface AmazonOpenSearch

    Returns:

    Result of the DescribeVpcEndpoints operation returned by the service.

  • dissociatePackage

    public DissociatePackageResult dissociatePackage(DissociatePackageRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    dissociatePackage in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the DissociatePackage operation.

    Returns:

    Result of the DissociatePackage operation returned by the service.

  • getCompatibleVersions

    public GetCompatibleVersionsResult getCompatibleVersions(GetCompatibleVersionsRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

    Specified by:

    getCompatibleVersions in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to GetCompatibleVersions operation.

    Returns:

    Result of the GetCompatibleVersions operation returned by the service.

  • getDataSource

    public GetDataSourceResult getDataSource(GetDataSourceRequest request)

    Description copied from interface: AmazonOpenSearch

    Retrieves information about a direct query data source.

    Specified by:

    getDataSource in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the GetDataSource operation.

    Returns:

    Result of the GetDataSource operation returned by the service.

  • getDomainMaintenanceStatus

    public GetDomainMaintenanceStatusResult getDomainMaintenanceStatus(GetDomainMaintenanceStatusRequest request)

    Description copied from interface: AmazonOpenSearch

    The status of the maintenance action.

    Specified by:

    getDomainMaintenanceStatus in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the GetDomainMaintenanceStatus operation.

    Returns:

    Result of the GetDomainMaintenanceStatus operation returned by the service.

  • getPackageVersionHistory

    public GetPackageVersionHistoryResult getPackageVersionHistory(GetPackageVersionHistoryRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    getPackageVersionHistory in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the GetPackageVersionHistory operation.

    Returns:

    Result of the GetPackageVersionHistory operation returned by the service.

  • getUpgradeHistory

    public GetUpgradeHistoryResult getUpgradeHistory(GetUpgradeHistoryRequest request)

    Description copied from interface: AmazonOpenSearch

    Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

    Specified by:

    getUpgradeHistory in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the GetUpgradeHistory operation.

    Returns:

    Result of the GetUpgradeHistory operation returned by the service.

  • getUpgradeStatus

    public GetUpgradeStatusResult getUpgradeStatus(GetUpgradeStatusRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

    Specified by:

    getUpgradeStatus in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the GetUpgradeStatus operation.

    Returns:

    Result of the GetUpgradeStatus operation returned by the service.

  • listDataSources

    public ListDataSourcesResult listDataSources(ListDataSourcesRequest request)

    Description copied from interface: AmazonOpenSearch

    Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.

    Specified by:

    listDataSources in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the ListDataSources operation.

    Returns:

    Result of the ListDataSources operation returned by the service.

  • listDomainMaintenances

    public ListDomainMaintenancesResult listDomainMaintenances(ListDomainMaintenancesRequest request)

    Description copied from interface: AmazonOpenSearch

    A list of maintenance actions for the domain.

    Specified by:

    listDomainMaintenances in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the ListDomainMaintenances operation.

    Returns:

    Result of the ListDomainMaintenances operation returned by the service.

  • listDomainNames

    public ListDomainNamesResult listDomainNames(ListDomainNamesRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

    Specified by:

    listDomainNames in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the ListDomainNames operation.

    Returns:

    Result of the ListDomainNames operation returned by the service.

  • listDomainsForPackage

    public ListDomainsForPackageResult listDomainsForPackage(ListDomainsForPackageRequest request)

    Description copied from interface: AmazonOpenSearch

    Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    listDomainsForPackage in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the ListDomainsForPackage operation.

    Returns:

    Result of the ListDomainsForPackage operation returned by the service.

  • listInstanceTypeDetails

    public ListInstanceTypeDetailsResult listInstanceTypeDetails(ListInstanceTypeDetailsRequest request)

    Description copied from interface: AmazonOpenSearch

    Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

    Specified by:

    listInstanceTypeDetails in interface AmazonOpenSearch

    Returns:

    Result of the ListInstanceTypeDetails operation returned by the service.

  • listPackagesForDomain

    public ListPackagesForDomainResult listPackagesForDomain(ListPackagesForDomainRequest request)

    Description copied from interface: AmazonOpenSearch

    Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    listPackagesForDomain in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the ListPackagesForDomain operation.

    Returns:

    Result of the ListPackagesForDomain operation returned by the service.

  • listScheduledActions

    public ListScheduledActionsResult listScheduledActions(ListScheduledActionsRequest request)

    Description copied from interface: AmazonOpenSearch

    Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

    Specified by:

    listScheduledActions in interface AmazonOpenSearch

    Returns:

    Result of the ListScheduledActions operation returned by the service.

  • listTags

    public ListTagsResult listTags(ListTagsRequest request)

    Description copied from interface: AmazonOpenSearch

    Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

    Specified by:

    listTags in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the ListTags operation.

    Returns:

    Result of the ListTags operation returned by the service.

  • listVersions

    public ListVersionsResult listVersions(ListVersionsRequest request)

    Description copied from interface: AmazonOpenSearch

    Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

    Specified by:

    listVersions in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the ListVersions operation.

    Returns:

    Result of the ListVersions operation returned by the service.

  • listVpcEndpointAccess

    public ListVpcEndpointAccessResult listVpcEndpointAccess(ListVpcEndpointAccessRequest request)

    Description copied from interface: AmazonOpenSearch

    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.

    Specified by:

    listVpcEndpointAccess in interface AmazonOpenSearch

    Returns:

    Result of the ListVpcEndpointAccess operation returned by the service.

  • listVpcEndpoints

    public ListVpcEndpointsResult listVpcEndpoints(ListVpcEndpointsRequest request)

    Description copied from interface: AmazonOpenSearch

    Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

    Specified by:

    listVpcEndpoints in interface AmazonOpenSearch

    Returns:

    Result of the ListVpcEndpoints operation returned by the service.

  • listVpcEndpointsForDomain

    public ListVpcEndpointsForDomainResult listVpcEndpointsForDomain(ListVpcEndpointsForDomainRequest request)

    Description copied from interface: AmazonOpenSearch

    Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

    Specified by:

    listVpcEndpointsForDomain in interface AmazonOpenSearch

    Returns:

    Result of the ListVpcEndpointsForDomain operation returned by the service.

  • purchaseReservedInstanceOffering

    public PurchaseReservedInstanceOfferingResult purchaseReservedInstanceOffering(PurchaseReservedInstanceOfferingRequest request)

    Description copied from interface: AmazonOpenSearch

    Allows you to purchase Amazon OpenSearch Service Reserved Instances.

    Specified by:

    purchaseReservedInstanceOffering in interface AmazonOpenSearch

    Parameters:

    request - Container for request parameters to the PurchaseReservedInstanceOffering operation.

    Returns:

    Result of the PurchaseReservedInstanceOffering operation returned by the service.

  • rejectInboundConnection

    public RejectInboundConnectionResult rejectInboundConnection(RejectInboundConnectionRequest request)

    Description copied from interface: AmazonOpenSearch

    Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

    Specified by:

    rejectInboundConnection in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the RejectInboundConnection operation.

    Returns:

    Result of the RejectInboundConnection operation returned by the service.

  • removeTags

    public RemoveTagsResult removeTags(RemoveTagsRequest request)

    Description copied from interface: AmazonOpenSearch

    Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

    Specified by:

    removeTags in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the RemoveTags operation.

    Returns:

    Result of the RemoveTags operation returned by the service.

  • revokeVpcEndpointAccess

    public RevokeVpcEndpointAccessResult revokeVpcEndpointAccess(RevokeVpcEndpointAccessRequest request)

    Description copied from interface: AmazonOpenSearch

    Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

    Specified by:

    revokeVpcEndpointAccess in interface AmazonOpenSearch

    Returns:

    Result of the RevokeVpcEndpointAccess operation returned by the service.

  • startDomainMaintenance

    public StartDomainMaintenanceResult startDomainMaintenance(StartDomainMaintenanceRequest request)

    Description copied from interface: AmazonOpenSearch

    Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.

    Specified by:

    startDomainMaintenance in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the StartDomainMaintenance operation.

    Returns:

    Result of the StartDomainMaintenance operation returned by the service.

  • startServiceSoftwareUpdate

    public StartServiceSoftwareUpdateResult startServiceSoftwareUpdate(StartServiceSoftwareUpdateRequest request)

    Description copied from interface: AmazonOpenSearch

    Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

    Specified by:

    startServiceSoftwareUpdate in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the StartServiceSoftwareUpdate operation.

    Returns:

    Result of the StartServiceSoftwareUpdate operation returned by the service.

  • updateDataSource

    public UpdateDataSourceResult updateDataSource(UpdateDataSourceRequest request)

    Description copied from interface: AmazonOpenSearch

    Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

    Specified by:

    updateDataSource in interface AmazonOpenSearch

    Parameters:

    request - Container for the parameters to the UpdateDataSource operation.

    Returns:

    Result of the UpdateDataSource operation returned by the service.

  • updateDomainConfig

    public UpdateDomainConfigResult updateDomainConfig(UpdateDomainConfigRequest request)

    Description copied from interface: AmazonOpenSearch

    Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

    Specified by:

    updateDomainConfig in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the UpdateDomain operation.

    Returns:

    Result of the UpdateDomainConfig operation returned by the service.

  • updatePackage

    public UpdatePackageResult updatePackage(UpdatePackageRequest request)

    Description copied from interface: AmazonOpenSearch

    Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

    Specified by:

    updatePackage in interface AmazonOpenSearch

    Parameters:

    request - Container for request parameters to the UpdatePackage operation.

    Returns:

    Result of the UpdatePackage operation returned by the service.

  • updateScheduledAction

    public UpdateScheduledActionResult updateScheduledAction(UpdateScheduledActionRequest request)

    Description copied from interface: AmazonOpenSearch

    Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

    Specified by:

    updateScheduledAction in interface AmazonOpenSearch

    Returns:

    Result of the UpdateScheduledAction operation returned by the service.

  • updateVpcEndpoint

    public UpdateVpcEndpointResult updateVpcEndpoint(UpdateVpcEndpointRequest request)

    Description copied from interface: AmazonOpenSearch

    Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

    Specified by:

    updateVpcEndpoint in interface AmazonOpenSearch

    Returns:

    Result of the UpdateVpcEndpoint operation returned by the service.

  • upgradeDomain

    public UpgradeDomainResult upgradeDomain(UpgradeDomainRequest request)

    Description copied from interface: AmazonOpenSearch

    Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

    Specified by:

    upgradeDomain in interface AmazonOpenSearch

    Parameters:

    request - Container for the request parameters to the UpgradeDomain operation.

    Returns:

    Result of the UpgradeDomain operation returned by the service.

  • shutdown

    public void shutdown()

    Description copied from interface: AmazonOpenSearch
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

    Specified by:

    shutdown in interface AmazonOpenSearch

  • getCachedResponseMetadata

    public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

    Description copied from interface: AmazonOpenSearch
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

    Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.

    Specified by:

    getCachedResponseMetadata in interface AmazonOpenSearch

    Parameters:

    request - The originally executed request.

    Returns:

    The response metadata for the specified request, or null if none is available.