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 <a href="https://docs.aws.amazon.com/general/latest/gr/rande.html#service-regions" target="_blank">Regions and Endpoints</a>.
opensearchservice(config = list())A client for the service. You can call the service's operations using
syntax like svc$operation(...), where svc is the name you've assigned
to the client. The available operations are listed in the
Operations section.
Optional configuration of credentials, endpoint, and/or region.
access_key_id: AWS access key ID
secret_access_key: AWS secret access key
session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.
svc <- opensearchservice(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical"
)
)
| accept_inbound_connection | Allows the remote domain owner to accept an inbound cross-cluster connection request |
| add_tags | Attaches tags to an existing domain |
| associate_package | Associates a package with an Amazon OpenSearch Service domain |
| cancel_service_software_update | Cancels a scheduled service software update for an Amazon OpenSearch Service domain |
| create_domain | Creates a new Amazon OpenSearch Service domain |
| create_outbound_connection | Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain |
| create_package | Create a package for use with Amazon OpenSearch Service domains |
| delete_domain | Permanently deletes the specified domain and all of its data |
| delete_inbound_connection | Allows the remote domain owner to delete an existing inbound cross-cluster connection |
| delete_outbound_connection | Allows the local domain owner to delete an existing outbound cross-cluster connection |
| delete_package | Deletes the package |
| describe_domain | Returns domain configuration information about the specified domain, including the domain ID, domain endpoint, and domain ARN |
| describe_domain_auto_tunes | Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date |
| describe_domain_change_progress | Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages |
| describe_domain_config | Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options |
| describe_domains | Returns domain configuration information about the specified domains, including the domain ID, domain endpoint, and domain ARN |
| describe_inbound_connections | Lists all the inbound cross-cluster connections for a remote domain |
| describe_instance_type_limits | Describe the limits for a given instance type and OpenSearch or Elasticsearch version |
| describe_outbound_connections | Lists all the outbound cross-cluster connections for a local domain |
| describe_packages | Describes all packages available to Amazon OpenSearch Service domains |
| describe_reserved_instance_offerings | Lists available reserved OpenSearch instance offerings |
| describe_reserved_instances | Returns information about reserved OpenSearch instances for this account |
| dissociate_package | Dissociates a package from the Amazon OpenSearch Service domain |
| get_compatible_versions | Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch |
| get_package_version_history | Returns a list of package versions, along with their creation time and commit message |
| get_upgrade_history | Retrieves the complete history of the last 10 upgrades performed on the domain |
| get_upgrade_status | Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain |
| list_domain_names | Returns the names of all domains owned by the current user's account |
| list_domains_for_package | Lists all Amazon OpenSearch Service domains associated with the package |
| list_instance_type_details | List instance type details |
| list_packages_for_domain | Lists all packages associated with the Amazon OpenSearch Service domain |
| list_tags | Returns all tags for the given domain |
| list_versions | List all supported versions of OpenSearch and Elasticsearch |
| purchase_reserved_instance_offering | Allows you to purchase reserved OpenSearch instances |
| reject_inbound_connection | Allows the remote domain owner to reject an inbound cross-cluster connection request |
| remove_tags | Removes the specified set of tags from the given domain |
| start_service_software_update | Schedules a service software update for an Amazon OpenSearch Service domain |
| update_domain_config | Modifies the cluster configuration of the specified domain, such as setting the instance type and the number of instances |
| update_package | Updates a package for use with Amazon OpenSearch Service domains |
| upgrade_domain | Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch |
if (FALSE) {
svc <- opensearchservice()
svc$accept_inbound_connection(
Foo = 123
)
}
Run the code above in your browser using DataLab