class Aws::ElasticsearchService::Client

See {#initialize} for a full list of supported configuration options.
the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
For details on configuring region and credentials see
)
# …
credentials: credentials,
region: region_name,
client = Aws::ElasticsearchService::Client.new(
An API client for ElasticsearchService. To construct a client, you need to configure a ‘:region` and `:credentials`.

def accept_inbound_cross_cluster_search_connection(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • accept_inbound_cross_cluster_search_connection(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::AcceptInboundCrossClusterSearchConnectionResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :cross_cluster_search_connection_id (required, String) -- 
def accept_inbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:accept_inbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

def add_tags(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • add_tags(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :tag_list (required, Array) --
  • :arn (required, String) -- 
def add_tags(params = {}, options = {})
  req = build_request(:add_tags, params)
  req.send_request(options)
end

def associate_package(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • associate_package(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::AssociatePackageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) --
  • :package_id (required, String) -- 
def associate_package(params = {}, options = {})
  req = build_request(:associate_package, params)
  req.send_request(options)
end

def authorize_vpc_endpoint_access(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • authorize_vpc_endpoint_access(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::AuthorizeVpcEndpointAccessResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :account (required, String) --
  • :domain_name (required, String) -- 
def authorize_vpc_endpoint_access(params = {}, options = {})
  req = build_request(:authorize_vpc_endpoint_access, params)
  req.send_request(options)
end

def build_request(operation_name, params = {})

Other tags:
    Api: - private

Parameters:
  • params ({}) -- 
def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-elasticsearchservice'
  context[:gem_version] = '1.76.0'
  Seahorse::Client::Request.new(handlers, context)
end

def cancel_elasticsearch_service_software_update(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • cancel_elasticsearch_service_software_update(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CancelElasticsearchServiceSoftwareUpdateResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) -- 
def cancel_elasticsearch_service_software_update(params = {}, options = {})
  req = build_request(:cancel_elasticsearch_service_software_update, params)
  req.send_request(options)
end

def create_elasticsearch_domain(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_elasticsearch_domain(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateElasticsearchDomainResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :tag_list (Array) --
  • :auto_tune_options (Types::AutoTuneOptionsInput) --
  • :advanced_security_options (Types::AdvancedSecurityOptionsInput) --
  • :domain_endpoint_options (Types::DomainEndpointOptions) --
  • :log_publishing_options (Hash) --
  • :advanced_options (Hash) --
  • :node_to_node_encryption_options (Types::NodeToNodeEncryptionOptions) --
  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) --
  • :cognito_options (Types::CognitoOptions) --
  • :vpc_options (Types::VPCOptions) --
  • :snapshot_options (Types::SnapshotOptions) --
  • :access_policies (String) --
  • :ebs_options (Types::EBSOptions) --
  • :elasticsearch_cluster_config (Types::ElasticsearchClusterConfig) --
  • :elasticsearch_version (String) --
  • :domain_name (required, String) -- 
def create_elasticsearch_domain(params = {}, options = {})
  req = build_request(:create_elasticsearch_domain, params)
  req.send_request(options)
end

def create_outbound_cross_cluster_search_connection(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_outbound_cross_cluster_search_connection(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateOutboundCrossClusterSearchConnectionResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :connection_alias (required, String) --
  • :destination_domain_info (required, Types::DomainInformation) --
  • :source_domain_info (required, Types::DomainInformation) -- 
def create_outbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:create_outbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

def create_package(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_package(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreatePackageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :package_source (required, Types::PackageSource) --
  • :package_description (String) --
  • :package_type (required, String) --
  • :package_name (required, String) -- 
def create_package(params = {}, options = {})
  req = build_request(:create_package, params)
  req.send_request(options)
end

def create_vpc_endpoint(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • create_vpc_endpoint(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::CreateVpcEndpointResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :client_token (String) --
  • :vpc_options (required, Types::VPCOptions) --
  • :domain_arn (required, String) -- 
def create_vpc_endpoint(params = {}, options = {})
  req = build_request(:create_vpc_endpoint, params)
  req.send_request(options)
end

def delete_elasticsearch_domain(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_elasticsearch_domain(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DeleteElasticsearchDomainResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) -- 
def delete_elasticsearch_domain(params = {}, options = {})
  req = build_request(:delete_elasticsearch_domain, params)
  req.send_request(options)
end

def delete_elasticsearch_service_role(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_elasticsearch_service_role(params = {})

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}. 
def delete_elasticsearch_service_role(params = {}, options = {})
  req = build_request(:delete_elasticsearch_service_role, params)
  req.send_request(options)
end

def delete_inbound_cross_cluster_search_connection(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_inbound_cross_cluster_search_connection(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DeleteInboundCrossClusterSearchConnectionResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :cross_cluster_search_connection_id (required, String) -- 
def delete_inbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:delete_inbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

def delete_outbound_cross_cluster_search_connection(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_outbound_cross_cluster_search_connection(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DeleteOutboundCrossClusterSearchConnectionResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :cross_cluster_search_connection_id (required, String) -- 
def delete_outbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:delete_outbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

def delete_package(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_package(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DeletePackageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :package_id (required, String) -- 
def delete_package(params = {}, options = {})
  req = build_request(:delete_package, params)
  req.send_request(options)
end

def delete_vpc_endpoint(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • delete_vpc_endpoint(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DeleteVpcEndpointResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :vpc_endpoint_id (required, String) -- 
def delete_vpc_endpoint(params = {}, options = {})
  req = build_request(:delete_vpc_endpoint, params)
  req.send_request(options)
end

def describe_domain_auto_tunes(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_domain_auto_tunes(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeDomainAutoTunesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :domain_name (required, String) -- 
def describe_domain_auto_tunes(params = {}, options = {})
  req = build_request(:describe_domain_auto_tunes, params)
  req.send_request(options)
end

def describe_domain_change_progress(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_domain_change_progress(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeDomainChangeProgressResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :change_id (String) --
  • :domain_name (required, String) -- 
def describe_domain_change_progress(params = {}, options = {})
  req = build_request(:describe_domain_change_progress, params)
  req.send_request(options)
end

def describe_elasticsearch_domain(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_elasticsearch_domain(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeElasticsearchDomainResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) -- 
def describe_elasticsearch_domain(params = {}, options = {})
  req = build_request(:describe_elasticsearch_domain, params)
  req.send_request(options)
end

def describe_elasticsearch_domain_config(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_elasticsearch_domain_config(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeElasticsearchDomainConfigResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) -- 
def describe_elasticsearch_domain_config(params = {}, options = {})
  req = build_request(:describe_elasticsearch_domain_config, params)
  req.send_request(options)
end

def describe_elasticsearch_domains(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_elasticsearch_domains(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeElasticsearchDomainsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_names (required, Array) -- 
def describe_elasticsearch_domains(params = {}, options = {})
  req = build_request(:describe_elasticsearch_domains, params)
  req.send_request(options)
end

def describe_elasticsearch_instance_type_limits(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_elasticsearch_instance_type_limits(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeElasticsearchInstanceTypeLimitsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :elasticsearch_version (required, String) --
  • :instance_type (required, String) --
  • :domain_name (String) -- 
def describe_elasticsearch_instance_type_limits(params = {}, options = {})
  req = build_request(:describe_elasticsearch_instance_type_limits, params)
  req.send_request(options)
end

def describe_inbound_cross_cluster_search_connections(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_inbound_cross_cluster_search_connections(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeInboundCrossClusterSearchConnectionsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :filters (Array) -- 
def describe_inbound_cross_cluster_search_connections(params = {}, options = {})
  req = build_request(:describe_inbound_cross_cluster_search_connections, params)
  req.send_request(options)
end

def describe_outbound_cross_cluster_search_connections(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_outbound_cross_cluster_search_connections(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeOutboundCrossClusterSearchConnectionsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :filters (Array) -- 
def describe_outbound_cross_cluster_search_connections(params = {}, options = {})
  req = build_request(:describe_outbound_cross_cluster_search_connections, params)
  req.send_request(options)
end

def describe_packages(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_packages(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribePackagesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :filters (Array) -- 
def describe_packages(params = {}, options = {})
  req = build_request(:describe_packages, params)
  req.send_request(options)
end

def describe_reserved_elasticsearch_instance_offerings(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_reserved_elasticsearch_instance_offerings(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeReservedElasticsearchInstanceOfferingsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :reserved_elasticsearch_instance_offering_id (String) -- 
def describe_reserved_elasticsearch_instance_offerings(params = {}, options = {})
  req = build_request(:describe_reserved_elasticsearch_instance_offerings, params)
  req.send_request(options)
end

def describe_reserved_elasticsearch_instances(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_reserved_elasticsearch_instances(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeReservedElasticsearchInstancesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :reserved_elasticsearch_instance_id (String) -- 
def describe_reserved_elasticsearch_instances(params = {}, options = {})
  req = build_request(:describe_reserved_elasticsearch_instances, params)
  req.send_request(options)
end

def describe_vpc_endpoints(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • describe_vpc_endpoints(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DescribeVpcEndpointsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :vpc_endpoint_ids (required, Array) -- 
def describe_vpc_endpoints(params = {}, options = {})
  req = build_request(:describe_vpc_endpoints, params)
  req.send_request(options)
end

def dissociate_package(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • dissociate_package(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::DissociatePackageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) --
  • :package_id (required, String) -- 
def dissociate_package(params = {}, options = {})
  req = build_request(:dissociate_package, params)
  req.send_request(options)
end

def errors_module

Other tags:
    Api: - private 
def errors_module
  Errors
end

def get_compatible_elasticsearch_versions(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_compatible_elasticsearch_versions(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetCompatibleElasticsearchVersionsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (String) -- 
def get_compatible_elasticsearch_versions(params = {}, options = {})
  req = build_request(:get_compatible_elasticsearch_versions, params)
  req.send_request(options)
end

def get_package_version_history(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_package_version_history(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetPackageVersionHistoryResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :package_id (required, String) -- 
def get_package_version_history(params = {}, options = {})
  req = build_request(:get_package_version_history, params)
  req.send_request(options)
end

def get_upgrade_history(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_upgrade_history(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetUpgradeHistoryResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :domain_name (required, String) -- 
def get_upgrade_history(params = {}, options = {})
  req = build_request(:get_upgrade_history, params)
  req.send_request(options)
end

def get_upgrade_status(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • get_upgrade_status(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::GetUpgradeStatusResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) -- 
def get_upgrade_status(params = {}, options = {})
  req = build_request(:get_upgrade_status, params)
  req.send_request(options)
end

def initialize(*args)

Options Hash: (**options)
  • :ssl_ca_directory (String) -- Full path of the
  • :ssl_ca_bundle (String) -- Full path to the SSL
  • :ssl_verify_peer (Boolean) -- When `true`,
  • :http_wire_trace (Boolean) -- When `true`,
  • :ssl_timeout (Float) -- Sets the SSL timeout
  • :http_continue_timeout (Float) -- The number of
  • :http_idle_timeout (Float) -- The number of
  • :http_read_timeout (Float) -- The default
  • :http_open_timeout (Float) -- The number of
  • :http_proxy (URI::HTTP, String) -- A proxy to send
  • :endpoint_provider (Aws::ElasticsearchService::EndpointProvider) --
  • :validate_params (Boolean) --
  • :use_fips_endpoint (Boolean) --
  • :use_dualstack_endpoint (Boolean) --
  • :token_provider (Aws::TokenProvider) --
  • :stub_responses (Boolean) --
  • :session_token (String) --
  • :secret_access_key (String) --
  • :sdk_ua_app_id (String) --
  • :retry_mode (String) --
  • :retry_max_delay (Integer) --
  • :retry_limit (Integer) --
  • :retry_jitter (Symbol) --
  • :retry_base_delay (Float) --
  • :retry_backoff (Proc) --
  • :request_min_compression_size_bytes (Integer) --
  • :profile (String) --
  • :max_attempts (Integer) --
  • :logger (Logger) --
  • :log_level (Symbol) --
  • :log_formatter (Aws::Log::Formatter) --
  • :ignore_configured_endpoint_urls (Boolean) --
  • :endpoint_discovery (Boolean) --
  • :endpoint_cache_poll_interval (Integer) --
  • :endpoint_cache_max_threads (Integer) --
  • :endpoint_cache_max_entries (Integer) --
  • :endpoint (String) --
  • :disable_request_compression (Boolean) --
  • :disable_host_prefix_injection (Boolean) --
  • :defaults_mode (String) --
  • :correct_clock_skew (Boolean) --
  • :convert_params (Boolean) --
  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) --
  • :client_side_monitoring_port (Integer) --
  • :client_side_monitoring_host (String) --
  • :client_side_monitoring_client_id (String) --
  • :client_side_monitoring (Boolean) --
  • :adaptive_retry_wait_to_fill (Boolean) --
  • :active_endpoint_cache (Boolean) --
  • :access_key_id (String) --
  • :region (required, String) --
  • :credentials (required, Aws::CredentialProvider) --

Other tags:
    See: https://www.awsarchitectureblog.com/2015/03/backoff.html -

Parameters:
  • options (Hash) --

Overloads:
  • initialize(options) 
def initialize(*args)
  super
end

def list_domain_names(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_domain_names(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListDomainNamesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :engine_type (String) -- 
def list_domain_names(params = {}, options = {})
  req = build_request(:list_domain_names, params)
  req.send_request(options)
end

def list_domains_for_package(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_domains_for_package(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListDomainsForPackageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :package_id (required, String) -- 
def list_domains_for_package(params = {}, options = {})
  req = build_request(:list_domains_for_package, params)
  req.send_request(options)
end

def list_elasticsearch_instance_types(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_elasticsearch_instance_types(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListElasticsearchInstanceTypesResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :domain_name (String) --
  • :elasticsearch_version (required, String) -- 
def list_elasticsearch_instance_types(params = {}, options = {})
  req = build_request(:list_elasticsearch_instance_types, params)
  req.send_request(options)
end

def list_elasticsearch_versions(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_elasticsearch_versions(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListElasticsearchVersionsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) -- 
def list_elasticsearch_versions(params = {}, options = {})
  req = build_request(:list_elasticsearch_versions, params)
  req.send_request(options)
end

def list_packages_for_domain(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_packages_for_domain(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListPackagesForDomainResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :max_results (Integer) --
  • :domain_name (required, String) -- 
def list_packages_for_domain(params = {}, options = {})
  req = build_request(:list_packages_for_domain, params)
  req.send_request(options)
end

def list_tags(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_tags(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListTagsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :arn (required, String) -- 
def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
end

def list_vpc_endpoint_access(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_vpc_endpoint_access(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListVpcEndpointAccessResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :domain_name (required, String) -- 
def list_vpc_endpoint_access(params = {}, options = {})
  req = build_request(:list_vpc_endpoint_access, params)
  req.send_request(options)
end

def list_vpc_endpoints(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_vpc_endpoints(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListVpcEndpointsResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) -- 
def list_vpc_endpoints(params = {}, options = {})
  req = build_request(:list_vpc_endpoints, params)
  req.send_request(options)
end

def list_vpc_endpoints_for_domain(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • list_vpc_endpoints_for_domain(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::ListVpcEndpointsForDomainResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :next_token (String) --
  • :domain_name (required, String) -- 
def list_vpc_endpoints_for_domain(params = {}, options = {})
  req = build_request(:list_vpc_endpoints_for_domain, params)
  req.send_request(options)
end

def purchase_reserved_elasticsearch_instance_offering(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • purchase_reserved_elasticsearch_instance_offering(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::PurchaseReservedElasticsearchInstanceOfferingResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :instance_count (Integer) --
  • :reservation_name (required, String) --
  • :reserved_elasticsearch_instance_offering_id (required, String) -- 
def purchase_reserved_elasticsearch_instance_offering(params = {}, options = {})
  req = build_request(:purchase_reserved_elasticsearch_instance_offering, params)
  req.send_request(options)
end

def reject_inbound_cross_cluster_search_connection(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • reject_inbound_cross_cluster_search_connection(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::RejectInboundCrossClusterSearchConnectionResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :cross_cluster_search_connection_id (required, String) -- 
def reject_inbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:reject_inbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

def remove_tags(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • remove_tags(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :tag_keys (required, Array) --
  • :arn (required, String) -- 
def remove_tags(params = {}, options = {})
  req = build_request(:remove_tags, params)
  req.send_request(options)
end

def revoke_vpc_endpoint_access(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • revoke_vpc_endpoint_access(params = {})

Other tags:
    Example: Request syntax with placeholder values -

Returns:
  • (Struct) - Returns an empty {Seahorse::Client::Response response}.

Options Hash: (**params)
  • :account (required, String) --
  • :domain_name (required, String) -- 
def revoke_vpc_endpoint_access(params = {}, options = {})
  req = build_request(:revoke_vpc_endpoint_access, params)
  req.send_request(options)
end

def start_elasticsearch_service_software_update(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • start_elasticsearch_service_software_update(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::StartElasticsearchServiceSoftwareUpdateResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :domain_name (required, String) -- 
def start_elasticsearch_service_software_update(params = {}, options = {})
  req = build_request(:start_elasticsearch_service_software_update, params)
  req.send_request(options)
end

def update_elasticsearch_domain_config(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_elasticsearch_domain_config(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::UpdateElasticsearchDomainConfigResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :dry_run (Boolean) --
  • :auto_tune_options (Types::AutoTuneOptions) --
  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) --
  • :node_to_node_encryption_options (Types::NodeToNodeEncryptionOptions) --
  • :advanced_security_options (Types::AdvancedSecurityOptionsInput) --
  • :domain_endpoint_options (Types::DomainEndpointOptions) --
  • :log_publishing_options (Hash) --
  • :access_policies (String) --
  • :advanced_options (Hash) --
  • :cognito_options (Types::CognitoOptions) --
  • :vpc_options (Types::VPCOptions) --
  • :snapshot_options (Types::SnapshotOptions) --
  • :ebs_options (Types::EBSOptions) --
  • :elasticsearch_cluster_config (Types::ElasticsearchClusterConfig) --
  • :domain_name (required, String) -- 
def update_elasticsearch_domain_config(params = {}, options = {})
  req = build_request(:update_elasticsearch_domain_config, params)
  req.send_request(options)
end

def update_package(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_package(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::UpdatePackageResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :commit_message (String) --
  • :package_description (String) --
  • :package_source (required, Types::PackageSource) --
  • :package_id (required, String) -- 
def update_package(params = {}, options = {})
  req = build_request(:update_package, params)
  req.send_request(options)
end

def update_vpc_endpoint(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • update_vpc_endpoint(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::UpdateVpcEndpointResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :vpc_options (required, Types::VPCOptions) --
  • :vpc_endpoint_id (required, String) -- 
def update_vpc_endpoint(params = {}, options = {})
  req = build_request(:update_vpc_endpoint, params)
  req.send_request(options)
end

def upgrade_elasticsearch_domain(params = {}, options = {})

Parameters:
  • params (Hash) -- ({})

Overloads:
  • upgrade_elasticsearch_domain(params = {})

Other tags:
    Example: Response structure -
    Example: Request syntax with placeholder values -

Returns:
  • (Types::UpgradeElasticsearchDomainResponse) - Returns a {Seahorse::Client::Response response} object which responds to the following methods:

Options Hash: (**params)
  • :perform_check_only (Boolean) --
  • :target_version (required, String) --
  • :domain_name (required, String) -- 
def upgrade_elasticsearch_domain(params = {}, options = {})
  req = build_request(:upgrade_elasticsearch_domain, params)
  req.send_request(options)
end

def waiter_names

Deprecated:

Other tags:
    Api: - private 
def waiter_names
  []
end