Client

elasticsearchservice

R Documentation

Amazon Elasticsearch Service¶

Description¶

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.

Usage¶

elasticsearchservice(
  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 <- elasticsearchservice(
  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¶

Allows the destination domain owner to accept an inbound cross-cluster search connection request
add_tags: Attaches tags to an existing Elasticsearch domain
associate_package: Associates a package with an Amazon ES domain
authorize_vpc_endpoint_access: Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint
cancel_domain_config_change: Cancels a pending configuration change on an Amazon OpenSearch Service domain; Cancels a scheduled service software update for an Amazon ES domain
create_elasticsearch_domain: Creates a new Elasticsearch domain; Creates a new cross-cluster search connection from a source domain to a destination domain
create_package: Create a package for use with Amazon ES domains
create_vpc_endpoint: Creates an Amazon OpenSearch Service-managed VPC endpoint
delete_elasticsearch_domain: Permanently deletes the specified Elasticsearch domain and all of its data
delete_elasticsearch_service_role: 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
delete_package: Delete the package
delete_vpc_endpoint: Deletes an Amazon OpenSearch Service-managed interface VPC endpoint
describe_domain_auto_tunes: Provides scheduled Auto-Tune action details for the Elasticsearch 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_elasticsearch_domain: Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN
describe_elasticsearch_domain_config: Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options
describe_elasticsearch_domains: 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
describe_packages: Describes all packages available to Amazon ES; Lists available reserved Elasticsearch instance offerings; Returns information about reserved Elasticsearch instances for this account
describe_vpc_endpoints: Describes one or more Amazon OpenSearch Service-managed VPC endpoints
dissociate_package: Dissociates a package from the Amazon ES domain
get_compatible_elasticsearch_versions: Returns a list of upgrade compatible Elastisearch versions
get_package_version_history: Returns a list of versions of the package, along with their creation time and commit message
get_upgrade_history: Retrieves the complete history of the last 10 upgrades that were performed on the domain
get_upgrade_status: Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain
list_domain_names: Returns the name of all Elasticsearch domains owned by the current user's account
list_domains_for_package: Lists all Amazon ES domains associated with the package
list_elasticsearch_instance_types: List all Elasticsearch instance types that are supported for given ElasticsearchVersion
list_elasticsearch_versions: List all supported Elasticsearch versions
list_packages_for_domain: Lists all packages associated with the Amazon ES domain
list_tags: Returns all tags for the given Elasticsearch domain
list_vpc_endpoint_access: Retrieves information about each 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 account and Region
list_vpc_endpoints_for_domain: Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain; Allows you to purchase reserved Elasticsearch instances; Allows the destination domain owner to reject an inbound cross-cluster search connection request
remove_tags: Removes the specified set of tags from the specified Elasticsearch domain
revoke_vpc_endpoint_access: Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint; Schedules a service software update for an Amazon ES domain
update_elasticsearch_domain_config: Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances
update_package: Updates a package for use with Amazon ES domains
update_vpc_endpoint: Modifies an Amazon OpenSearch Service-managed interface VPC endpoint
upgrade_elasticsearch_domain: Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version

Examples¶

## Not run: 
svc <- elasticsearchservice()
svc$accept_inbound_cross_cluster_search_connection(
  Foo = 123
)

## End(Not run)