Learn R Programming

paws.analytics (version 0.1.6)

elasticsearchservice: 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())

Arguments

config

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

Service syntax

svc <- elasticsearchservice(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string"
    ),
    endpoint = "string",
    region = "string"
  )
)

Operations

add_tags Attaches tags to an existing Elasticsearch domain
cancel_elasticsearch_service_software_update Cancels a scheduled service software update for an Amazon ES domain
create_elasticsearch_domain Creates a new Elasticsearch domain
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
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_instance_type_limits Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion
describe_reserved_elasticsearch_instance_offerings Lists available reserved Elasticsearch instance offerings
describe_reserved_elasticsearch_instances Returns information about reserved Elasticsearch instances for this account
get_compatible_elasticsearch_versions Returns a list of upgrade compatible Elastisearch versions
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_elasticsearch_instance_types List all Elasticsearch instance types that are supported for given ElasticsearchVersion
list_elasticsearch_versions List all supported Elasticsearch versions
list_tags Returns all tags for the given Elasticsearch domain
purchase_reserved_elasticsearch_instance_offering Allows you to purchase reserved Elasticsearch instances
remove_tags Removes the specified set of tags from the specified Elasticsearch domain
start_elasticsearch_service_software_update 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

Examples

Run this code
# NOT RUN {
svc <- elasticsearchservice()
svc$add_tags(
  Foo = 123
)
# }
# NOT RUN {
# }

Run the code above in your browser using DataLab