View Source AWS.OpenSearch (aws-elixir v0.13.1)
Amazon OpenSearch Configuration Service
Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon 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 Regions and Endpoints.
Link to this section Summary
Functions
Allows the remote domain owner to accept an inbound cross-cluster connection request.
Attaches tags to an existing domain.
Associates a package with an Amazon OpenSearch Service domain.
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
Creates a new Amazon OpenSearch Service domain.
Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
Create a package for use with Amazon OpenSearch Service domains.
Permanently deletes the specified domain and all of its data.
Allows the remote domain owner to delete an existing inbound cross-cluster connection.
Allows the local domain owner to delete an existing outbound cross-cluster connection.
Deletes the package.
Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
Lists all the inbound cross-cluster connections for a remote domain.
Describe the limits for a given instance type and OpenSearch or Elasticsearch version.
Lists all the outbound cross-cluster connections for a local domain.
Describes all packages available to Amazon OpenSearch Service domains.
Lists available reserved OpenSearch instance offerings.
Returns information about reserved OpenSearch instances for this account.
Dissociates a package from the Amazon OpenSearch Service domain.
Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch.
Returns a list of package versions, along with their creation time and commit message.
Retrieves the complete history of the last 10 upgrades performed on the domain.
Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
Returns the names of all domains owned by the current user's account.
Lists all Amazon OpenSearch Service domains associated with the package.
Lists all packages associated with the Amazon OpenSearch Service domain.
Returns all tags for the given domain.
List all supported versions of OpenSearch and Elasticsearch.
Allows you to purchase reserved OpenSearch instances.
Allows the remote domain owner to reject an inbound cross-cluster connection request.
Removes the specified set of tags from the given domain.
Schedules a service software update for an Amazon OpenSearch Service domain.
Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
Updates a package for use with Amazon OpenSearch Service domains.
Allows you to either upgrade your 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 remote domain owner to accept an inbound cross-cluster connection request.
Attaches tags to an existing domain.
Tags are a set of case-sensitive key value pairs. An domain can have up to 10 tags. See Tagging Amazon OpenSearch Service domains for more information.
associate_package(client, domain_name, package_id, input, options \\ [])
View SourceAssociates a package with an Amazon OpenSearch Service domain.
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
You can only perform this operation before the AutomatedUpdateDate
and when
the UpdateStatus
is in the PENDING_UPDATE
state.
Creates a new Amazon OpenSearch Service domain.
For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.
Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.
Create a package for use with Amazon OpenSearch Service domains.
Permanently deletes the specified domain and all of its data.
Once a domain is deleted, it cannot be recovered.
delete_inbound_connection(client, connection_id, input, options \\ [])
View SourceAllows the remote domain owner to delete an existing inbound cross-cluster connection.
delete_outbound_connection(client, connection_id, input, options \\ [])
View SourceAllows the local domain owner to delete an existing outbound cross-cluster connection.
Deletes the package.
Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN.
Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.
describe_domain_change_progress(client, domain_name, change_id \\ nil, options \\ [])
View SourceReturns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.
Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN.
Lists all the inbound cross-cluster connections for a remote domain.
describe_instance_type_limits( client, engine_version, instance_type, domain_name \\ nil, options \\ [] )
View SourceDescribe the limits for a given instance type and OpenSearch or Elasticsearch version.
When modifying an existing domain, specify the DomainName
to see which
limits you can modify.
Lists all the outbound cross-cluster connections for a local domain.
Describes all packages available to Amazon OpenSearch Service domains.
Includes options for filtering, limiting the number of results, and pagination.
describe_reserved_instance_offerings( client, max_results \\ nil, next_token \\ nil, reserved_instance_offering_id \\ nil, options \\ [] )
View SourceLists available reserved OpenSearch instance offerings.
describe_reserved_instances( client, max_results \\ nil, next_token \\ nil, reserved_instance_id \\ nil, options \\ [] )
View SourceReturns information about reserved OpenSearch instances for this account.
dissociate_package(client, domain_name, package_id, input, options \\ [])
View SourceDissociates a package from the Amazon OpenSearch Service domain.
get_compatible_versions(client, domain_name \\ nil, options \\ [])
View SourceReturns a list of upgrade-compatible versions of OpenSearch/Elasticsearch.
You can optionally pass a DomainName
to get all upgrade-compatible
versions of OpenSearch/Elasticsearch for that specific domain.
get_package_version_history( client, package_id, max_results \\ nil, next_token \\ nil, options \\ [] )
View SourceReturns a list of package versions, along with their creation time and commit message.
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 the domain.
Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.
Returns the names of all domains owned by the current user's account.
list_domains_for_package(client, package_id, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceLists all Amazon OpenSearch Service domains associated with the package.
list_instance_type_details( client, engine_version, domain_name \\ nil, max_results \\ nil, next_token \\ nil, options \\ [] )
View Sourcelist_packages_for_domain( client, domain_name, max_results \\ nil, next_token \\ nil, options \\ [] )
View SourceLists all packages associated with the Amazon OpenSearch Service domain.
Returns all tags for the given domain.
list_versions(client, max_results \\ nil, next_token \\ nil, options \\ [])
View SourceList all supported versions of OpenSearch and Elasticsearch.
Allows you to purchase reserved OpenSearch instances.
reject_inbound_connection(client, connection_id, input, options \\ [])
View SourceAllows the remote domain owner to reject an inbound cross-cluster connection request.
Removes the specified set of tags from the given domain.
Schedules a service software update for an Amazon OpenSearch Service domain.
Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances.
Updates a package for use with Amazon OpenSearch Service domains.
Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.