Package-level declarations

Types

Link copied to clipboard

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Inherited functions

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Adds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.

Link copied to clipboard
inline suspend fun OpenSearchClient.addTags(crossinline block: AddTagsRequest.Builder.() -> Unit): AddTagsResponse

Attaches tags to an existing Amazon OpenSearch Service domain, data source, or application.

Link copied to clipboard

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

Link copied to clipboard

Operation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Creates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Link copied to clipboard

Deletes a specified OpenSearch application.

Link copied to clipboard

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

Link copied to clipboard

Deletes a previously configured direct query data source from Amazon OpenSearch Service.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

Returns the configuration of an Amazon OpenSearch Service domain.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Dissociates multiple packages from a domain simulatneously.

Link copied to clipboard

Retrieves the configuration and status of an existing OpenSearch application.

Link copied to clipboard

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

Link copied to clipboard

Retrieves information about a direct query data source.

Link copied to clipboard

Returns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.

Link copied to clipboard

The status of the maintenance action.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists all OpenSearch applications under your account.

Link copied to clipboard

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.

Link copied to clipboard

Lists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.

Link copied to clipboard

A list of maintenance actions for the domain.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard
inline suspend fun OpenSearchClient.listTags(crossinline block: ListTagsRequest.Builder.() -> Unit): ListTagsResponse

Returns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Link copied to clipboard

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

Link copied to clipboard
inline suspend fun OpenSearchClient.removeTags(crossinline block: RemoveTagsRequest.Builder.() -> Unit): RemoveTagsResponse

Removes the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service resources.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

Updates the configuration and settings of an existing OpenSearch application.

Link copied to clipboard

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

Link copied to clipboard

Updates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Updates the scope of a package. Scope of the package defines users who can view and associate a package.

Link copied to clipboard

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.

Link copied to clipboard

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Link copied to clipboard

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

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.