View Source AWS.OpenSearch (aws-elixir v1.0.0)

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.

Summary

Functions

accept_inbound_connection(client, connection_id, input, options \\ [])

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.

add_data_source(client, domain_name, input, options \\ [])

Creates a new direct-query data source to the specified domain.

add_tags(client, input, options \\ [])

Attaches tags to an existing Amazon OpenSearch Service domain.

associate_package(client, domain_name, package_id, input, options \\ [])

Associates a package with an Amazon OpenSearch Service domain.

authorize_vpc_endpoint_access(client, domain_name, input, options \\ [])

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

cancel_domain_config_change(client, domain_name, input, options \\ [])

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

cancel_service_software_update(client, input, options \\ [])

Cancels a scheduled service software update for an Amazon OpenSearch Service domain.

create_domain(client, input, options \\ [])

Creates an Amazon OpenSearch Service domain.

create_outbound_connection(client, input, options \\ [])

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.

create_package(client, input, options \\ [])

Creates a package for use with Amazon OpenSearch Service domains.

create_vpc_endpoint(client, input, options \\ [])

Creates an Amazon OpenSearch Service-managed VPC endpoint.

delete_data_source(client, domain_name, name, input, options \\ [])

Deletes a direct-query data source.

delete_domain(client, domain_name, input, options \\ [])

Deletes an Amazon OpenSearch Service domain and all of its data.

delete_inbound_connection(client, connection_id, input, options \\ [])

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.

delete_outbound_connection(client, connection_id, input, options \\ [])

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.

delete_package(client, package_id, input, options \\ [])

Deletes an Amazon OpenSearch Service package.

delete_vpc_endpoint(client, vpc_endpoint_id, input, options \\ [])

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

describe_domain(client, domain_name, options \\ [])

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

describe_domain_auto_tunes(client, domain_name, options \\ [])

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.

describe_domain_change_progress(client, domain_name, change_id \\ nil, options \\ [])

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.

describe_domain_config(client, domain_name, options \\ [])

Returns the configuration of an Amazon OpenSearch Service domain.

describe_domain_health(client, domain_name, options \\ [])

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

describe_domain_nodes(client, domain_name, options \\ [])

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

describe_domains(client, input, options \\ [])

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 \\ [])

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.

describe_inbound_connections(client, input, options \\ [])

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.

describe_instance_type_limits(client, engine_version, instance_type, domain_name \\ nil, options \\ [])

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

describe_outbound_connections(client, input, options \\ [])

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.

describe_packages(client, input, options \\ [])

Describes all packages available to OpenSearch Service.

describe_reserved_instance_offerings(client, max_results \\ nil, next_token \\ nil, reserved_instance_offering_id \\ nil, options \\ [])

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.

describe_reserved_instances(client, max_results \\ nil, next_token \\ nil, reserved_instance_id \\ nil, options \\ [])

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.

describe_vpc_endpoints(client, input, options \\ [])

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

dissociate_package(client, domain_name, package_id, input, options \\ [])

Removes a package from the specified Amazon OpenSearch Service domain.

get_compatible_versions(client, domain_name \\ nil, options \\ [])

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

get_data_source(client, domain_name, name, options \\ [])

Retrieves information about a direct query data source.

get_domain_maintenance_status(client, domain_name, maintenance_id, options \\ [])

The status of the maintenance action.

get_package_version_history(client, package_id, max_results \\ nil, next_token \\ nil, options \\ [])

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).

get_upgrade_history(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

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

get_upgrade_status(client, domain_name, options \\ [])

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

list_data_sources(client, domain_name, options \\ [])

Lists direct-query data sources for a specific domain.

list_domain_maintenances(client, domain_name, action \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

A list of maintenance actions for the domain.

list_domain_names(client, engine_type \\ nil, options \\ [])

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 \\ [])

Lists all Amazon OpenSearch Service domains associated with a given package.

list_instance_type_details(client, engine_version, domain_name \\ nil, instance_type \\ nil, max_results \\ nil, next_token \\ nil, retrieve_a_zs \\ nil, options \\ [])

Lists 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 \\ [])

Lists all packages associated with an Amazon OpenSearch Service domain.

list_scheduled_actions(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

Retrieves a list of configuration changes that are scheduled for a domain.

list_tags(client, arn, options \\ [])

Returns all resource tags for an Amazon OpenSearch Service domain.

list_versions(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_vpc_endpoint_access(client, domain_name, next_token \\ nil, options \\ [])

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.

list_vpc_endpoints(client, next_token \\ nil, options \\ [])

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 \\ [])

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

metadata()
purchase_reserved_instance_offering(client, input, options \\ [])

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

reject_inbound_connection(client, connection_id, input, options \\ [])

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

remove_tags(client, input, options \\ [])

Removes the specified set of tags from an Amazon OpenSearch Service domain.

revoke_vpc_endpoint_access(client, domain_name, input, options \\ [])

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

start_domain_maintenance(client, domain_name, input, options \\ [])

Starts the node maintenance process on the data node.

start_service_software_update(client, input, options \\ [])

Schedules a service software update for an Amazon OpenSearch Service domain.

update_data_source(client, domain_name, name, input, options \\ [])

Updates a direct-query data source.

update_domain_config(client, domain_name, input, options \\ [])

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

update_package(client, input, options \\ [])

Updates a package for use with Amazon OpenSearch Service domains.

update_scheduled_action(client, domain_name, input, options \\ [])

Reschedules a planned domain configuration change for a later time.

update_vpc_endpoint(client, input, options \\ [])

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

upgrade_domain(client, input, options \\ [])

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

Functions

Link to this function

accept_inbound_connection(client, connection_id, input, options \\ [])

View Source

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 to this function

add_data_source(client, domain_name, input, options \\ [])

View Source

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 to this function

add_tags(client, input, options \\ [])

View Source

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.

Link to this function

associate_package(client, domain_name, package_id, input, options \\ [])

View Source

Associates a package with an Amazon OpenSearch Service domain.

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

Link to this function

authorize_vpc_endpoint_access(client, domain_name, input, options \\ [])

View Source

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

Link to this function

cancel_domain_config_change(client, domain_name, input, options \\ [])

View Source

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

Link to this function

cancel_service_software_update(client, input, options \\ [])

View Source

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 to this function

create_domain(client, input, options \\ [])

View Source

Creates an Amazon OpenSearch Service domain.

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

Link to this function

create_outbound_connection(client, input, options \\ [])

View Source

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 to this function

create_package(client, input, options \\ [])

View Source

Creates a package for use with Amazon OpenSearch Service domains.

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

Link to this function

create_vpc_endpoint(client, input, options \\ [])

View Source

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Link to this function

delete_data_source(client, domain_name, name, input, options \\ [])

View Source

Deletes a direct-query data source.

For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.

Link to this function

delete_domain(client, domain_name, input, options \\ [])

View Source

Deletes an Amazon OpenSearch Service domain and all of its data.

You can't recover a domain after you delete it.

Link to this function

delete_inbound_connection(client, connection_id, input, options \\ [])

View Source

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 to this function

delete_outbound_connection(client, connection_id, input, options \\ [])

View Source

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 to this function

delete_package(client, package_id, input, options \\ [])

View Source

Deletes an Amazon OpenSearch Service package.

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

Link to this function

delete_vpc_endpoint(client, vpc_endpoint_id, input, options \\ [])

View Source

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Link to this function

describe_domain(client, domain_name, options \\ [])

View Source

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

Link to this function

describe_domain_auto_tunes(client, domain_name, options \\ [])

View Source

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 to this function

describe_domain_change_progress(client, domain_name, change_id \\ nil, options \\ [])

View Source

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 to this function

describe_domain_config(client, domain_name, options \\ [])

View Source

Returns the configuration of an Amazon OpenSearch Service domain.

Link to this function

describe_domain_health(client, domain_name, options \\ [])

View Source

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

Link to this function

describe_domain_nodes(client, domain_name, options \\ [])

View Source

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

Link to this function

describe_domains(client, input, options \\ [])

View Source

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

Link to this function

describe_dry_run_progress(client, domain_name, dry_run_id \\ nil, load_dry_run_config \\ nil, options \\ [])

View Source

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 to this function

describe_inbound_connections(client, input, options \\ [])

View Source

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 to this function

describe_instance_type_limits(client, engine_version, instance_type, domain_name \\ nil, options \\ [])

View Source

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

Link to this function

describe_outbound_connections(client, input, options \\ [])

View Source

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 to this function

describe_packages(client, input, options \\ [])

View Source

Describes all packages available to OpenSearch Service.

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

Link to this function

describe_reserved_instance_offerings(client, max_results \\ nil, next_token \\ nil, reserved_instance_offering_id \\ nil, options \\ [])

View Source

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.

For more information, see Reserved Instances in Amazon OpenSearch Service.

Link to this function

describe_reserved_instances(client, max_results \\ nil, next_token \\ nil, reserved_instance_id \\ nil, options \\ [])

View Source

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 to this function

describe_vpc_endpoints(client, input, options \\ [])

View Source

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

Link to this function

dissociate_package(client, domain_name, package_id, input, options \\ [])

View Source

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 to this function

get_compatible_versions(client, domain_name \\ nil, options \\ [])

View Source

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

Link to this function

get_data_source(client, domain_name, name, options \\ [])

View Source

Retrieves information about a direct query data source.

Link to this function

get_domain_maintenance_status(client, domain_name, maintenance_id, options \\ [])

View Source

The status of the maintenance action.

Link to this function

get_package_version_history(client, package_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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 to this function

get_upgrade_history(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

get_upgrade_status(client, domain_name, options \\ [])

View Source

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

Link to this function

list_data_sources(client, domain_name, options \\ [])

View Source

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 to this function

list_domain_maintenances(client, domain_name, action \\ nil, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

View Source

A list of maintenance actions for the domain.

Link to this function

list_domain_names(client, engine_type \\ nil, options \\ [])

View Source

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

Link to this function

list_domains_for_package(client, package_id, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all Amazon OpenSearch Service domains associated with a given package.

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

Link to this function

list_instance_type_details(client, engine_version, domain_name \\ nil, instance_type \\ nil, max_results \\ nil, next_token \\ nil, retrieve_a_zs \\ nil, options \\ [])

View Source

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

Link to this function

list_packages_for_domain(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists all packages associated with an Amazon OpenSearch Service domain.

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

Link to this function

list_scheduled_actions(client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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 to this function

list_tags(client, arn, options \\ [])

View Source

Returns all resource tags for an Amazon OpenSearch Service domain.

For more information, see Tagging Amazon OpenSearch Service domains.

Link to this function

list_versions(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_vpc_endpoint_access(client, domain_name, next_token \\ nil, options \\ [])

View Source

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 to this function

list_vpc_endpoints(client, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_vpc_endpoints_for_domain(client, domain_name, next_token \\ nil, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

purchase_reserved_instance_offering(client, input, options \\ [])

View Source

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Link to this function

reject_inbound_connection(client, connection_id, input, options \\ [])

View Source

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

Link to this function

remove_tags(client, input, options \\ [])

View Source

Removes the specified set of tags from an Amazon OpenSearch Service domain.

For more information, see Tagging Amazon OpenSearch Service domains.

Link to this function

revoke_vpc_endpoint_access(client, domain_name, input, options \\ [])

View Source

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

Link to this function

start_domain_maintenance(client, domain_name, input, options \\ [])

View Source

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 to this function

start_service_software_update(client, input, options \\ [])

View Source

Schedules a service software update for an Amazon OpenSearch Service domain.

For more information, see Service software updates in Amazon OpenSearch Service.

Link to this function

update_data_source(client, domain_name, name, input, options \\ [])

View Source

Updates a direct-query data source.

For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.

Link to this function

update_domain_config(client, domain_name, input, options \\ [])

View Source

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

Link to this function

update_package(client, input, options \\ [])

View Source

Updates a package for use with Amazon OpenSearch Service domains.

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

Link to this function

update_scheduled_action(client, domain_name, input, options \\ [])

View Source

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 to this function

update_vpc_endpoint(client, input, options \\ [])

View Source

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Link to this function

upgrade_domain(client, input, options \\ [])

View Source

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