A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://docs.aws.amazon.com/sdkforruby/api/Aws/ElasticsearchService/Client.html below:

Client — AWS SDK for Ruby V2

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::ElasticsearchService::Client Overview

An API client for Amazon Elasticsearch Service. To construct a client, you need to configure a :region and :credentials.

elasticsearchservice = Aws::ElasticsearchService::Client.new(
  region: region_name,
  credentials: credentials,
  )

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

creds = YAML.load(File.read('/path/to/secrets'))

Aws::ElasticsearchService::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse Instance Attribute Summary Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse API Operations collapse Instance Method Summary collapse Methods inherited from Seahorse::Client::Base

add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Instance Method Details #add_tags(options = {}) ⇒ Struct #cancel_elasticsearch_service_software_update(options = {}) ⇒ Types::CancelElasticsearchServiceSoftwareUpdateResponse

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

#delete_elasticsearch_domain(options = {}) ⇒ Types::DeleteElasticsearchDomainResponse

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

#delete_elasticsearch_service_role(options = {}) ⇒ Struct

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

#describe_elasticsearch_domain(options = {}) ⇒ Types::DescribeElasticsearchDomainResponse

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

#describe_elasticsearch_domain_config(options = {}) ⇒ Types::DescribeElasticsearchDomainConfigResponse

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(options = {}) ⇒ Types::DescribeElasticsearchDomainsResponse

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

#describe_packages(options = {}) ⇒ Types::DescribePackagesResponse

Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.

#get_upgrade_status(options = {}) ⇒ Types::GetUpgradeStatusResponse

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

#remove_tags(options = {}) ⇒ Struct

Removes the specified set of tags from the specified Elasticsearch domain.

#update_elasticsearch_domain_config(options = {}) ⇒ Types::UpdateElasticsearchDomainConfigResponse

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

#upgrade_elasticsearch_domain(options = {}) ⇒ Types::UpgradeElasticsearchDomainResponse

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Waiters polls an API operation until a resource enters a desired state.

Basic Usage

Waiters will poll until they are succesful, they fail by entering a terminal state, or until a maximum number of attempts are made.

# polls in a loop, sleeping between attempts client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You configure waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end
Callbacks

You can be notified before each polling attempt and before each delay. If you throw :success or :failure from these callbacks, it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end
Handling Errors

When a waiter is successful, it returns true. When a waiter fails, it raises an error. All errors raised extend from Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end
#waiter_names ⇒ Array<Symbol>

Returns the list of supported waiters. The following table lists the supported waiters and the client method they call:

Waiter Name Client Method Default Delay: Default Max Attempts:

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4