AWS.Elasticsearch (aws-elixir v0.8.0) View Source

Amazon Elasticsearch Configuration Service

Use the Amazon Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch 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 Regions and Endpoints.

Link to this section Summary

Functions

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

Attaches tags to an existing Elasticsearch domain.

Associates a package with an Amazon ES domain.

Cancels a scheduled service software update for an Amazon ES domain.

Creates a new Elasticsearch domain.

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

Create a package for use with Amazon ES domains.

Permanently deletes the specified Elasticsearch domain and all of its data.

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.

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

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

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.

Lists all the inbound cross-cluster search connections for a destination domain.

Lists all the outbound cross-cluster search connections for a source domain.

Describes all packages available to Amazon ES.

Dissociates a package from the Amazon ES domain.

Returns a list of upgrade compatible Elastisearch versions.

Returns a list of versions of the package, along with their creation time and commit message.

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

Returns the name of all Elasticsearch domains owned by the current user's account.

Returns all tags for the given Elasticsearch domain.

Allows you to purchase reserved Elasticsearch instances.

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Removes the specified set of tags from the specified Elasticsearch domain.

Schedules a service software update for an Amazon ES domain.

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Updates a package for use with Amazon ES domains.

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Link to this section Functions

Link to this function

accept_inbound_cross_cluster_search_connection(client, cross_cluster_search_connection_id, input, options \\ [])

View Source

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

Link to this function

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

View Source

Attaches tags to an existing Elasticsearch domain.

Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

Link to this function

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

View Source

Associates a package with an Amazon ES domain.

Link to this function

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

View Source

Cancels a scheduled service software update for an Amazon ES domain.

You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

Link to this function

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

View Source

Creates a new Elasticsearch domain.

For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Link to this function

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

View Source

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

Link to this function

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

View Source

Create a package for use with Amazon ES domains.

Link to this function

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

View Source

Permanently deletes the specified Elasticsearch domain and all of its data.

Once a domain is deleted, it cannot be recovered.

Link to this function

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

View Source

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains.

Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

Link to this function

delete_inbound_cross_cluster_search_connection(client, cross_cluster_search_connection_id, input, options \\ [])

View Source

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

Link to this function

delete_outbound_cross_cluster_search_connection(client, cross_cluster_search_connection_id, input, options \\ [])

View Source

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

Link to this function

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

View Source

Delete the package.

Link to this function

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

View Source

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

Link to this function

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

View Source

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Link to this function

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

View Source

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

Link to this function

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

View Source

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Link to this function

describe_elasticsearch_instance_type_limits(client, elasticsearch_version, instance_type, domain_name \\ nil, options \\ [])

View Source

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion.

When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

Link to this function

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

View Source

Lists all the inbound cross-cluster search connections for a destination domain.

Link to this function

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

View Source

Lists all the outbound cross-cluster search connections for a source domain.

Link to this function

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

View Source

Describes all packages available to Amazon ES.

Includes options for filtering, limiting the number of results, and pagination.

Link to this function

describe_reserved_elasticsearch_instance_offerings(client, max_results \\ nil, next_token \\ nil, reserved_elasticsearch_instance_offering_id \\ nil, options \\ [])

View Source

Lists available reserved Elasticsearch instance offerings.

Link to this function

describe_reserved_elasticsearch_instances(client, max_results \\ nil, next_token \\ nil, reserved_elasticsearch_instance_id \\ nil, options \\ [])

View Source

Returns information about reserved Elasticsearch instances for this account.

Link to this function

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

View Source

Dissociates a package from the Amazon ES domain.

Link to this function

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

View Source

Returns a list of upgrade compatible Elastisearch versions.

You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

Link to this function

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

View Source

Returns a list of versions of the package, along with their creation time and commit message.

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 that were performed on the domain.

Link to this function

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

View Source

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

Link to this function

list_domain_names(client, options \\ [])

View Source

Returns the name of all Elasticsearch domains owned by the current user's account.

Link to this function

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

View Source

Lists all Amazon ES domains associated with the package.

Link to this function

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

View Source

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Link to this function

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

View Source

List all supported Elasticsearch versions

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 the Amazon ES domain.

Link to this function

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

View Source

Returns all tags for the given Elasticsearch domain.

Link to this function

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

View Source

Allows you to purchase reserved Elasticsearch instances.

Link to this function

reject_inbound_cross_cluster_search_connection(client, cross_cluster_search_connection_id, input, options \\ [])

View Source

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Link to this function

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

View Source

Removes the specified set of tags from the specified Elasticsearch domain.

Link to this function

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

View Source

Schedules a service software update for an Amazon ES domain.

Link to this function

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

View Source

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Link to this function

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

View Source

Updates a package for use with Amazon ES domains.

Link to this function

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

View Source

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.