Client

opensearchservice

R Documentation

Amazon OpenSearch Service¶

Description¶

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.

Usage¶

opensearchservice(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - 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⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- 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

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

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.

Service syntax¶

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",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

accept_inbound_connection: Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request
add_data_source: Creates a new direct-query data source to the specified domain
add_tags: Attaches tags to an existing Amazon OpenSearch Service domain
associate_package: Associates a package with an Amazon OpenSearch Service domain
authorize_vpc_endpoint_access: Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint
cancel_service_software_update: Cancels a scheduled service software update for an Amazon OpenSearch Service domain
create_domain: Creates an Amazon OpenSearch Service domain
create_outbound_connection: Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain
create_package: Creates a package for use with Amazon OpenSearch Service domains
create_vpc_endpoint: Creates an Amazon OpenSearch Service-managed VPC endpoint
delete_data_source: Deletes a direct-query data source
delete_domain: Deletes an Amazon OpenSearch Service domain and all of its data
delete_inbound_connection: Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection
delete_outbound_connection: Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection
delete_package: Deletes an Amazon OpenSearch Service package
delete_vpc_endpoint: Deletes an Amazon OpenSearch Service-managed interface VPC endpoint
describe_domain: 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: Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain
describe_domain_change_progress: Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain
describe_domain_config: Returns the configuration of an Amazon OpenSearch Service domain
describe_domain_health: 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: 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: Returns domain configuration information about the specified Amazon OpenSearch Service domains
describe_dry_run_progress: Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain
describe_inbound_connections: Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain
describe_instance_type_limits: Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type
describe_outbound_connections: Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain
describe_packages: Describes all packages available to OpenSearch Service
describe_reserved_instance_offerings: Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region
describe_reserved_instances: Describes the Amazon OpenSearch Service instances that you have reserved in a given Region
describe_vpc_endpoints: Describes one or more Amazon OpenSearch Service-managed VPC endpoints
dissociate_package: Removes a package from the specified Amazon OpenSearch Service domain
get_compatible_versions: Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to
get_data_source: Retrieves information about a direct query data source
get_domain_maintenance_status: The status of the maintenance action
get_package_version_history: 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: Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain
get_upgrade_status: Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain
list_data_sources: Lists direct-query data sources for a specific domain
list_domain_maintenances: A list of maintenance actions for the domain
list_domain_names: Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region
list_domains_for_package: Lists all Amazon OpenSearch Service domains associated with a given package
list_instance_type_details: Lists all instance types and available features for a given OpenSearch or Elasticsearch version
list_packages_for_domain: Lists all packages associated with an Amazon OpenSearch Service domain
list_scheduled_actions: Retrieves a list of configuration changes that are scheduled for a domain
list_tags: Returns all resource tags for an Amazon OpenSearch Service domain
list_versions: Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports
list_vpc_endpoint_access: 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: Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region
list_vpc_endpoints_for_domain: Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain
purchase_reserved_instance_offering: Allows you to purchase Amazon OpenSearch Service Reserved Instances
reject_inbound_connection: Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request
remove_tags: Removes the specified set of tags from an Amazon OpenSearch Service domain
revoke_vpc_endpoint_access: Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint
start_domain_maintenance: Starts the node maintenance process on the data node
start_service_software_update: Schedules a service software update for an Amazon OpenSearch Service domain
update_data_source: Updates a direct-query data source
update_domain_config: Modifies the cluster configuration of the specified Amazon OpenSearch Service domain
update_package: Updates a package for use with Amazon OpenSearch Service domains
update_scheduled_action: Reschedules a planned domain configuration change for a later time
update_vpc_endpoint: Modifies an Amazon OpenSearch Service-managed interface VPC endpoint
upgrade_domain: Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch

Examples¶

## Not run: 
svc <- opensearchservice()
svc$accept_inbound_connection(
  Foo = 123
)

## End(Not run)