View Source AWS.OpenSearch (aws-elixir v0.13.3)
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.
Link to this section Summary
Functions
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
Attaches tags to an existing Amazon OpenSearch Service domain.
Associates a package with an Amazon OpenSearch Service domain.
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
Creates an Amazon OpenSearch Service domain.
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
Creates a package for use with Amazon OpenSearch Service domains.
Creates an Amazon OpenSearch Service-managed VPC endpoint.
Deletes an Amazon OpenSearch Service domain and all of its data.
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
Deletes an Amazon OpenSearch Service package.
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
Returns the configuration of an Amazon OpenSearch Service domain.
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
Describes all packages available to OpenSearch Service.
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
Removes a package from the specified Amazon OpenSearch Service domain.
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message.
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
Lists all Amazon OpenSearch Service domains associated with a given package.
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
Lists all packages associated with an Amazon OpenSearch Service domain.
Retrieves a list of configuration changes that are scheduled for a domain.
Returns all resource tags for an Amazon OpenSearch Service domain.
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
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.
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
Removes the specified set of tags from an Amazon OpenSearch Service domain.
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
Schedules a service software update for an Amazon OpenSearch Service domain.
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
Updates a package for use with Amazon OpenSearch Service domains.
Reschedules a planned domain configuration change for a later time.
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
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 to this section Functions
accept_inbound_connection(client, connection_id, input, options \\ [])
View SourceAllows 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.
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.
associate_package(client, domain_name, package_id, input, options \\ [])
View SourceAssociates a package with an Amazon OpenSearch Service domain.
For more information, see Custom packages for Amazon OpenSearch Service.
authorize_vpc_endpoint_access(client, domain_name, input, options \\ [])
View SourceProvides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
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.
Creates an Amazon OpenSearch Service domain.
For more information, see Creating and managing Amazon OpenSearch Service domains.
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.
Creates a package for use with Amazon OpenSearch Service domains.
For more information, see Custom packages for Amazon OpenSearch Service.
Creates an Amazon OpenSearch Service-managed VPC endpoint.
Deletes an Amazon OpenSearch Service domain and all of its data.
You can't recover a domain after you delete it.
delete_inbound_connection(client, connection_id, input, options \\ [])
View SourceAllows 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.
delete_outbound_connection(client, connection_id, input, options \\ [])
View SourceAllows 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.
Deletes an Amazon OpenSearch Service package.
For more information, see Custom packages for Amazon OpenSearch Service.
delete_vpc_endpoint(client, vpc_endpoint_id, input, options \\ [])
View SourceDeletes an Amazon OpenSearch Service-managed interface VPC endpoint.
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
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.
describe_domain_change_progress(client, domain_name, change_id \\ nil, options \\ [])
View SourceReturns 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.
Returns the configuration of an Amazon OpenSearch Service domain.
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
describe_dry_run_progress(client, domain_name, dry_run_id \\ nil, load_dry_run_config \\ nil, options \\ [])
View SourceDescribes 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.
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.
describe_instance_type_limits(client, engine_version, instance_type, domain_name \\ nil, options \\ [])
View SourceDescribes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
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.
Describes all packages available to OpenSearch Service.
For more information, see Custom packages for Amazon OpenSearch Service.
describe_reserved_instance_offerings(client, max_results \\ nil, next_token \\ nil, reserved_instance_offering_id \\ nil, options \\ [])
View SourceDescribes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
For more information, see Reserved Instances in Amazon OpenSearch Service.
describe_reserved_instances(client, max_results \\ nil, next_token \\ nil, reserved_instance_id \\ nil, options \\ [])
View SourceDescribes the Amazon OpenSearch Service instances that you have reserved in a given Region.
For more information, see Reserved Instances in Amazon OpenSearch Service.
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
dissociate_package(client, domain_name, package_id, input, options \\ [])
View SourceRemoves 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.
get_compatible_versions(client, domain_name \\ nil, options \\ [])
View SourceReturns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
get_package_version_history(client, package_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceReturns 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.
get_upgrade_history(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
list_domains_for_package(client, package_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all Amazon OpenSearch Service domains associated with a given package.
For more information, see Custom packages for Amazon OpenSearch Service.
list_instance_type_details(client, engine_version, domain_name \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all instance types and available features for a given OpenSearch or Elasticsearch version.
list_packages_for_domain(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all packages associated with an Amazon OpenSearch Service domain.
For more information, see Custom packages for Amazon OpenSearch Service.
list_scheduled_actions(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceRetrieves a list of configuration changes that are scheduled for a domain.
These changes can be service software updates or blue/green Auto-Tune enhancements.
Returns all resource tags for an Amazon OpenSearch Service domain.
For more information, see Tagging Amazon OpenSearch Service domains.
list_versions(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
list_vpc_endpoint_access(client, domain_name, next_token \\ nil, options \\ [])
View SourceRetrieves 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.
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
list_vpc_endpoints_for_domain(client, domain_name, next_token \\ nil, options \\ [])
View SourceRetrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
reject_inbound_connection(client, connection_id, input, options \\ [])
View SourceAllows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
Removes the specified set of tags from an Amazon OpenSearch Service domain.
For more information, see Tagging Amazon OpenSearch Service domains.
revoke_vpc_endpoint_access(client, domain_name, input, options \\ [])
View SourceRevokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
Schedules a service software update for an Amazon OpenSearch Service domain.
For more information, see Service software updates in Amazon OpenSearch Service.
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
Updates a package for use with Amazon OpenSearch Service domains.
For more information, see Custom packages for Amazon OpenSearch Service.
update_scheduled_action(client, domain_name, input, options \\ [])
View SourceReschedules 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.
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.