Class: Aws::ElasticsearchService::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb

Overview

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

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

For details on configuring region and credentials see the developer guide.

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :plugins (Array<Seahorse::Client::Plugin>) — default: []] —

    A list of plugins to apply to the client. Each plugin is either a class name or an instance of a plugin class.

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials used for authentication. This can be any class that includes and implements Aws::CredentialProvider, or instance of any one of the following classes:

    • Aws::Credentials - Used for configuring static, non-refreshing credentials.

    • Aws::SharedCredentials - Used for loading static credentials from a shared file, such as ~/.aws/config.

    • Aws::AssumeRoleCredentials - Used when you need to assume a role.

    • Aws::AssumeRoleWebIdentityCredentials - Used when you need to assume a role after providing credentials via the web.

    • Aws::SSOCredentials - Used for loading credentials from AWS SSO using an access token generated from aws login.

    • Aws::ProcessCredentials - Used for loading credentials from a process that outputs to stdout.

    • Aws::InstanceProfileCredentials - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • Aws::ECSCredentials - Used for loading credentials from instances running in ECS.

    • Aws::CognitoIdentityCredentials - Used for loading credentials from the Cognito Identity service.

    When :credentials are not configured directly, the following locations will be searched for credentials:

    • Aws.config[:credentials]

    • The :access_key_id, :secret_access_key, :session_token, and :account_id options.

    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID'].

    • ~/.aws/credentials

    • ~/.aws/config

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.

  • :region (required, String) —

    The AWS region to connect to. The configured :region is used to determine the service :endpoint. When not passed, a default :region is searched for in the following locations:

    • Aws.config[:region]
    • ENV['AWS_REGION']
    • ENV['AMAZON_REGION']
    • ENV['AWS_DEFAULT_REGION']
    • ~/.aws/credentials
    • ~/.aws/config
  • :access_key_id (String)
  • :account_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to true, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to false.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in adaptive retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a RetryCapacityNotAvailableError and will not retry instead of sleeping.

  • :auth_scheme_preference (Array<String>) —

    A list of preferred authentication schemes to use when making a request. Supported values are: sigv4, sigv4a, httpBearerAuth, and noAuth. When set using ENV['AWS_AUTH_SCHEME_PREFERENCE'] or in shared config as auth_scheme_preference, the value should be a comma-separated list.

  • :client_side_monitoring (Boolean) — default: false —

    When true, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When true, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in standard and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :defaults_mode (String) — default: "legacy" —

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false —

    When true, the SDK will not prepend the modeled host prefix to the endpoint.

  • :disable_request_compression (Boolean) — default: false —

    When set to 'true' the request body will not be compressed for supported operations.

  • :endpoint (String, URI::HTTPS, URI::HTTP) —

    Normally you should not configure the :endpoint option directly. This is normally constructed from the :region option. Configuring :endpoint is normally reserved for connecting to test or custom endpoints. The endpoint should be a URI formatted like:

    'http://example.com'
'https://example.com'
'http://example.com:123'
  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    When :endpoint_discovery and :active_endpoint_cache is enabled, Use this option to config the time interval in seconds for making requests fetching endpoints information. Defaults to 60 sec.

  • :endpoint_discovery (Boolean) — default: false —

    When set to true, endpoint discovery will be enabled for operations when available.

  • :ignore_configured_endpoint_urls (Boolean) —

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the :logger at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in standard and adaptive retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, 'default' is used.

  • :request_checksum_calculation (String) — default: "when_supported" —

    Determines when a checksum will be calculated for request payloads. Values are:

    • when_supported - (default) When set, a checksum will be calculated for all request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true and/or a requestAlgorithmMember is modeled.
    • when_required - When set, a checksum will only be calculated for request payloads of operations modeled with the httpChecksum trait where requestChecksumRequired is true or where a requestAlgorithmMember is modeled and supplied.
  • :request_min_compression_size_bytes (Integer) — default: 10240 —

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

  • :response_checksum_validation (String) — default: "when_supported" —

    Determines when checksum validation will be performed on response payloads. Values are:

    • when_supported - (default) When set, checksum validation is performed on all response payloads of operations modeled with the httpChecksum trait where responseAlgorithms is modeled, except when no modeled checksum algorithms are supported.
    • when_required - When set, checksum validation is not performed on response payloads of operations unless the checksum algorithm is supported and the requestValidationModeMember member is set to ENABLED.
  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the legacy retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the legacy retry mode.

    @see https://www.awsarchitectureblog.com/2015/03/backoff.html

  • :retry_limit (Integer) — default: 3 —

    The maximum number of times to retry failed requests. Only ~ 500 level server errors and certain ~ 400 level client errors are retried. Generally, these are throttling errors, data checksum errors, networking errors, timeout errors, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the legacy retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the legacy retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • legacy - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • standard - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • adaptive - An experimental retry mode that includes all the functionality of standard mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :sdk_ua_app_id (String) —

    A unique and opaque application ID that is appended to the User-Agent header as app/sdk_ua_app_id. It should have a maximum length of 50. This variable is sourced from environment variable AWS_SDK_UA_APP_ID or the shared config profile attribute sdk_ua_app_id.

  • :secret_access_key (String)
  • :session_token (String)
  • :sigv4a_signing_region_set (Array) —

    A list of regions that should be signed with SigV4a signing. When not passed, a default :sigv4a_signing_region_set is searched for in the following locations:

    • Aws.config[:sigv4a_signing_region_set]
    • ENV['AWS_SIGV4A_SIGNING_REGION_SET']
    • ~/.aws/config
  • :stub_responses (Boolean) — default: false —

    Causes the client to return stubbed responses. By default fake responses are generated and returned. You can specify the response data to return or errors to raise by calling ClientStubs#stub_responses. See ClientStubs for more information.

    Please note When response stubbing is enabled, no HTTP requests are made, and retries are disabled.

  • :telemetry_provider (Aws::Telemetry::TelemetryProviderBase) — default: Aws::Telemetry::NoOpTelemetryProvider —

    Allows you to provide a telemetry provider, which is used to emit telemetry data. By default, uses NoOpTelemetryProvider which will not record or emit any telemetry data. The SDK supports the following telemetry providers:

    • OpenTelemetry (OTel) - To use the OTel provider, install and require the opentelemetry-sdk gem and then, pass in an instance of a Aws::Telemetry::OTelProvider for telemetry provider.
  • :token_provider (Aws::TokenProvider) —

    Your Bearer token used for authentication. This can be any class that includes and implements Aws::TokenProvider, or instance of any one of the following classes:

    • Aws::StaticTokenProvider - Used for configuring static, non-refreshing tokens.

    • Aws::SSOTokenProvider - Used for loading tokens from AWS SSO using an access token generated from aws login.

    When :token_provider is not configured directly, the Aws::TokenProviderChain will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean) —

    When set to true, dualstack enabled endpoints (with .aws TLD) will be used if available.

  • :use_fips_endpoint (Boolean) —

    When set to true, fips compatible endpoints will be used if available. When a fips region is used, the region is normalized and this config is set to true.

  • :validate_params (Boolean) — default: true —

    When true, request parameters are validated before sending the request.

  • :endpoint_provider (Aws::ElasticsearchService::EndpointProvider) —

    The endpoint provider used to resolve endpoints. Any object that responds to #resolve_endpoint(parameters) where parameters is a Struct similar to Aws::ElasticsearchService::EndpointParameters.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has "Expect" header set to "100-continue". Defaults to nil which disables this behaviour. This value can safely be set per request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_open_timeout (Float) — default: 15 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like 'http://proxy.com:123'.

  • :http_read_timeout (Float) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When true, HTTP debug output will be sent to the :logger.

  • :on_chunk_received (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the response body is received. It provides three arguments: the chunk, the number of bytes received, and the total number of bytes in the response (or nil if the server did not send a content-length).

  • :on_chunk_sent (Proc) —

    When a Proc object is provided, it will be used as callback when each chunk of the request body is sent. It provides three arguments: the chunk, the number of bytes read from the body, and the total number of bytes in the body.

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass :ssl_ca_bundle or :ssl_ca_directory the the system default will be used if available.

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

  • :ssl_cert (OpenSSL::X509::Certificate) —

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

    When true, SSL peer certificates are verified when establishing a connection.



473
474
475
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 473

def initialize(*args)
  super
end

Instance Method Details

#accept_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::AcceptInboundCrossClusterSearchConnectionResponse

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

Examples:

Request syntax with placeholder values


resp = client.accept_inbound_cross_cluster_search_connection({
  cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
})

Response structure


resp.cross_cluster_search_connection.source_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.source_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.source_domain_info.region #=> String
resp.cross_cluster_search_connection.destination_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.destination_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.destination_domain_info.region #=> String
resp.cross_cluster_search_connection.cross_cluster_search_connection_id #=> String
resp.cross_cluster_search_connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.cross_cluster_search_connection.connection_status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cross_cluster_search_connection_id (required, String) —

    The id of the inbound connection that you want to accept.

Returns:



509
510
511
512
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 509

def accept_inbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:accept_inbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

#add_tags(params = {}) ⇒ Struct

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.

Examples:

Request syntax with placeholder values


resp = client.add_tags({
  arn: "ARN", # required
  tag_list: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    Specify the ARN for which you want to add the tags.

  • :tag_list (required, Array<Types::Tag>) —

    List of Tag that need to be added for the Elasticsearch domain.

Returns:

  • (Struct) —

    Returns an empty response.



545
546
547
548
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 545

def add_tags(params = {}, options = {})
  req = build_request(:add_tags, params)
  req.send_request(options)
end

#associate_package(params = {}) ⇒ Types::AssociatePackageResponse

Associates a package with an Amazon ES domain.

Examples:

Request syntax with placeholder values


resp = client.associate_package({
  package_id: "PackageID", # required
  domain_name: "DomainName", # required
})

Response structure


resp.domain_package_details.package_id #=> String
resp.domain_package_details.package_name #=> String
resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY"
resp.domain_package_details.last_updated #=> Time
resp.domain_package_details.domain_name #=> String
resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
resp.domain_package_details.package_version #=> String
resp.domain_package_details.reference_path #=> String
resp.domain_package_details.error_details.error_type #=> String
resp.domain_package_details.error_details.error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_id (required, String) —

    Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

  • :domain_name (required, String) —

    Name of the domain that you want to associate the package with.

Returns:



585
586
587
588
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 585

def associate_package(params = {}, options = {})
  req = build_request(:associate_package, params)
  req.send_request(options)
end

#authorize_vpc_endpoint_access(params = {}) ⇒ Types::AuthorizeVpcEndpointAccessResponse

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.authorize_vpc_endpoint_access({
  domain_name: "DomainName", # required
  account: "AWSAccount", # required
})

Response structure


resp.authorized_principal.principal_type #=> String, one of "AWS_ACCOUNT", "AWS_SERVICE"
resp.authorized_principal.principal #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the OpenSearch Service domain to provide access to.

  • :account (required, String) —

    The account ID to grant access to.

Returns:



617
618
619
620
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 617

def authorize_vpc_endpoint_access(params = {}, options = {})
  req = build_request(:authorize_vpc_endpoint_access, params)
  req.send_request(options)
end

#cancel_domain_config_change(params = {}) ⇒ Types::CancelDomainConfigChangeResponse

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Examples:

Request syntax with placeholder values


resp = client.cancel_domain_config_change({
  domain_name: "DomainName", # required
  dry_run: false,
})

Response structure


resp.dry_run #=> Boolean
resp.cancelled_change_ids #=> Array
resp.cancelled_change_ids[0] #=> String
resp.cancelled_change_properties #=> Array
resp.cancelled_change_properties[0].property_name #=> String
resp.cancelled_change_properties[0].cancelled_value #=> String
resp.cancelled_change_properties[0].active_value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    Name of the OpenSearch Service domain configuration request to cancel.

  • :dry_run (Boolean) —

    When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.

Returns:



657
658
659
660
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 657

def cancel_domain_config_change(params = {}, options = {})
  req = build_request(:cancel_domain_config_change, params)
  req.send_request(options)
end

#cancel_elasticsearch_service_software_update(params = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.cancel_elasticsearch_service_software_update({
  domain_name: "DomainName", # required
})

Response structure


resp.service_software_options.current_version #=> String
resp.service_software_options.new_version #=> String
resp.service_software_options.update_available #=> Boolean
resp.service_software_options.cancellable #=> Boolean
resp.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.service_software_options.description #=> String
resp.service_software_options.automated_update_date #=> Time
resp.service_software_options.optional_deployment #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain that you want to stop the latest service software update on.

Returns:



693
694
695
696
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 693

def cancel_elasticsearch_service_software_update(params = {}, options = {})
  req = build_request(:cancel_elasticsearch_service_software_update, params)
  req.send_request(options)
end

#create_elasticsearch_domain(params = {}) ⇒ Types::CreateElasticsearchDomainResponse

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Examples:

Request syntax with placeholder values


resp = client.create_elasticsearch_domain({
  domain_name: "DomainName", # required
  elasticsearch_version: "ElasticsearchVersionString",
  elasticsearch_cluster_config: {
    instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
    instance_count: 1,
    dedicated_master_enabled: false,
    zone_awareness_enabled: false,
    zone_awareness_config: {
      availability_zone_count: 1,
    },
    dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
    dedicated_master_count: 1,
    warm_enabled: false,
    warm_type: "ultrawarm1.medium.elasticsearch", # accepts ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch
    warm_count: 1,
    cold_storage_options: {
      enabled: false, # required
    },
  },
  ebs_options: {
    ebs_enabled: false,
    volume_type: "standard", # accepts standard, gp2, io1, gp3
    volume_size: 1,
    iops: 1,
    throughput: 1,
  },
  access_policies: "PolicyDocument",
  snapshot_options: {
    automated_snapshot_start_hour: 1,
  },
  vpc_options: {
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  cognito_options: {
    enabled: false,
    user_pool_id: "UserPoolId",
    identity_pool_id: "IdentityPoolId",
    role_arn: "RoleArn",
  },
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "KmsKeyId",
  },
  node_to_node_encryption_options: {
    enabled: false,
  },
  advanced_options: {
    "String" => "String",
  },
  log_publishing_options: {
    "INDEX_SLOW_LOGS" => {
      cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
      enabled: false,
    },
  },
  domain_endpoint_options: {
    enforce_https: false,
    tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07, Policy-Min-TLS-1-2-PFS-2023-10, Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08
    custom_endpoint_enabled: false,
    custom_endpoint: "DomainNameFqdn",
    custom_endpoint_certificate_arn: "ARN",
  },
  advanced_security_options: {
    enabled: false,
    internal_user_database_enabled: false,
    master_user_options: {
      master_user_arn: "ARN",
      master_user_name: "Username",
      master_user_password: "Password",
    },
    saml_options: {
      enabled: false,
      idp: {
        metadata_content: "SAMLMetadata", # required
        entity_id: "SAMLEntityId", # required
      },
      master_user_name: "Username",
      master_backend_role: "BackendRole",
      subject_key: "String",
      roles_key: "String",
      session_timeout_minutes: 1,
    },
    anonymous_auth_enabled: false,
  },
  auto_tune_options: {
    desired_state: "ENABLED", # accepts ENABLED, DISABLED
    maintenance_schedules: [
      {
        start_at: Time.now,
        duration: {
          value: 1,
          unit: "HOURS", # accepts HOURS
        },
        cron_expression_for_recurrence: "String",
      },
    ],
  },
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  deployment_strategy_options: {
    deployment_strategy: "Default", # required, accepts Default, CapacityOptimized
  },
  automated_snapshot_pause_options: {
    enabled: false, # required
    start_time: Time.now,
    end_time: Time.now,
  },
})

Response structure


resp.domain_status.domain_id #=> String
resp.domain_status.domain_name #=> String
resp.domain_status.arn #=> String
resp.domain_status.created #=> Boolean
resp.domain_status.deleted #=> Boolean
resp.domain_status.endpoint #=> String
resp.domain_status.endpoints #=> Hash
resp.domain_status.endpoints["String"] #=> String
resp.domain_status.processing #=> Boolean
resp.domain_status.upgrade_processing #=> Boolean
resp.domain_status.elasticsearch_version #=> String
resp.domain_status.elasticsearch_cluster_config.instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.instance_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.dedicated_master_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.dedicated_master_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.warm_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.warm_type #=> String, one of "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.warm_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.cold_storage_options.enabled #=> Boolean
resp.domain_status.ebs_options.ebs_enabled #=> Boolean
resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
resp.domain_status.ebs_options.volume_size #=> Integer
resp.domain_status.ebs_options.iops #=> Integer
resp.domain_status.ebs_options.throughput #=> Integer
resp.domain_status.access_policies #=> String
resp.domain_status.snapshot_options.automated_snapshot_start_hour #=> Integer
resp.domain_status.vpc_options.vpc_id #=> String
resp.domain_status.vpc_options.subnet_ids #=> Array
resp.domain_status.vpc_options.subnet_ids[0] #=> String
resp.domain_status.vpc_options.availability_zones #=> Array
resp.domain_status.vpc_options.availability_zones[0] #=> String
resp.domain_status.vpc_options.security_group_ids #=> Array
resp.domain_status.vpc_options.security_group_ids[0] #=> String
resp.domain_status.cognito_options.enabled #=> Boolean
resp.domain_status.cognito_options.user_pool_id #=> String
resp.domain_status.cognito_options.identity_pool_id #=> String
resp.domain_status.cognito_options.role_arn #=> String
resp.domain_status.encryption_at_rest_options.enabled #=> Boolean
resp.domain_status.encryption_at_rest_options.kms_key_id #=> String
resp.domain_status.node_to_node_encryption_options.enabled #=> Boolean
resp.domain_status.advanced_options #=> Hash
resp.domain_status.advanced_options["String"] #=> String
resp.domain_status.log_publishing_options #=> Hash
resp.domain_status.log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
resp.domain_status.log_publishing_options["LogType"].enabled #=> Boolean
resp.domain_status.service_software_options.current_version #=> String
resp.domain_status.service_software_options.new_version #=> String
resp.domain_status.service_software_options.update_available #=> Boolean
resp.domain_status.service_software_options.cancellable #=> Boolean
resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.domain_status.service_software_options.description #=> String
resp.domain_status.service_software_options.automated_update_date #=> Time
resp.domain_status.service_software_options.optional_deployment #=> Boolean
resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
resp.domain_status.domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10", "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08"
resp.domain_status.domain_endpoint_options.custom_endpoint_enabled #=> Boolean
resp.domain_status.domain_endpoint_options.custom_endpoint #=> String
resp.domain_status.domain_endpoint_options.custom_endpoint_certificate_arn #=> String
resp.domain_status.advanced_security_options.enabled #=> Boolean
resp.domain_status.advanced_security_options.internal_user_database_enabled #=> Boolean
resp.domain_status.advanced_security_options.saml_options.enabled #=> Boolean
resp.domain_status.advanced_security_options.saml_options.idp.metadata_content #=> String
resp.domain_status.advanced_security_options.saml_options.idp.entity_id #=> String
resp.domain_status.advanced_security_options.saml_options.subject_key #=> String
resp.domain_status.advanced_security_options.saml_options.roles_key #=> String
resp.domain_status.advanced_security_options.saml_options.session_timeout_minutes #=> Integer
resp.domain_status.advanced_security_options.anonymous_auth_disable_date #=> Time
resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
resp.domain_status.auto_tune_options.error_message #=> String
resp.domain_status.change_progress_details.change_id #=> String
resp.domain_status.change_progress_details.message #=> String
resp.domain_status.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.domain_status.change_progress_details.start_time #=> Time
resp.domain_status.change_progress_details.last_updated_time #=> Time
resp.domain_status.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE"
resp.domain_status.domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting"
resp.domain_status.modifying_properties #=> Array
resp.domain_status.modifying_properties[0].name #=> String
resp.domain_status.modifying_properties[0].active_value #=> String
resp.domain_status.modifying_properties[0].pending_value #=> String
resp.domain_status.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON"
resp.domain_status.deployment_strategy_options.deployment_strategy #=> String, one of "Default", "CapacityOptimized"
resp.domain_status.automated_snapshot_pause_options.enabled #=> Boolean
resp.domain_status.automated_snapshot_pause_options.start_time #=> Time
resp.domain_status.automated_snapshot_pause_options.end_time #=> Time
resp.domain_status.automated_snapshot_pause_options.state #=> String, one of "Active", "Completed", "Scheduled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • :elasticsearch_version (String) —

    String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

  • :elasticsearch_cluster_config (Types::ElasticsearchClusterConfig) —

    Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

  • :ebs_options (Types::EBSOptions) —

    Options to enable, disable and specify the type and size of EBS storage volumes.

  • :access_policies (String) —

    IAM access policy as a JSON-formatted string.

  • :snapshot_options (Types::SnapshotOptions) —

    Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

  • :vpc_options (Types::VPCOptions) —

    Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

  • :cognito_options (Types::CognitoOptions) —

    Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) —

    Specifies the Encryption At Rest Options.

  • :node_to_node_encryption_options (Types::NodeToNodeEncryptionOptions) —

    Specifies the NodeToNodeEncryptionOptions.

  • :advanced_options (Hash<String,String>) —

    Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

  • :log_publishing_options (Hash<String,Types::LogPublishingOption>) —

    Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

  • :domain_endpoint_options (Types::DomainEndpointOptions) —

    Options to specify configuration that will be applied to the domain endpoint.

  • :advanced_security_options (Types::AdvancedSecurityOptionsInput) —

    Specifies advanced security options.

  • :auto_tune_options (Types::AutoTuneOptionsInput) —

    Specifies Auto-Tune options.

  • :tag_list (Array<Types::Tag>) —

    A list of Tag added during domain creation.

  • :deployment_strategy_options (Types::DeploymentStrategyOptions) —

    Specifies the deployment strategy options.

  • :automated_snapshot_pause_options (Types::AutomatedSnapshotPauseRequestOptions) —

    Specifies the automated snapshot pause options for the domain.

    Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.

    Maximum suspension duration: 3 days.

Returns:



1018
1019
1020
1021
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1018

def create_elasticsearch_domain(params = {}, options = {})
  req = build_request(:create_elasticsearch_domain, params)
  req.send_request(options)
end

#create_outbound_cross_cluster_search_connection(params = {}) ⇒ Types::CreateOutboundCrossClusterSearchConnectionResponse

Creates a new cross-cluster search connection from a source domain to a destination domain.

Examples:

Request syntax with placeholder values


resp = client.create_outbound_cross_cluster_search_connection({
  source_domain_info: { # required
    owner_id: "OwnerId",
    domain_name: "DomainName", # required
    region: "Region",
  },
  destination_domain_info: { # required
    owner_id: "OwnerId",
    domain_name: "DomainName", # required
    region: "Region",
  },
  connection_alias: "ConnectionAlias", # required
})

Response structure


resp.source_domain_info.owner_id #=> String
resp.source_domain_info.domain_name #=> String
resp.source_domain_info.region #=> String
resp.destination_domain_info.owner_id #=> String
resp.destination_domain_info.domain_name #=> String
resp.destination_domain_info.region #=> String
resp.connection_alias #=> String
resp.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "VALIDATING", "VALIDATION_FAILED", "PROVISIONING", "ACTIVE", "REJECTED", "DELETING", "DELETED"
resp.connection_status.message #=> String
resp.cross_cluster_search_connection_id #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :source_domain_info (required, Types::DomainInformation) —

    Specifies the DomainInformation for the source Elasticsearch domain.

  • :destination_domain_info (required, Types::DomainInformation) —

    Specifies the DomainInformation for the destination Elasticsearch domain.

  • :connection_alias (required, String) —

    Specifies the connection alias that will be used by the customer for this connection.

Returns:



1076
1077
1078
1079
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1076

def create_outbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:create_outbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

#create_package(params = {}) ⇒ Types::CreatePackageResponse

Create a package for use with Amazon ES domains.

Examples:

Request syntax with placeholder values


resp = client.create_package({
  package_name: "PackageName", # required
  package_type: "TXT-DICTIONARY", # required, accepts TXT-DICTIONARY
  package_description: "PackageDescription",
  package_source: { # required
    s3_bucket_name: "S3BucketName",
    s3_key: "S3Key",
  },
})

Response structure


resp.package_details.package_id #=> String
resp.package_details.package_name #=> String
resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
resp.package_details.package_description #=> String
resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
resp.package_details.created_at #=> Time
resp.package_details.last_updated_at #=> Time
resp.package_details.available_package_version #=> String
resp.package_details.error_details.error_type #=> String
resp.package_details.error_details.error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_name (required, String) —

    Unique identifier for the package.

  • :package_type (required, String) —

    Type of package. Currently supports only TXT-DICTIONARY.

  • :package_description (String) —

    Description of the package.

  • :package_source (required, Types::PackageSource) —

    The customer S3 location PackageSource for importing the package.

Returns:



1126
1127
1128
1129
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1126

def create_package(params = {}, options = {})
  req = build_request(:create_package, params)
  req.send_request(options)
end

#create_vpc_endpoint(params = {}) ⇒ Types::CreateVpcEndpointResponse

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.create_vpc_endpoint({
  domain_arn: "DomainArn", # required
  vpc_options: { # required
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  client_token: "ClientToken",
})

Response structure


resp.vpc_endpoint.vpc_endpoint_id #=> String
resp.vpc_endpoint.vpc_endpoint_owner #=> String
resp.vpc_endpoint.domain_arn #=> String
resp.vpc_endpoint.vpc_options.vpc_id #=> String
resp.vpc_endpoint.vpc_options.subnet_ids #=> Array
resp.vpc_endpoint.vpc_options.subnet_ids[0] #=> String
resp.vpc_endpoint.vpc_options.availability_zones #=> Array
resp.vpc_endpoint.vpc_options.availability_zones[0] #=> String
resp.vpc_endpoint.vpc_options.security_group_ids #=> Array
resp.vpc_endpoint.vpc_options.security_group_ids[0] #=> String
resp.vpc_endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.vpc_endpoint.endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_arn (required, String) —

    The Amazon Resource Name (ARN) of the domain to grant access to.

  • :vpc_options (required, Types::VPCOptions) —

    Options to specify the subnets and security groups for the endpoint.

  • :client_token (String) —

    Unique, case-sensitive identifier to ensure idempotency of the request.

Returns:



1175
1176
1177
1178
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1175

def create_vpc_endpoint(params = {}, options = {})
  req = build_request(:create_vpc_endpoint, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.delete_elasticsearch_domain({
  domain_name: "DomainName", # required
})

Response structure


resp.domain_status.domain_id #=> String
resp.domain_status.domain_name #=> String
resp.domain_status.arn #=> String
resp.domain_status.created #=> Boolean
resp.domain_status.deleted #=> Boolean
resp.domain_status.endpoint #=> String
resp.domain_status.endpoints #=> Hash
resp.domain_status.endpoints["String"] #=> String
resp.domain_status.processing #=> Boolean
resp.domain_status.upgrade_processing #=> Boolean
resp.domain_status.elasticsearch_version #=> String
resp.domain_status.elasticsearch_cluster_config.instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.instance_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.dedicated_master_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.dedicated_master_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.warm_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.warm_type #=> String, one of "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.warm_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.cold_storage_options.enabled #=> Boolean
resp.domain_status.ebs_options.ebs_enabled #=> Boolean
resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
resp.domain_status.ebs_options.volume_size #=> Integer
resp.domain_status.ebs_options.iops #=> Integer
resp.domain_status.ebs_options.throughput #=> Integer
resp.domain_status.access_policies #=> String
resp.domain_status.snapshot_options.automated_snapshot_start_hour #=> Integer
resp.domain_status.vpc_options.vpc_id #=> String
resp.domain_status.vpc_options.subnet_ids #=> Array
resp.domain_status.vpc_options.subnet_ids[0] #=> String
resp.domain_status.vpc_options.availability_zones #=> Array
resp.domain_status.vpc_options.availability_zones[0] #=> String
resp.domain_status.vpc_options.security_group_ids #=> Array
resp.domain_status.vpc_options.security_group_ids[0] #=> String
resp.domain_status.cognito_options.enabled #=> Boolean
resp.domain_status.cognito_options.user_pool_id #=> String
resp.domain_status.cognito_options.identity_pool_id #=> String
resp.domain_status.cognito_options.role_arn #=> String
resp.domain_status.encryption_at_rest_options.enabled #=> Boolean
resp.domain_status.encryption_at_rest_options.kms_key_id #=> String
resp.domain_status.node_to_node_encryption_options.enabled #=> Boolean
resp.domain_status.advanced_options #=> Hash
resp.domain_status.advanced_options["String"] #=> String
resp.domain_status.log_publishing_options #=> Hash
resp.domain_status.log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
resp.domain_status.log_publishing_options["LogType"].enabled #=> Boolean
resp.domain_status.service_software_options.current_version #=> String
resp.domain_status.service_software_options.new_version #=> String
resp.domain_status.service_software_options.update_available #=> Boolean
resp.domain_status.service_software_options.cancellable #=> Boolean
resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.domain_status.service_software_options.description #=> String
resp.domain_status.service_software_options.automated_update_date #=> Time
resp.domain_status.service_software_options.optional_deployment #=> Boolean
resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
resp.domain_status.domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10", "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08"
resp.domain_status.domain_endpoint_options.custom_endpoint_enabled #=> Boolean
resp.domain_status.domain_endpoint_options.custom_endpoint #=> String
resp.domain_status.domain_endpoint_options.custom_endpoint_certificate_arn #=> String
resp.domain_status.advanced_security_options.enabled #=> Boolean
resp.domain_status.advanced_security_options.internal_user_database_enabled #=> Boolean
resp.domain_status.advanced_security_options.saml_options.enabled #=> Boolean
resp.domain_status.advanced_security_options.saml_options.idp.metadata_content #=> String
resp.domain_status.advanced_security_options.saml_options.idp.entity_id #=> String
resp.domain_status.advanced_security_options.saml_options.subject_key #=> String
resp.domain_status.advanced_security_options.saml_options.roles_key #=> String
resp.domain_status.advanced_security_options.saml_options.session_timeout_minutes #=> Integer
resp.domain_status.advanced_security_options.anonymous_auth_disable_date #=> Time
resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
resp.domain_status.auto_tune_options.error_message #=> String
resp.domain_status.change_progress_details.change_id #=> String
resp.domain_status.change_progress_details.message #=> String
resp.domain_status.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.domain_status.change_progress_details.start_time #=> Time
resp.domain_status.change_progress_details.last_updated_time #=> Time
resp.domain_status.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE"
resp.domain_status.domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting"
resp.domain_status.modifying_properties #=> Array
resp.domain_status.modifying_properties[0].name #=> String
resp.domain_status.modifying_properties[0].active_value #=> String
resp.domain_status.modifying_properties[0].pending_value #=> String
resp.domain_status.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON"
resp.domain_status.deployment_strategy_options.deployment_strategy #=> String, one of "Default", "CapacityOptimized"
resp.domain_status.automated_snapshot_pause_options.enabled #=> Boolean
resp.domain_status.automated_snapshot_pause_options.start_time #=> Time
resp.domain_status.automated_snapshot_pause_options.end_time #=> Time
resp.domain_status.automated_snapshot_pause_options.state #=> String, one of "Active", "Completed", "Scheduled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the Elasticsearch domain that you want to permanently delete.

Returns:



1292
1293
1294
1295
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1292

def delete_elasticsearch_domain(params = {}, options = {})
  req = build_request(:delete_elasticsearch_domain, params)
  req.send_request(options)
end

#delete_elasticsearch_service_role(params = {}) ⇒ 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.

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Returns:

  • (Struct) —

    Returns an empty response.



1312
1313
1314
1315
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1312

def delete_elasticsearch_service_role(params = {}, options = {})
  req = build_request(:delete_elasticsearch_service_role, params)
  req.send_request(options)
end

#delete_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::DeleteInboundCrossClusterSearchConnectionResponse

Allows the destination domain owner to delete an existing inbound cross-cluster search connection.

Examples:

Request syntax with placeholder values


resp = client.delete_inbound_cross_cluster_search_connection({
  cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
})

Response structure


resp.cross_cluster_search_connection.source_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.source_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.source_domain_info.region #=> String
resp.cross_cluster_search_connection.destination_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.destination_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.destination_domain_info.region #=> String
resp.cross_cluster_search_connection.cross_cluster_search_connection_id #=> String
resp.cross_cluster_search_connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.cross_cluster_search_connection.connection_status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cross_cluster_search_connection_id (required, String) —

    The id of the inbound connection that you want to permanently delete.

Returns:



1347
1348
1349
1350
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1347

def delete_inbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:delete_inbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

#delete_outbound_cross_cluster_search_connection(params = {}) ⇒ Types::DeleteOutboundCrossClusterSearchConnectionResponse

Allows the source domain owner to delete an existing outbound cross-cluster search connection.

Examples:

Request syntax with placeholder values


resp = client.delete_outbound_cross_cluster_search_connection({
  cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
})

Response structure


resp.cross_cluster_search_connection.source_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.source_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.source_domain_info.region #=> String
resp.cross_cluster_search_connection.destination_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.destination_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.destination_domain_info.region #=> String
resp.cross_cluster_search_connection.cross_cluster_search_connection_id #=> String
resp.cross_cluster_search_connection.connection_alias #=> String
resp.cross_cluster_search_connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "VALIDATING", "VALIDATION_FAILED", "PROVISIONING", "ACTIVE", "REJECTED", "DELETING", "DELETED"
resp.cross_cluster_search_connection.connection_status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cross_cluster_search_connection_id (required, String) —

    The id of the outbound connection that you want to permanently delete.

Returns:



1383
1384
1385
1386
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1383

def delete_outbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:delete_outbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

#delete_package(params = {}) ⇒ Types::DeletePackageResponse

Delete the package.

Examples:

Request syntax with placeholder values


resp = client.delete_package({
  package_id: "PackageID", # required
})

Response structure


resp.package_details.package_id #=> String
resp.package_details.package_name #=> String
resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
resp.package_details.package_description #=> String
resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
resp.package_details.created_at #=> Time
resp.package_details.last_updated_at #=> Time
resp.package_details.available_package_version #=> String
resp.package_details.error_details.error_type #=> String
resp.package_details.error_details.error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_id (required, String) —

    Internal ID of the package that you want to delete. Use DescribePackages to find this value.

Returns:



1419
1420
1421
1422
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1419

def delete_package(params = {}, options = {})
  req = build_request(:delete_package, params)
  req.send_request(options)
end

#delete_vpc_endpoint(params = {}) ⇒ Types::DeleteVpcEndpointResponse

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_endpoint({
  vpc_endpoint_id: "VpcEndpointId", # required
})

Response structure


resp.vpc_endpoint_summary.vpc_endpoint_id #=> String
resp.vpc_endpoint_summary.vpc_endpoint_owner #=> String
resp.vpc_endpoint_summary.domain_arn #=> String
resp.vpc_endpoint_summary.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_endpoint_id (required, String) —

    The unique identifier of the endpoint to be deleted.

Returns:



1448
1449
1450
1451
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1448

def delete_vpc_endpoint(params = {}, options = {})
  req = build_request(:delete_vpc_endpoint, params)
  req.send_request(options)
end

#describe_domain_auto_tunes(params = {}) ⇒ Types::DescribeDomainAutoTunesResponse

Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_domain_auto_tunes({
  domain_name: "DomainName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.auto_tunes #=> Array
resp.auto_tunes[0].auto_tune_type #=> String, one of "SCHEDULED_ACTION"
resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.date #=> Time
resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.action_type #=> String, one of "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.action #=> String
resp.auto_tunes[0].auto_tune_details.scheduled_auto_tune_details.severity #=> String, one of "LOW", "MEDIUM", "HIGH"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    Specifies the domain name for which you want Auto-Tune action details.

  • :max_results (Integer) —

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • :next_token (String) —

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Returns:



1495
1496
1497
1498
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1495

def describe_domain_auto_tunes(params = {}, options = {})
  req = build_request(:describe_domain_auto_tunes, params)
  req.send_request(options)
end

#describe_domain_change_progress(params = {}) ⇒ Types::DescribeDomainChangeProgressResponse

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

Examples:

Request syntax with placeholder values


resp = client.describe_domain_change_progress({
  domain_name: "DomainName", # required
  change_id: "GUID",
})

Response structure


resp.change_progress_status.change_id #=> String
resp.change_progress_status.start_time #=> Time
resp.change_progress_status.status #=> String, one of "PENDING", "PROCESSING", "COMPLETED", "FAILED"
resp.change_progress_status.pending_properties #=> Array
resp.change_progress_status.pending_properties[0] #=> String
resp.change_progress_status.completed_properties #=> Array
resp.change_progress_status.completed_properties[0] #=> String
resp.change_progress_status.total_number_of_stages #=> Integer
resp.change_progress_status.change_progress_stages #=> Array
resp.change_progress_status.change_progress_stages[0].name #=> String
resp.change_progress_status.change_progress_stages[0].status #=> String
resp.change_progress_status.change_progress_stages[0].description #=> String
resp.change_progress_status.change_progress_stages[0].last_updated #=> Time
resp.change_progress_status.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.change_progress_status.last_updated_time #=> Time
resp.change_progress_status.initiated_by #=> String, one of "CUSTOMER", "SERVICE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The domain you want to get the progress information about.

  • :change_id (String) —

    The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

Returns:



1543
1544
1545
1546
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1543

def describe_domain_change_progress(params = {}, options = {})
  req = build_request(:describe_domain_change_progress, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.describe_elasticsearch_domain({
  domain_name: "DomainName", # required
})

Response structure


resp.domain_status.domain_id #=> String
resp.domain_status.domain_name #=> String
resp.domain_status.arn #=> String
resp.domain_status.created #=> Boolean
resp.domain_status.deleted #=> Boolean
resp.domain_status.endpoint #=> String
resp.domain_status.endpoints #=> Hash
resp.domain_status.endpoints["String"] #=> String
resp.domain_status.processing #=> Boolean
resp.domain_status.upgrade_processing #=> Boolean
resp.domain_status.elasticsearch_version #=> String
resp.domain_status.elasticsearch_cluster_config.instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.instance_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.dedicated_master_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.dedicated_master_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.warm_enabled #=> Boolean
resp.domain_status.elasticsearch_cluster_config.warm_type #=> String, one of "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch"
resp.domain_status.elasticsearch_cluster_config.warm_count #=> Integer
resp.domain_status.elasticsearch_cluster_config.cold_storage_options.enabled #=> Boolean
resp.domain_status.ebs_options.ebs_enabled #=> Boolean
resp.domain_status.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
resp.domain_status.ebs_options.volume_size #=> Integer
resp.domain_status.ebs_options.iops #=> Integer
resp.domain_status.ebs_options.throughput #=> Integer
resp.domain_status.access_policies #=> String
resp.domain_status.snapshot_options.automated_snapshot_start_hour #=> Integer
resp.domain_status.vpc_options.vpc_id #=> String
resp.domain_status.vpc_options.subnet_ids #=> Array
resp.domain_status.vpc_options.subnet_ids[0] #=> String
resp.domain_status.vpc_options.availability_zones #=> Array
resp.domain_status.vpc_options.availability_zones[0] #=> String
resp.domain_status.vpc_options.security_group_ids #=> Array
resp.domain_status.vpc_options.security_group_ids[0] #=> String
resp.domain_status.cognito_options.enabled #=> Boolean
resp.domain_status.cognito_options.user_pool_id #=> String
resp.domain_status.cognito_options.identity_pool_id #=> String
resp.domain_status.cognito_options.role_arn #=> String
resp.domain_status.encryption_at_rest_options.enabled #=> Boolean
resp.domain_status.encryption_at_rest_options.kms_key_id #=> String
resp.domain_status.node_to_node_encryption_options.enabled #=> Boolean
resp.domain_status.advanced_options #=> Hash
resp.domain_status.advanced_options["String"] #=> String
resp.domain_status.log_publishing_options #=> Hash
resp.domain_status.log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
resp.domain_status.log_publishing_options["LogType"].enabled #=> Boolean
resp.domain_status.service_software_options.current_version #=> String
resp.domain_status.service_software_options.new_version #=> String
resp.domain_status.service_software_options.update_available #=> Boolean
resp.domain_status.service_software_options.cancellable #=> Boolean
resp.domain_status.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.domain_status.service_software_options.description #=> String
resp.domain_status.service_software_options.automated_update_date #=> Time
resp.domain_status.service_software_options.optional_deployment #=> Boolean
resp.domain_status.domain_endpoint_options.enforce_https #=> Boolean
resp.domain_status.domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10", "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08"
resp.domain_status.domain_endpoint_options.custom_endpoint_enabled #=> Boolean
resp.domain_status.domain_endpoint_options.custom_endpoint #=> String
resp.domain_status.domain_endpoint_options.custom_endpoint_certificate_arn #=> String
resp.domain_status.advanced_security_options.enabled #=> Boolean
resp.domain_status.advanced_security_options.internal_user_database_enabled #=> Boolean
resp.domain_status.advanced_security_options.saml_options.enabled #=> Boolean
resp.domain_status.advanced_security_options.saml_options.idp.metadata_content #=> String
resp.domain_status.advanced_security_options.saml_options.idp.entity_id #=> String
resp.domain_status.advanced_security_options.saml_options.subject_key #=> String
resp.domain_status.advanced_security_options.saml_options.roles_key #=> String
resp.domain_status.advanced_security_options.saml_options.session_timeout_minutes #=> Integer
resp.domain_status.advanced_security_options.anonymous_auth_disable_date #=> Time
resp.domain_status.advanced_security_options.anonymous_auth_enabled #=> Boolean
resp.domain_status.auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
resp.domain_status.auto_tune_options.error_message #=> String
resp.domain_status.change_progress_details.change_id #=> String
resp.domain_status.change_progress_details.message #=> String
resp.domain_status.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.domain_status.change_progress_details.start_time #=> Time
resp.domain_status.change_progress_details.last_updated_time #=> Time
resp.domain_status.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE"
resp.domain_status.domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting"
resp.domain_status.modifying_properties #=> Array
resp.domain_status.modifying_properties[0].name #=> String
resp.domain_status.modifying_properties[0].active_value #=> String
resp.domain_status.modifying_properties[0].pending_value #=> String
resp.domain_status.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON"
resp.domain_status.deployment_strategy_options.deployment_strategy #=> String, one of "Default", "CapacityOptimized"
resp.domain_status.automated_snapshot_pause_options.enabled #=> Boolean
resp.domain_status.automated_snapshot_pause_options.start_time #=> Time
resp.domain_status.automated_snapshot_pause_options.end_time #=> Time
resp.domain_status.automated_snapshot_pause_options.state #=> String, one of "Active", "Completed", "Scheduled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the Elasticsearch domain for which you want information.

Returns:



1660
1661
1662
1663
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1660

def describe_elasticsearch_domain(params = {}, options = {})
  req = build_request(:describe_elasticsearch_domain, params)
  req.send_request(options)
end

#describe_elasticsearch_domain_config(params = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.describe_elasticsearch_domain_config({
  domain_name: "DomainName", # required
})

Response structure


resp.domain_config.elasticsearch_version.options #=> String
resp.domain_config.elasticsearch_version.status.creation_date #=> Time
resp.domain_config.elasticsearch_version.status.update_date #=> Time
resp.domain_config.elasticsearch_version.status.update_version #=> Integer
resp.domain_config.elasticsearch_version.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.elasticsearch_version.status.pending_deletion #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_config.elasticsearch_cluster_config.options.instance_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.dedicated_master_enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.zone_awareness_enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.dedicated_master_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_config.elasticsearch_cluster_config.options.dedicated_master_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.warm_enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch"
resp.domain_config.elasticsearch_cluster_config.options.warm_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.cold_storage_options.enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.status.creation_date #=> Time
resp.domain_config.elasticsearch_cluster_config.status.update_date #=> Time
resp.domain_config.elasticsearch_cluster_config.status.update_version #=> Integer
resp.domain_config.elasticsearch_cluster_config.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.elasticsearch_cluster_config.status.pending_deletion #=> Boolean
resp.domain_config.ebs_options.options.ebs_enabled #=> Boolean
resp.domain_config.ebs_options.options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
resp.domain_config.ebs_options.options.volume_size #=> Integer
resp.domain_config.ebs_options.options.iops #=> Integer
resp.domain_config.ebs_options.options.throughput #=> Integer
resp.domain_config.ebs_options.status.creation_date #=> Time
resp.domain_config.ebs_options.status.update_date #=> Time
resp.domain_config.ebs_options.status.update_version #=> Integer
resp.domain_config.ebs_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.ebs_options.status.pending_deletion #=> Boolean
resp.domain_config.access_policies.options #=> String
resp.domain_config.access_policies.status.creation_date #=> Time
resp.domain_config.access_policies.status.update_date #=> Time
resp.domain_config.access_policies.status.update_version #=> Integer
resp.domain_config.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.access_policies.status.pending_deletion #=> Boolean
resp.domain_config.snapshot_options.options.automated_snapshot_start_hour #=> Integer
resp.domain_config.snapshot_options.status.creation_date #=> Time
resp.domain_config.snapshot_options.status.update_date #=> Time
resp.domain_config.snapshot_options.status.update_version #=> Integer
resp.domain_config.snapshot_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.snapshot_options.status.pending_deletion #=> Boolean
resp.domain_config.vpc_options.options.vpc_id #=> String
resp.domain_config.vpc_options.options.subnet_ids #=> Array
resp.domain_config.vpc_options.options.subnet_ids[0] #=> String
resp.domain_config.vpc_options.options.availability_zones #=> Array
resp.domain_config.vpc_options.options.availability_zones[0] #=> String
resp.domain_config.vpc_options.options.security_group_ids #=> Array
resp.domain_config.vpc_options.options.security_group_ids[0] #=> String
resp.domain_config.vpc_options.status.creation_date #=> Time
resp.domain_config.vpc_options.status.update_date #=> Time
resp.domain_config.vpc_options.status.update_version #=> Integer
resp.domain_config.vpc_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.vpc_options.status.pending_deletion #=> Boolean
resp.domain_config.cognito_options.options.enabled #=> Boolean
resp.domain_config.cognito_options.options.user_pool_id #=> String
resp.domain_config.cognito_options.options.identity_pool_id #=> String
resp.domain_config.cognito_options.options.role_arn #=> String
resp.domain_config.cognito_options.status.creation_date #=> Time
resp.domain_config.cognito_options.status.update_date #=> Time
resp.domain_config.cognito_options.status.update_version #=> Integer
resp.domain_config.cognito_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.cognito_options.status.pending_deletion #=> Boolean
resp.domain_config.encryption_at_rest_options.options.enabled #=> Boolean
resp.domain_config.encryption_at_rest_options.options.kms_key_id #=> String
resp.domain_config.encryption_at_rest_options.status.creation_date #=> Time
resp.domain_config.encryption_at_rest_options.status.update_date #=> Time
resp.domain_config.encryption_at_rest_options.status.update_version #=> Integer
resp.domain_config.encryption_at_rest_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.encryption_at_rest_options.status.pending_deletion #=> Boolean
resp.domain_config.node_to_node_encryption_options.options.enabled #=> Boolean
resp.domain_config.node_to_node_encryption_options.status.creation_date #=> Time
resp.domain_config.node_to_node_encryption_options.status.update_date #=> Time
resp.domain_config.node_to_node_encryption_options.status.update_version #=> Integer
resp.domain_config.node_to_node_encryption_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.node_to_node_encryption_options.status.pending_deletion #=> Boolean
resp.domain_config.advanced_options.options #=> Hash
resp.domain_config.advanced_options.options["String"] #=> String
resp.domain_config.advanced_options.status.creation_date #=> Time
resp.domain_config.advanced_options.status.update_date #=> Time
resp.domain_config.advanced_options.status.update_version #=> Integer
resp.domain_config.advanced_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.advanced_options.status.pending_deletion #=> Boolean
resp.domain_config.log_publishing_options.options #=> Hash
resp.domain_config.log_publishing_options.options["LogType"].cloud_watch_logs_log_group_arn #=> String
resp.domain_config.log_publishing_options.options["LogType"].enabled #=> Boolean
resp.domain_config.log_publishing_options.status.creation_date #=> Time
resp.domain_config.log_publishing_options.status.update_date #=> Time
resp.domain_config.log_publishing_options.status.update_version #=> Integer
resp.domain_config.log_publishing_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.log_publishing_options.status.pending_deletion #=> Boolean
resp.domain_config.domain_endpoint_options.options.enforce_https #=> Boolean
resp.domain_config.domain_endpoint_options.options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10", "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08"
resp.domain_config.domain_endpoint_options.options.custom_endpoint_enabled #=> Boolean
resp.domain_config.domain_endpoint_options.options.custom_endpoint #=> String
resp.domain_config.domain_endpoint_options.options.custom_endpoint_certificate_arn #=> String
resp.domain_config.domain_endpoint_options.status.creation_date #=> Time
resp.domain_config.domain_endpoint_options.status.update_date #=> Time
resp.domain_config.domain_endpoint_options.status.update_version #=> Integer
resp.domain_config.domain_endpoint_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.domain_endpoint_options.status.pending_deletion #=> Boolean
resp.domain_config.advanced_security_options.options.enabled #=> Boolean
resp.domain_config.advanced_security_options.options.internal_user_database_enabled #=> Boolean
resp.domain_config.advanced_security_options.options.saml_options.enabled #=> Boolean
resp.domain_config.advanced_security_options.options.saml_options.idp.metadata_content #=> String
resp.domain_config.advanced_security_options.options.saml_options.idp.entity_id #=> String
resp.domain_config.advanced_security_options.options.saml_options.subject_key #=> String
resp.domain_config.advanced_security_options.options.saml_options.roles_key #=> String
resp.domain_config.advanced_security_options.options.saml_options.session_timeout_minutes #=> Integer
resp.domain_config.advanced_security_options.options.anonymous_auth_disable_date #=> Time
resp.domain_config.advanced_security_options.options.anonymous_auth_enabled #=> Boolean
resp.domain_config.advanced_security_options.status.creation_date #=> Time
resp.domain_config.advanced_security_options.status.update_date #=> Time
resp.domain_config.advanced_security_options.status.update_version #=> Integer
resp.domain_config.advanced_security_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.advanced_security_options.status.pending_deletion #=> Boolean
resp.domain_config.auto_tune_options.options.desired_state #=> String, one of "ENABLED", "DISABLED"
resp.domain_config.auto_tune_options.options.rollback_on_disable #=> String, one of "NO_ROLLBACK", "DEFAULT_ROLLBACK"
resp.domain_config.auto_tune_options.options.maintenance_schedules #=> Array
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].start_at #=> Time
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
resp.domain_config.auto_tune_options.status.creation_date #=> Time
resp.domain_config.auto_tune_options.status.update_date #=> Time
resp.domain_config.auto_tune_options.status.update_version #=> Integer
resp.domain_config.auto_tune_options.status.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
resp.domain_config.auto_tune_options.status.error_message #=> String
resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
resp.domain_config.change_progress_details.change_id #=> String
resp.domain_config.change_progress_details.message #=> String
resp.domain_config.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.domain_config.change_progress_details.start_time #=> Time
resp.domain_config.change_progress_details.last_updated_time #=> Time
resp.domain_config.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE"
resp.domain_config.modifying_properties #=> Array
resp.domain_config.modifying_properties[0].name #=> String
resp.domain_config.modifying_properties[0].active_value #=> String
resp.domain_config.modifying_properties[0].pending_value #=> String
resp.domain_config.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON"
resp.domain_config.deployment_strategy_options.options.deployment_strategy #=> String, one of "Default", "CapacityOptimized"
resp.domain_config.deployment_strategy_options.status.creation_date #=> Time
resp.domain_config.deployment_strategy_options.status.update_date #=> Time
resp.domain_config.deployment_strategy_options.status.update_version #=> Integer
resp.domain_config.deployment_strategy_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.deployment_strategy_options.status.pending_deletion #=> Boolean
resp.domain_config.automated_snapshot_pause_options.options.enabled #=> Boolean
resp.domain_config.automated_snapshot_pause_options.options.start_time #=> Time
resp.domain_config.automated_snapshot_pause_options.options.end_time #=> Time
resp.domain_config.automated_snapshot_pause_options.options.state #=> String, one of "Active", "Completed", "Scheduled", "Disabled"
resp.domain_config.automated_snapshot_pause_options.status.creation_date #=> Time
resp.domain_config.automated_snapshot_pause_options.status.update_date #=> Time
resp.domain_config.automated_snapshot_pause_options.status.update_version #=> Integer
resp.domain_config.automated_snapshot_pause_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.automated_snapshot_pause_options.status.pending_deletion #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The Elasticsearch domain that you want to get information about.

Returns:



1844
1845
1846
1847
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1844

def describe_elasticsearch_domain_config(params = {}, options = {})
  req = build_request(:describe_elasticsearch_domain_config, params)
  req.send_request(options)
end

#describe_elasticsearch_domains(params = {}) ⇒ Types::DescribeElasticsearchDomainsResponse

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

Examples:

Request syntax with placeholder values


resp = client.describe_elasticsearch_domains({
  domain_names: ["DomainName"], # required
})

Response structure


resp.domain_status_list #=> Array
resp.domain_status_list[0].domain_id #=> String
resp.domain_status_list[0].domain_name #=> String
resp.domain_status_list[0].arn #=> String
resp.domain_status_list[0].created #=> Boolean
resp.domain_status_list[0].deleted #=> Boolean
resp.domain_status_list[0].endpoint #=> String
resp.domain_status_list[0].endpoints #=> Hash
resp.domain_status_list[0].endpoints["String"] #=> String
resp.domain_status_list[0].processing #=> Boolean
resp.domain_status_list[0].upgrade_processing #=> Boolean
resp.domain_status_list[0].elasticsearch_version #=> String
resp.domain_status_list[0].elasticsearch_cluster_config.instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status_list[0].elasticsearch_cluster_config.instance_count #=> Integer
resp.domain_status_list[0].elasticsearch_cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status_list[0].elasticsearch_cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status_list[0].elasticsearch_cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status_list[0].elasticsearch_cluster_config.dedicated_master_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_status_list[0].elasticsearch_cluster_config.dedicated_master_count #=> Integer
resp.domain_status_list[0].elasticsearch_cluster_config.warm_enabled #=> Boolean
resp.domain_status_list[0].elasticsearch_cluster_config.warm_type #=> String, one of "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch"
resp.domain_status_list[0].elasticsearch_cluster_config.warm_count #=> Integer
resp.domain_status_list[0].elasticsearch_cluster_config.cold_storage_options.enabled #=> Boolean
resp.domain_status_list[0].ebs_options.ebs_enabled #=> Boolean
resp.domain_status_list[0].ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
resp.domain_status_list[0].ebs_options.volume_size #=> Integer
resp.domain_status_list[0].ebs_options.iops #=> Integer
resp.domain_status_list[0].ebs_options.throughput #=> Integer
resp.domain_status_list[0].access_policies #=> String
resp.domain_status_list[0].snapshot_options.automated_snapshot_start_hour #=> Integer
resp.domain_status_list[0].vpc_options.vpc_id #=> String
resp.domain_status_list[0].vpc_options.subnet_ids #=> Array
resp.domain_status_list[0].vpc_options.subnet_ids[0] #=> String
resp.domain_status_list[0].vpc_options.availability_zones #=> Array
resp.domain_status_list[0].vpc_options.availability_zones[0] #=> String
resp.domain_status_list[0].vpc_options.security_group_ids #=> Array
resp.domain_status_list[0].vpc_options.security_group_ids[0] #=> String
resp.domain_status_list[0].cognito_options.enabled #=> Boolean
resp.domain_status_list[0].cognito_options.user_pool_id #=> String
resp.domain_status_list[0].cognito_options.identity_pool_id #=> String
resp.domain_status_list[0].cognito_options.role_arn #=> String
resp.domain_status_list[0].encryption_at_rest_options.enabled #=> Boolean
resp.domain_status_list[0].encryption_at_rest_options.kms_key_id #=> String
resp.domain_status_list[0].node_to_node_encryption_options.enabled #=> Boolean
resp.domain_status_list[0].advanced_options #=> Hash
resp.domain_status_list[0].advanced_options["String"] #=> String
resp.domain_status_list[0].log_publishing_options #=> Hash
resp.domain_status_list[0].log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
resp.domain_status_list[0].log_publishing_options["LogType"].enabled #=> Boolean
resp.domain_status_list[0].service_software_options.current_version #=> String
resp.domain_status_list[0].service_software_options.new_version #=> String
resp.domain_status_list[0].service_software_options.update_available #=> Boolean
resp.domain_status_list[0].service_software_options.cancellable #=> Boolean
resp.domain_status_list[0].service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.domain_status_list[0].service_software_options.description #=> String
resp.domain_status_list[0].service_software_options.automated_update_date #=> Time
resp.domain_status_list[0].service_software_options.optional_deployment #=> Boolean
resp.domain_status_list[0].domain_endpoint_options.enforce_https #=> Boolean
resp.domain_status_list[0].domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10", "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08"
resp.domain_status_list[0].domain_endpoint_options.custom_endpoint_enabled #=> Boolean
resp.domain_status_list[0].domain_endpoint_options.custom_endpoint #=> String
resp.domain_status_list[0].domain_endpoint_options.custom_endpoint_certificate_arn #=> String
resp.domain_status_list[0].advanced_security_options.enabled #=> Boolean
resp.domain_status_list[0].advanced_security_options.internal_user_database_enabled #=> Boolean
resp.domain_status_list[0].advanced_security_options.saml_options.enabled #=> Boolean
resp.domain_status_list[0].advanced_security_options.saml_options.idp.metadata_content #=> String
resp.domain_status_list[0].advanced_security_options.saml_options.idp.entity_id #=> String
resp.domain_status_list[0].advanced_security_options.saml_options.subject_key #=> String
resp.domain_status_list[0].advanced_security_options.saml_options.roles_key #=> String
resp.domain_status_list[0].advanced_security_options.saml_options.session_timeout_minutes #=> Integer
resp.domain_status_list[0].advanced_security_options.anonymous_auth_disable_date #=> Time
resp.domain_status_list[0].advanced_security_options.anonymous_auth_enabled #=> Boolean
resp.domain_status_list[0].auto_tune_options.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
resp.domain_status_list[0].auto_tune_options.error_message #=> String
resp.domain_status_list[0].change_progress_details.change_id #=> String
resp.domain_status_list[0].change_progress_details.message #=> String
resp.domain_status_list[0].change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.domain_status_list[0].change_progress_details.start_time #=> Time
resp.domain_status_list[0].change_progress_details.last_updated_time #=> Time
resp.domain_status_list[0].change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE"
resp.domain_status_list[0].domain_processing_status #=> String, one of "Creating", "Active", "Modifying", "UpgradingEngineVersion", "UpdatingServiceSoftware", "Isolated", "Deleting"
resp.domain_status_list[0].modifying_properties #=> Array
resp.domain_status_list[0].modifying_properties[0].name #=> String
resp.domain_status_list[0].modifying_properties[0].active_value #=> String
resp.domain_status_list[0].modifying_properties[0].pending_value #=> String
resp.domain_status_list[0].modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON"
resp.domain_status_list[0].deployment_strategy_options.deployment_strategy #=> String, one of "Default", "CapacityOptimized"
resp.domain_status_list[0].automated_snapshot_pause_options.enabled #=> Boolean
resp.domain_status_list[0].automated_snapshot_pause_options.start_time #=> Time
resp.domain_status_list[0].automated_snapshot_pause_options.end_time #=> Time
resp.domain_status_list[0].automated_snapshot_pause_options.state #=> String, one of "Active", "Completed", "Scheduled", "Disabled"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_names (required, Array<String>) —

    The Elasticsearch domains for which you want information.

Returns:



1962
1963
1964
1965
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 1962

def describe_elasticsearch_domains(params = {}, options = {})
  req = build_request(:describe_elasticsearch_domains, params)
  req.send_request(options)
end

#describe_elasticsearch_instance_type_limits(params = {}) ⇒ Types::DescribeElasticsearchInstanceTypeLimitsResponse

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

Examples:

Request syntax with placeholder values


resp = client.describe_elasticsearch_instance_type_limits({
  domain_name: "DomainName",
  instance_type: "m3.medium.elasticsearch", # required, accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
  elasticsearch_version: "ElasticsearchVersionString", # required
})

Response structure


resp.limits_by_role #=> Hash
resp.limits_by_role["InstanceRole"].storage_types #=> Array
resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_name #=> String
resp.limits_by_role["InstanceRole"].storage_types[0].storage_sub_type_name #=> String
resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits #=> Array
resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits[0].limit_name #=> String
resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits[0].limit_values #=> Array
resp.limits_by_role["InstanceRole"].storage_types[0].storage_type_limits[0].limit_values[0] #=> String
resp.limits_by_role["InstanceRole"].instance_limits.instance_count_limits.minimum_instance_count #=> Integer
resp.limits_by_role["InstanceRole"].instance_limits.instance_count_limits.maximum_instance_count #=> Integer
resp.limits_by_role["InstanceRole"].additional_limits #=> Array
resp.limits_by_role["InstanceRole"].additional_limits[0].limit_name #=> String
resp.limits_by_role["InstanceRole"].additional_limits[0].limit_values #=> Array
resp.limits_by_role["InstanceRole"].additional_limits[0].limit_values[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (String) —

    DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

  • :instance_type (required, String) —

    The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

  • :elasticsearch_version (required, String) —

    Version of Elasticsearch for which Limits are needed.

Returns:



2014
2015
2016
2017
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2014

def describe_elasticsearch_instance_type_limits(params = {}, options = {})
  req = build_request(:describe_elasticsearch_instance_type_limits, params)
  req.send_request(options)
end

#describe_inbound_cross_cluster_search_connections(params = {}) ⇒ Types::DescribeInboundCrossClusterSearchConnectionsResponse

Lists all the inbound cross-cluster search connections for a destination domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_inbound_cross_cluster_search_connections({
  filters: [
    {
      name: "NonEmptyString",
      values: ["NonEmptyString"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.cross_cluster_search_connections #=> Array
resp.cross_cluster_search_connections[0].source_domain_info.owner_id #=> String
resp.cross_cluster_search_connections[0].source_domain_info.domain_name #=> String
resp.cross_cluster_search_connections[0].source_domain_info.region #=> String
resp.cross_cluster_search_connections[0].destination_domain_info.owner_id #=> String
resp.cross_cluster_search_connections[0].destination_domain_info.domain_name #=> String
resp.cross_cluster_search_connections[0].destination_domain_info.region #=> String
resp.cross_cluster_search_connections[0].cross_cluster_search_connection_id #=> String
resp.cross_cluster_search_connections[0].connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.cross_cluster_search_connections[0].connection_status.message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are: * cross-cluster-search-connection-id * source-domain-info.domain-name * source-domain-info.owner-id * source-domain-info.region * destination-domain-info.domain-name

  • :max_results (Integer) —

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • :next_token (String) —

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Returns:



2075
2076
2077
2078
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2075

def describe_inbound_cross_cluster_search_connections(params = {}, options = {})
  req = build_request(:describe_inbound_cross_cluster_search_connections, params)
  req.send_request(options)
end

#describe_outbound_cross_cluster_search_connections(params = {}) ⇒ Types::DescribeOutboundCrossClusterSearchConnectionsResponse

Lists all the outbound cross-cluster search connections for a source domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_outbound_cross_cluster_search_connections({
  filters: [
    {
      name: "NonEmptyString",
      values: ["NonEmptyString"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.cross_cluster_search_connections #=> Array
resp.cross_cluster_search_connections[0].source_domain_info.owner_id #=> String
resp.cross_cluster_search_connections[0].source_domain_info.domain_name #=> String
resp.cross_cluster_search_connections[0].source_domain_info.region #=> String
resp.cross_cluster_search_connections[0].destination_domain_info.owner_id #=> String
resp.cross_cluster_search_connections[0].destination_domain_info.domain_name #=> String
resp.cross_cluster_search_connections[0].destination_domain_info.region #=> String
resp.cross_cluster_search_connections[0].cross_cluster_search_connection_id #=> String
resp.cross_cluster_search_connections[0].connection_alias #=> String
resp.cross_cluster_search_connections[0].connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "VALIDATING", "VALIDATION_FAILED", "PROVISIONING", "ACTIVE", "REJECTED", "DELETING", "DELETED"
resp.cross_cluster_search_connections[0].connection_status.message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::Filter>) —

    A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are: * cross-cluster-search-connection-id * destination-domain-info.domain-name * destination-domain-info.owner-id * destination-domain-info.region * source-domain-info.domain-name

  • :max_results (Integer) —

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • :next_token (String) —

    NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.

Returns:



2137
2138
2139
2140
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2137

def describe_outbound_cross_cluster_search_connections(params = {}, options = {})
  req = build_request(:describe_outbound_cross_cluster_search_connections, params)
  req.send_request(options)
end

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

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

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_packages({
  filters: [
    {
      name: "PackageID", # accepts PackageID, PackageName, PackageStatus
      value: ["DescribePackagesFilterValue"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.package_details_list #=> Array
resp.package_details_list[0].package_id #=> String
resp.package_details_list[0].package_name #=> String
resp.package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
resp.package_details_list[0].package_description #=> String
resp.package_details_list[0].package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
resp.package_details_list[0].created_at #=> Time
resp.package_details_list[0].last_updated_at #=> Time
resp.package_details_list[0].available_package_version #=> String
resp.package_details_list[0].error_details.error_type #=> String
resp.package_details_list[0].error_details.error_message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :filters (Array<Types::DescribePackagesFilter>) —

    Only returns packages that match the DescribePackagesFilterList values.

  • :max_results (Integer) —

    Limits results to a maximum number of packages.

  • :next_token (String) —

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Returns:



2194
2195
2196
2197
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2194

def describe_packages(params = {}, options = {})
  req = build_request(:describe_packages, params)
  req.send_request(options)
end

#describe_reserved_elasticsearch_instance_offerings(params = {}) ⇒ Types::DescribeReservedElasticsearchInstanceOfferingsResponse

Lists available reserved Elasticsearch instance offerings.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_elasticsearch_instance_offerings({
  reserved_elasticsearch_instance_offering_id: "GUID",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.reserved_elasticsearch_instance_offerings #=> Array
resp.reserved_elasticsearch_instance_offerings[0].reserved_elasticsearch_instance_offering_id #=> String
resp.reserved_elasticsearch_instance_offerings[0].elasticsearch_instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.reserved_elasticsearch_instance_offerings[0].duration #=> Integer
resp.reserved_elasticsearch_instance_offerings[0].fixed_price #=> Float
resp.reserved_elasticsearch_instance_offerings[0].usage_price #=> Float
resp.reserved_elasticsearch_instance_offerings[0].currency_code #=> String
resp.reserved_elasticsearch_instance_offerings[0].payment_option #=> String, one of "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT"
resp.reserved_elasticsearch_instance_offerings[0].recurring_charges #=> Array
resp.reserved_elasticsearch_instance_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_elasticsearch_instance_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_elasticsearch_instance_offering_id (String) —

    The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

  • :max_results (Integer) —

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • :next_token (String) —

    NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

Returns:



2246
2247
2248
2249
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2246

def describe_reserved_elasticsearch_instance_offerings(params = {}, options = {})
  req = build_request(:describe_reserved_elasticsearch_instance_offerings, params)
  req.send_request(options)
end

#describe_reserved_elasticsearch_instances(params = {}) ⇒ Types::DescribeReservedElasticsearchInstancesResponse

Returns information about reserved Elasticsearch instances for this account.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.describe_reserved_elasticsearch_instances({
  reserved_elasticsearch_instance_id: "GUID",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.reserved_elasticsearch_instances #=> Array
resp.reserved_elasticsearch_instances[0].reservation_name #=> String
resp.reserved_elasticsearch_instances[0].reserved_elasticsearch_instance_id #=> String
resp.reserved_elasticsearch_instances[0].reserved_elasticsearch_instance_offering_id #=> String
resp.reserved_elasticsearch_instances[0].elasticsearch_instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.reserved_elasticsearch_instances[0].start_time #=> Time
resp.reserved_elasticsearch_instances[0].duration #=> Integer
resp.reserved_elasticsearch_instances[0].fixed_price #=> Float
resp.reserved_elasticsearch_instances[0].usage_price #=> Float
resp.reserved_elasticsearch_instances[0].currency_code #=> String
resp.reserved_elasticsearch_instances[0].elasticsearch_instance_count #=> Integer
resp.reserved_elasticsearch_instances[0].state #=> String
resp.reserved_elasticsearch_instances[0].payment_option #=> String, one of "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT"
resp.reserved_elasticsearch_instances[0].recurring_charges #=> Array
resp.reserved_elasticsearch_instances[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_elasticsearch_instances[0].recurring_charges[0].recurring_charge_frequency #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_elasticsearch_instance_id (String) —

    The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

  • :max_results (Integer) —

    Set this value to limit the number of results returned. If not specified, defaults to 100.

  • :next_token (String) —

    NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

Returns:



2304
2305
2306
2307
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2304

def describe_reserved_elasticsearch_instances(params = {}, options = {})
  req = build_request(:describe_reserved_elasticsearch_instances, params)
  req.send_request(options)
end

#describe_vpc_endpoints(params = {}) ⇒ Types::DescribeVpcEndpointsResponse

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Examples:

Request syntax with placeholder values


resp = client.describe_vpc_endpoints({
  vpc_endpoint_ids: ["VpcEndpointId"], # required
})

Response structure


resp.vpc_endpoints #=> Array
resp.vpc_endpoints[0].vpc_endpoint_id #=> String
resp.vpc_endpoints[0].vpc_endpoint_owner #=> String
resp.vpc_endpoints[0].domain_arn #=> String
resp.vpc_endpoints[0].vpc_options.vpc_id #=> String
resp.vpc_endpoints[0].vpc_options.subnet_ids #=> Array
resp.vpc_endpoints[0].vpc_options.subnet_ids[0] #=> String
resp.vpc_endpoints[0].vpc_options.availability_zones #=> Array
resp.vpc_endpoints[0].vpc_options.availability_zones[0] #=> String
resp.vpc_endpoints[0].vpc_options.security_group_ids #=> Array
resp.vpc_endpoints[0].vpc_options.security_group_ids[0] #=> String
resp.vpc_endpoints[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.vpc_endpoints[0].endpoint #=> String
resp.vpc_endpoint_errors #=> Array
resp.vpc_endpoint_errors[0].vpc_endpoint_id #=> String
resp.vpc_endpoint_errors[0].error_code #=> String, one of "ENDPOINT_NOT_FOUND", "SERVER_ERROR"
resp.vpc_endpoint_errors[0].error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_endpoint_ids (required, Array<String>) —

    The unique identifiers of the endpoints to get information about.

Returns:



2347
2348
2349
2350
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2347

def describe_vpc_endpoints(params = {}, options = {})
  req = build_request(:describe_vpc_endpoints, params)
  req.send_request(options)
end

#dissociate_package(params = {}) ⇒ Types::DissociatePackageResponse

Dissociates a package from the Amazon ES domain.

Examples:

Request syntax with placeholder values


resp = client.dissociate_package({
  package_id: "PackageID", # required
  domain_name: "DomainName", # required
})

Response structure


resp.domain_package_details.package_id #=> String
resp.domain_package_details.package_name #=> String
resp.domain_package_details.package_type #=> String, one of "TXT-DICTIONARY"
resp.domain_package_details.last_updated #=> Time
resp.domain_package_details.domain_name #=> String
resp.domain_package_details.domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
resp.domain_package_details.package_version #=> String
resp.domain_package_details.reference_path #=> String
resp.domain_package_details.error_details.error_type #=> String
resp.domain_package_details.error_details.error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_id (required, String) —

    Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.

  • :domain_name (required, String) —

    Name of the domain that you want to associate the package with.

Returns:



2387
2388
2389
2390
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2387

def dissociate_package(params = {}, options = {})
  req = build_request(:dissociate_package, params)
  req.send_request(options)
end

#get_compatible_elasticsearch_versions(params = {}) ⇒ Types::GetCompatibleElasticsearchVersionsResponse

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.

Examples:

Request syntax with placeholder values


resp = client.get_compatible_elasticsearch_versions({
  domain_name: "DomainName",
})

Response structure


resp.compatible_elasticsearch_versions #=> Array
resp.compatible_elasticsearch_versions[0].source_version #=> String
resp.compatible_elasticsearch_versions[0].target_versions #=> Array
resp.compatible_elasticsearch_versions[0].target_versions[0] #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (String) —

    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:



2421
2422
2423
2424
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2421

def get_compatible_elasticsearch_versions(params = {}, options = {})
  req = build_request(:get_compatible_elasticsearch_versions, params)
  req.send_request(options)
end

#get_package_version_history(params = {}) ⇒ Types::GetPackageVersionHistoryResponse

Returns a list of versions of the package, along with their creation time and commit message.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_package_version_history({
  package_id: "PackageID", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.package_id #=> String
resp.package_version_history_list #=> Array
resp.package_version_history_list[0].package_version #=> String
resp.package_version_history_list[0].commit_message #=> String
resp.package_version_history_list[0].created_at #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_id (required, String) —

    Returns an audit history of versions of the package.

  • :max_results (Integer) —

    Limits results to a maximum number of versions.

  • :next_token (String) —

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Returns:



2467
2468
2469
2470
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2467

def get_package_version_history(params = {}, options = {})
  req = build_request(:get_package_version_history, params)
  req.send_request(options)
end

#get_upgrade_history(params = {}) ⇒ Types::GetUpgradeHistoryResponse

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.get_upgrade_history({
  domain_name: "DomainName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.upgrade_histories #=> Array
resp.upgrade_histories[0].upgrade_name #=> String
resp.upgrade_histories[0].start_timestamp #=> Time
resp.upgrade_histories[0].upgrade_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "SUCCEEDED_WITH_ISSUES", "FAILED"
resp.upgrade_histories[0].steps_list #=> Array
resp.upgrade_histories[0].steps_list[0].upgrade_step #=> String, one of "PRE_UPGRADE_CHECK", "SNAPSHOT", "UPGRADE"
resp.upgrade_histories[0].steps_list[0].upgrade_step_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "SUCCEEDED_WITH_ISSUES", "FAILED"
resp.upgrade_histories[0].steps_list[0].issues #=> Array
resp.upgrade_histories[0].steps_list[0].issues[0] #=> String
resp.upgrade_histories[0].steps_list[0].progress_percent #=> Float
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • :max_results (Integer) —

    Set this value to limit the number of results returned.

  • :next_token (String) —

    Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Returns:



2520
2521
2522
2523
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2520

def get_upgrade_history(params = {}, options = {})
  req = build_request(:get_upgrade_history, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.get_upgrade_status({
  domain_name: "DomainName", # required
})

Response structure


resp.upgrade_step #=> String, one of "PRE_UPGRADE_CHECK", "SNAPSHOT", "UPGRADE"
resp.step_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "SUCCEEDED_WITH_ISSUES", "FAILED"
resp.upgrade_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

Returns:



2554
2555
2556
2557
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2554

def get_upgrade_status(params = {}, options = {})
  req = build_request(:get_upgrade_status, params)
  req.send_request(options)
end

#list_domain_names(params = {}) ⇒ Types::ListDomainNamesResponse

Returns the name of all Elasticsearch domains owned by the current user's account.

Examples:

Request syntax with placeholder values


resp = client.list_domain_names({
  engine_type: "OpenSearch", # accepts OpenSearch, Elasticsearch
})

Response structure


resp.domain_names #=> Array
resp.domain_names[0].domain_name #=> String
resp.domain_names[0].engine_type #=> String, one of "OpenSearch", "Elasticsearch"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :engine_type (String) —

    Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.

Returns:



2584
2585
2586
2587
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2584

def list_domain_names(params = {}, options = {})
  req = build_request(:list_domain_names, params)
  req.send_request(options)
end

#list_domains_for_package(params = {}) ⇒ Types::ListDomainsForPackageResponse

Lists all Amazon ES domains associated with the package.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_domains_for_package({
  package_id: "PackageID", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.domain_package_details_list #=> Array
resp.domain_package_details_list[0].package_id #=> String
resp.domain_package_details_list[0].package_name #=> String
resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
resp.domain_package_details_list[0].last_updated #=> Time
resp.domain_package_details_list[0].domain_name #=> String
resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
resp.domain_package_details_list[0].package_version #=> String
resp.domain_package_details_list[0].reference_path #=> String
resp.domain_package_details_list[0].error_details.error_type #=> String
resp.domain_package_details_list[0].error_details.error_message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_id (required, String) —

    The package for which to list domains.

  • :max_results (Integer) —

    Limits results to a maximum number of domains.

  • :next_token (String) —

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Returns:



2634
2635
2636
2637
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2634

def list_domains_for_package(params = {}, options = {})
  req = build_request(:list_domains_for_package, params)
  req.send_request(options)
end

#list_elasticsearch_instance_types(params = {}) ⇒ Types::ListElasticsearchInstanceTypesResponse

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_elasticsearch_instance_types({
  elasticsearch_version: "ElasticsearchVersionString", # required
  domain_name: "DomainName",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.elasticsearch_instance_types #=> Array
resp.elasticsearch_instance_types[0] #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :elasticsearch_version (required, String) —

    Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

  • :domain_name (String) —

    DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

  • :max_results (Integer) —

    Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

  • :next_token (String) —

    NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.

Returns:



2683
2684
2685
2686
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2683

def list_elasticsearch_instance_types(params = {}, options = {})
  req = build_request(:list_elasticsearch_instance_types, params)
  req.send_request(options)
end

#list_elasticsearch_versions(params = {}) ⇒ Types::ListElasticsearchVersionsResponse

List all supported Elasticsearch versions

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_elasticsearch_versions({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.elasticsearch_versions #=> Array
resp.elasticsearch_versions[0] #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :max_results (Integer) —

    Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.

  • :next_token (String) —

    Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client to retrieve more results.

Returns:



2721
2722
2723
2724
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2721

def list_elasticsearch_versions(params = {}, options = {})
  req = build_request(:list_elasticsearch_versions, params)
  req.send_request(options)
end

#list_packages_for_domain(params = {}) ⇒ Types::ListPackagesForDomainResponse

Lists all packages associated with the Amazon ES domain.

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

Examples:

Request syntax with placeholder values


resp = client.list_packages_for_domain({
  domain_name: "DomainName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.domain_package_details_list #=> Array
resp.domain_package_details_list[0].package_id #=> String
resp.domain_package_details_list[0].package_name #=> String
resp.domain_package_details_list[0].package_type #=> String, one of "TXT-DICTIONARY"
resp.domain_package_details_list[0].last_updated #=> Time
resp.domain_package_details_list[0].domain_name #=> String
resp.domain_package_details_list[0].domain_package_status #=> String, one of "ASSOCIATING", "ASSOCIATION_FAILED", "ACTIVE", "DISSOCIATING", "DISSOCIATION_FAILED"
resp.domain_package_details_list[0].package_version #=> String
resp.domain_package_details_list[0].reference_path #=> String
resp.domain_package_details_list[0].error_details.error_type #=> String
resp.domain_package_details_list[0].error_details.error_message #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain for which you want to list associated packages.

  • :max_results (Integer) —

    Limits results to a maximum number of packages.

  • :next_token (String) —

    Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.

Returns:



2771
2772
2773
2774
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2771

def list_packages_for_domain(params = {}, options = {})
  req = build_request(:list_packages_for_domain, params)
  req.send_request(options)
end

#list_tags(params = {}) ⇒ Types::ListTagsResponse

Returns all tags for the given Elasticsearch domain.

Examples:

Request syntax with placeholder values


resp = client.list_tags({
  arn: "ARN", # required
})

Response structure


resp.tag_list #=> Array
resp.tag_list[0].key #=> String
resp.tag_list[0].value #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.

Returns:



2800
2801
2802
2803
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2800

def list_tags(params = {}, options = {})
  req = build_request(:list_tags, params)
  req.send_request(options)
end

#list_vpc_endpoint_access(params = {}) ⇒ Types::ListVpcEndpointAccessResponse

Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.list_vpc_endpoint_access({
  domain_name: "DomainName", # required
  next_token: "NextToken",
})

Response structure


resp.authorized_principal_list #=> Array
resp.authorized_principal_list[0].principal_type #=> String, one of "AWS_ACCOUNT", "AWS_SERVICE"
resp.authorized_principal_list[0].principal #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the OpenSearch Service domain to retrieve access information for.

  • :next_token (String) —

    Provides an identifier to allow retrieval of paginated results.

Returns:



2837
2838
2839
2840
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2837

def list_vpc_endpoint_access(params = {}, options = {})
  req = build_request(:list_vpc_endpoint_access, params)
  req.send_request(options)
end

#list_vpc_endpoints(params = {}) ⇒ Types::ListVpcEndpointsResponse

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.

Examples:

Request syntax with placeholder values


resp = client.list_vpc_endpoints({
  next_token: "NextToken",
})

Response structure


resp.vpc_endpoint_summary_list #=> Array
resp.vpc_endpoint_summary_list[0].vpc_endpoint_id #=> String
resp.vpc_endpoint_summary_list[0].vpc_endpoint_owner #=> String
resp.vpc_endpoint_summary_list[0].domain_arn #=> String
resp.vpc_endpoint_summary_list[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :next_token (String) —

    Identifier to allow retrieval of paginated results.

Returns:



2870
2871
2872
2873
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2870

def list_vpc_endpoints(params = {}, options = {})
  req = build_request(:list_vpc_endpoints, params)
  req.send_request(options)
end

#list_vpc_endpoints_for_domain(params = {}) ⇒ Types::ListVpcEndpointsForDomainResponse

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Examples:

Request syntax with placeholder values


resp = client.list_vpc_endpoints_for_domain({
  domain_name: "DomainName", # required
  next_token: "NextToken",
})

Response structure


resp.vpc_endpoint_summary_list #=> Array
resp.vpc_endpoint_summary_list[0].vpc_endpoint_id #=> String
resp.vpc_endpoint_summary_list[0].vpc_endpoint_owner #=> String
resp.vpc_endpoint_summary_list[0].domain_arn #=> String
resp.vpc_endpoint_summary_list[0].status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    Name of the ElasticSearch domain whose VPC endpoints are to be listed.

  • :next_token (String) —

    Provides an identifier to allow retrieval of paginated results.

Returns:



2907
2908
2909
2910
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2907

def list_vpc_endpoints_for_domain(params = {}, options = {})
  req = build_request(:list_vpc_endpoints_for_domain, params)
  req.send_request(options)
end

#purchase_reserved_elasticsearch_instance_offering(params = {}) ⇒ Types::PurchaseReservedElasticsearchInstanceOfferingResponse

Allows you to purchase reserved Elasticsearch instances.

Examples:

Request syntax with placeholder values


resp = client.purchase_reserved_elasticsearch_instance_offering({
  reserved_elasticsearch_instance_offering_id: "GUID", # required
  reservation_name: "ReservationToken", # required
  instance_count: 1,
})

Response structure


resp.reserved_elasticsearch_instance_id #=> String
resp.reservation_name #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :reserved_elasticsearch_instance_offering_id (required, String) —

    The ID of the reserved Elasticsearch instance offering to purchase.

  • :reservation_name (required, String) —

    A customer-specified identifier to track this reservation.

  • :instance_count (Integer) —

    The number of Elasticsearch instances to reserve.

Returns:



2943
2944
2945
2946
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2943

def purchase_reserved_elasticsearch_instance_offering(params = {}, options = {})
  req = build_request(:purchase_reserved_elasticsearch_instance_offering, params)
  req.send_request(options)
end

#reject_inbound_cross_cluster_search_connection(params = {}) ⇒ Types::RejectInboundCrossClusterSearchConnectionResponse

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Examples:

Request syntax with placeholder values


resp = client.reject_inbound_cross_cluster_search_connection({
  cross_cluster_search_connection_id: "CrossClusterSearchConnectionId", # required
})

Response structure


resp.cross_cluster_search_connection.source_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.source_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.source_domain_info.region #=> String
resp.cross_cluster_search_connection.destination_domain_info.owner_id #=> String
resp.cross_cluster_search_connection.destination_domain_info.domain_name #=> String
resp.cross_cluster_search_connection.destination_domain_info.region #=> String
resp.cross_cluster_search_connection.cross_cluster_search_connection_id #=> String
resp.cross_cluster_search_connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.cross_cluster_search_connection.connection_status.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :cross_cluster_search_connection_id (required, String) —

    The id of the inbound connection that you want to reject.

Returns:



2978
2979
2980
2981
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 2978

def reject_inbound_cross_cluster_search_connection(params = {}, options = {})
  req = build_request(:reject_inbound_cross_cluster_search_connection, params)
  req.send_request(options)
end

#remove_tags(params = {}) ⇒ Struct

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

Examples:

Request syntax with placeholder values


resp = client.remove_tags({
  arn: "ARN", # required
  tag_keys: ["String"], # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :arn (required, String) —

    Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

  • :tag_keys (required, Array<String>) —

    Specifies the TagKey list which you want to remove from the Elasticsearch domain.

Returns:

  • (Struct) —

    Returns an empty response.



3005
3006
3007
3008
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3005

def remove_tags(params = {}, options = {})
  req = build_request(:remove_tags, params)
  req.send_request(options)
end

#revoke_vpc_endpoint_access(params = {}) ⇒ Struct

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.revoke_vpc_endpoint_access({
  domain_name: "DomainName", # required
  account: "AWSAccount", # required
})

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the OpenSearch Service domain.

  • :account (required, String) —

    The account ID to revoke access from.

Returns:

  • (Struct) —

    Returns an empty response.



3030
3031
3032
3033
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3030

def revoke_vpc_endpoint_access(params = {}, options = {})
  req = build_request(:revoke_vpc_endpoint_access, params)
  req.send_request(options)
end

#start_elasticsearch_service_software_update(params = {}) ⇒ Types::StartElasticsearchServiceSoftwareUpdateResponse

Schedules a service software update for an Amazon ES domain.

Examples:

Request syntax with placeholder values


resp = client.start_elasticsearch_service_software_update({
  domain_name: "DomainName", # required
})

Response structure


resp.service_software_options.current_version #=> String
resp.service_software_options.new_version #=> String
resp.service_software_options.update_available #=> Boolean
resp.service_software_options.cancellable #=> Boolean
resp.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.service_software_options.description #=> String
resp.service_software_options.automated_update_date #=> Time
resp.service_software_options.optional_deployment #=> Boolean

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain that you want to update to the latest service software.

Returns:



3064
3065
3066
3067
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3064

def start_elasticsearch_service_software_update(params = {}, options = {})
  req = build_request(:start_elasticsearch_service_software_update, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.update_elasticsearch_domain_config({
  domain_name: "DomainName", # required
  elasticsearch_cluster_config: {
    instance_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
    instance_count: 1,
    dedicated_master_enabled: false,
    zone_awareness_enabled: false,
    zone_awareness_config: {
      availability_zone_count: 1,
    },
    dedicated_master_type: "m3.medium.elasticsearch", # accepts m3.medium.elasticsearch, m3.large.elasticsearch, m3.xlarge.elasticsearch, m3.2xlarge.elasticsearch, m4.large.elasticsearch, m4.xlarge.elasticsearch, m4.2xlarge.elasticsearch, m4.4xlarge.elasticsearch, m4.10xlarge.elasticsearch, m5.large.elasticsearch, m5.xlarge.elasticsearch, m5.2xlarge.elasticsearch, m5.4xlarge.elasticsearch, m5.12xlarge.elasticsearch, r5.large.elasticsearch, r5.xlarge.elasticsearch, r5.2xlarge.elasticsearch, r5.4xlarge.elasticsearch, r5.12xlarge.elasticsearch, c5.large.elasticsearch, c5.xlarge.elasticsearch, c5.2xlarge.elasticsearch, c5.4xlarge.elasticsearch, c5.9xlarge.elasticsearch, c5.18xlarge.elasticsearch, ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch, t2.micro.elasticsearch, t2.small.elasticsearch, t2.medium.elasticsearch, r3.large.elasticsearch, r3.xlarge.elasticsearch, r3.2xlarge.elasticsearch, r3.4xlarge.elasticsearch, r3.8xlarge.elasticsearch, i2.xlarge.elasticsearch, i2.2xlarge.elasticsearch, d2.xlarge.elasticsearch, d2.2xlarge.elasticsearch, d2.4xlarge.elasticsearch, d2.8xlarge.elasticsearch, c4.large.elasticsearch, c4.xlarge.elasticsearch, c4.2xlarge.elasticsearch, c4.4xlarge.elasticsearch, c4.8xlarge.elasticsearch, r4.large.elasticsearch, r4.xlarge.elasticsearch, r4.2xlarge.elasticsearch, r4.4xlarge.elasticsearch, r4.8xlarge.elasticsearch, r4.16xlarge.elasticsearch, i3.large.elasticsearch, i3.xlarge.elasticsearch, i3.2xlarge.elasticsearch, i3.4xlarge.elasticsearch, i3.8xlarge.elasticsearch, i3.16xlarge.elasticsearch
    dedicated_master_count: 1,
    warm_enabled: false,
    warm_type: "ultrawarm1.medium.elasticsearch", # accepts ultrawarm1.medium.elasticsearch, ultrawarm1.large.elasticsearch
    warm_count: 1,
    cold_storage_options: {
      enabled: false, # required
    },
  },
  ebs_options: {
    ebs_enabled: false,
    volume_type: "standard", # accepts standard, gp2, io1, gp3
    volume_size: 1,
    iops: 1,
    throughput: 1,
  },
  snapshot_options: {
    automated_snapshot_start_hour: 1,
  },
  vpc_options: {
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
  cognito_options: {
    enabled: false,
    user_pool_id: "UserPoolId",
    identity_pool_id: "IdentityPoolId",
    role_arn: "RoleArn",
  },
  advanced_options: {
    "String" => "String",
  },
  access_policies: "PolicyDocument",
  log_publishing_options: {
    "INDEX_SLOW_LOGS" => {
      cloud_watch_logs_log_group_arn: "CloudWatchLogsLogGroupArn",
      enabled: false,
    },
  },
  domain_endpoint_options: {
    enforce_https: false,
    tls_security_policy: "Policy-Min-TLS-1-0-2019-07", # accepts Policy-Min-TLS-1-0-2019-07, Policy-Min-TLS-1-2-2019-07, Policy-Min-TLS-1-2-PFS-2023-10, Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08
    custom_endpoint_enabled: false,
    custom_endpoint: "DomainNameFqdn",
    custom_endpoint_certificate_arn: "ARN",
  },
  advanced_security_options: {
    enabled: false,
    internal_user_database_enabled: false,
    master_user_options: {
      master_user_arn: "ARN",
      master_user_name: "Username",
      master_user_password: "Password",
    },
    saml_options: {
      enabled: false,
      idp: {
        metadata_content: "SAMLMetadata", # required
        entity_id: "SAMLEntityId", # required
      },
      master_user_name: "Username",
      master_backend_role: "BackendRole",
      subject_key: "String",
      roles_key: "String",
      session_timeout_minutes: 1,
    },
    anonymous_auth_enabled: false,
  },
  node_to_node_encryption_options: {
    enabled: false,
  },
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "KmsKeyId",
  },
  auto_tune_options: {
    desired_state: "ENABLED", # accepts ENABLED, DISABLED
    rollback_on_disable: "NO_ROLLBACK", # accepts NO_ROLLBACK, DEFAULT_ROLLBACK
    maintenance_schedules: [
      {
        start_at: Time.now,
        duration: {
          value: 1,
          unit: "HOURS", # accepts HOURS
        },
        cron_expression_for_recurrence: "String",
      },
    ],
  },
  dry_run: false,
  deployment_strategy_options: {
    deployment_strategy: "Default", # required, accepts Default, CapacityOptimized
  },
  automated_snapshot_pause_options: {
    enabled: false, # required
    start_time: Time.now,
    end_time: Time.now,
  },
})

Response structure


resp.domain_config.elasticsearch_version.options #=> String
resp.domain_config.elasticsearch_version.status.creation_date #=> Time
resp.domain_config.elasticsearch_version.status.update_date #=> Time
resp.domain_config.elasticsearch_version.status.update_version #=> Integer
resp.domain_config.elasticsearch_version.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.elasticsearch_version.status.pending_deletion #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.instance_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_config.elasticsearch_cluster_config.options.instance_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.dedicated_master_enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.zone_awareness_enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.dedicated_master_type #=> String, one of "m3.medium.elasticsearch", "m3.large.elasticsearch", "m3.xlarge.elasticsearch", "m3.2xlarge.elasticsearch", "m4.large.elasticsearch", "m4.xlarge.elasticsearch", "m4.2xlarge.elasticsearch", "m4.4xlarge.elasticsearch", "m4.10xlarge.elasticsearch", "m5.large.elasticsearch", "m5.xlarge.elasticsearch", "m5.2xlarge.elasticsearch", "m5.4xlarge.elasticsearch", "m5.12xlarge.elasticsearch", "r5.large.elasticsearch", "r5.xlarge.elasticsearch", "r5.2xlarge.elasticsearch", "r5.4xlarge.elasticsearch", "r5.12xlarge.elasticsearch", "c5.large.elasticsearch", "c5.xlarge.elasticsearch", "c5.2xlarge.elasticsearch", "c5.4xlarge.elasticsearch", "c5.9xlarge.elasticsearch", "c5.18xlarge.elasticsearch", "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch", "t2.micro.elasticsearch", "t2.small.elasticsearch", "t2.medium.elasticsearch", "r3.large.elasticsearch", "r3.xlarge.elasticsearch", "r3.2xlarge.elasticsearch", "r3.4xlarge.elasticsearch", "r3.8xlarge.elasticsearch", "i2.xlarge.elasticsearch", "i2.2xlarge.elasticsearch", "d2.xlarge.elasticsearch", "d2.2xlarge.elasticsearch", "d2.4xlarge.elasticsearch", "d2.8xlarge.elasticsearch", "c4.large.elasticsearch", "c4.xlarge.elasticsearch", "c4.2xlarge.elasticsearch", "c4.4xlarge.elasticsearch", "c4.8xlarge.elasticsearch", "r4.large.elasticsearch", "r4.xlarge.elasticsearch", "r4.2xlarge.elasticsearch", "r4.4xlarge.elasticsearch", "r4.8xlarge.elasticsearch", "r4.16xlarge.elasticsearch", "i3.large.elasticsearch", "i3.xlarge.elasticsearch", "i3.2xlarge.elasticsearch", "i3.4xlarge.elasticsearch", "i3.8xlarge.elasticsearch", "i3.16xlarge.elasticsearch"
resp.domain_config.elasticsearch_cluster_config.options.dedicated_master_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.warm_enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.elasticsearch", "ultrawarm1.large.elasticsearch"
resp.domain_config.elasticsearch_cluster_config.options.warm_count #=> Integer
resp.domain_config.elasticsearch_cluster_config.options.cold_storage_options.enabled #=> Boolean
resp.domain_config.elasticsearch_cluster_config.status.creation_date #=> Time
resp.domain_config.elasticsearch_cluster_config.status.update_date #=> Time
resp.domain_config.elasticsearch_cluster_config.status.update_version #=> Integer
resp.domain_config.elasticsearch_cluster_config.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.elasticsearch_cluster_config.status.pending_deletion #=> Boolean
resp.domain_config.ebs_options.options.ebs_enabled #=> Boolean
resp.domain_config.ebs_options.options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
resp.domain_config.ebs_options.options.volume_size #=> Integer
resp.domain_config.ebs_options.options.iops #=> Integer
resp.domain_config.ebs_options.options.throughput #=> Integer
resp.domain_config.ebs_options.status.creation_date #=> Time
resp.domain_config.ebs_options.status.update_date #=> Time
resp.domain_config.ebs_options.status.update_version #=> Integer
resp.domain_config.ebs_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.ebs_options.status.pending_deletion #=> Boolean
resp.domain_config.access_policies.options #=> String
resp.domain_config.access_policies.status.creation_date #=> Time
resp.domain_config.access_policies.status.update_date #=> Time
resp.domain_config.access_policies.status.update_version #=> Integer
resp.domain_config.access_policies.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.access_policies.status.pending_deletion #=> Boolean
resp.domain_config.snapshot_options.options.automated_snapshot_start_hour #=> Integer
resp.domain_config.snapshot_options.status.creation_date #=> Time
resp.domain_config.snapshot_options.status.update_date #=> Time
resp.domain_config.snapshot_options.status.update_version #=> Integer
resp.domain_config.snapshot_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.snapshot_options.status.pending_deletion #=> Boolean
resp.domain_config.vpc_options.options.vpc_id #=> String
resp.domain_config.vpc_options.options.subnet_ids #=> Array
resp.domain_config.vpc_options.options.subnet_ids[0] #=> String
resp.domain_config.vpc_options.options.availability_zones #=> Array
resp.domain_config.vpc_options.options.availability_zones[0] #=> String
resp.domain_config.vpc_options.options.security_group_ids #=> Array
resp.domain_config.vpc_options.options.security_group_ids[0] #=> String
resp.domain_config.vpc_options.status.creation_date #=> Time
resp.domain_config.vpc_options.status.update_date #=> Time
resp.domain_config.vpc_options.status.update_version #=> Integer
resp.domain_config.vpc_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.vpc_options.status.pending_deletion #=> Boolean
resp.domain_config.cognito_options.options.enabled #=> Boolean
resp.domain_config.cognito_options.options.user_pool_id #=> String
resp.domain_config.cognito_options.options.identity_pool_id #=> String
resp.domain_config.cognito_options.options.role_arn #=> String
resp.domain_config.cognito_options.status.creation_date #=> Time
resp.domain_config.cognito_options.status.update_date #=> Time
resp.domain_config.cognito_options.status.update_version #=> Integer
resp.domain_config.cognito_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.cognito_options.status.pending_deletion #=> Boolean
resp.domain_config.encryption_at_rest_options.options.enabled #=> Boolean
resp.domain_config.encryption_at_rest_options.options.kms_key_id #=> String
resp.domain_config.encryption_at_rest_options.status.creation_date #=> Time
resp.domain_config.encryption_at_rest_options.status.update_date #=> Time
resp.domain_config.encryption_at_rest_options.status.update_version #=> Integer
resp.domain_config.encryption_at_rest_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.encryption_at_rest_options.status.pending_deletion #=> Boolean
resp.domain_config.node_to_node_encryption_options.options.enabled #=> Boolean
resp.domain_config.node_to_node_encryption_options.status.creation_date #=> Time
resp.domain_config.node_to_node_encryption_options.status.update_date #=> Time
resp.domain_config.node_to_node_encryption_options.status.update_version #=> Integer
resp.domain_config.node_to_node_encryption_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.node_to_node_encryption_options.status.pending_deletion #=> Boolean
resp.domain_config.advanced_options.options #=> Hash
resp.domain_config.advanced_options.options["String"] #=> String
resp.domain_config.advanced_options.status.creation_date #=> Time
resp.domain_config.advanced_options.status.update_date #=> Time
resp.domain_config.advanced_options.status.update_version #=> Integer
resp.domain_config.advanced_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.advanced_options.status.pending_deletion #=> Boolean
resp.domain_config.log_publishing_options.options #=> Hash
resp.domain_config.log_publishing_options.options["LogType"].cloud_watch_logs_log_group_arn #=> String
resp.domain_config.log_publishing_options.options["LogType"].enabled #=> Boolean
resp.domain_config.log_publishing_options.status.creation_date #=> Time
resp.domain_config.log_publishing_options.status.update_date #=> Time
resp.domain_config.log_publishing_options.status.update_version #=> Integer
resp.domain_config.log_publishing_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.log_publishing_options.status.pending_deletion #=> Boolean
resp.domain_config.domain_endpoint_options.options.enforce_https #=> Boolean
resp.domain_config.domain_endpoint_options.options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07", "Policy-Min-TLS-1-2-PFS-2023-10", "Policy-Min-TLS-1-2-RFC9151-FIPS-2024-08"
resp.domain_config.domain_endpoint_options.options.custom_endpoint_enabled #=> Boolean
resp.domain_config.domain_endpoint_options.options.custom_endpoint #=> String
resp.domain_config.domain_endpoint_options.options.custom_endpoint_certificate_arn #=> String
resp.domain_config.domain_endpoint_options.status.creation_date #=> Time
resp.domain_config.domain_endpoint_options.status.update_date #=> Time
resp.domain_config.domain_endpoint_options.status.update_version #=> Integer
resp.domain_config.domain_endpoint_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.domain_endpoint_options.status.pending_deletion #=> Boolean
resp.domain_config.advanced_security_options.options.enabled #=> Boolean
resp.domain_config.advanced_security_options.options.internal_user_database_enabled #=> Boolean
resp.domain_config.advanced_security_options.options.saml_options.enabled #=> Boolean
resp.domain_config.advanced_security_options.options.saml_options.idp.metadata_content #=> String
resp.domain_config.advanced_security_options.options.saml_options.idp.entity_id #=> String
resp.domain_config.advanced_security_options.options.saml_options.subject_key #=> String
resp.domain_config.advanced_security_options.options.saml_options.roles_key #=> String
resp.domain_config.advanced_security_options.options.saml_options.session_timeout_minutes #=> Integer
resp.domain_config.advanced_security_options.options.anonymous_auth_disable_date #=> Time
resp.domain_config.advanced_security_options.options.anonymous_auth_enabled #=> Boolean
resp.domain_config.advanced_security_options.status.creation_date #=> Time
resp.domain_config.advanced_security_options.status.update_date #=> Time
resp.domain_config.advanced_security_options.status.update_version #=> Integer
resp.domain_config.advanced_security_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.advanced_security_options.status.pending_deletion #=> Boolean
resp.domain_config.auto_tune_options.options.desired_state #=> String, one of "ENABLED", "DISABLED"
resp.domain_config.auto_tune_options.options.rollback_on_disable #=> String, one of "NO_ROLLBACK", "DEFAULT_ROLLBACK"
resp.domain_config.auto_tune_options.options.maintenance_schedules #=> Array
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].start_at #=> Time
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.value #=> Integer
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].duration.unit #=> String, one of "HOURS"
resp.domain_config.auto_tune_options.options.maintenance_schedules[0].cron_expression_for_recurrence #=> String
resp.domain_config.auto_tune_options.status.creation_date #=> Time
resp.domain_config.auto_tune_options.status.update_date #=> Time
resp.domain_config.auto_tune_options.status.update_version #=> Integer
resp.domain_config.auto_tune_options.status.state #=> String, one of "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DISABLED_AND_ROLLBACK_SCHEDULED", "DISABLED_AND_ROLLBACK_IN_PROGRESS", "DISABLED_AND_ROLLBACK_COMPLETE", "DISABLED_AND_ROLLBACK_ERROR", "ERROR"
resp.domain_config.auto_tune_options.status.error_message #=> String
resp.domain_config.auto_tune_options.status.pending_deletion #=> Boolean
resp.domain_config.change_progress_details.change_id #=> String
resp.domain_config.change_progress_details.message #=> String
resp.domain_config.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.domain_config.change_progress_details.start_time #=> Time
resp.domain_config.change_progress_details.last_updated_time #=> Time
resp.domain_config.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE"
resp.domain_config.modifying_properties #=> Array
resp.domain_config.modifying_properties[0].name #=> String
resp.domain_config.modifying_properties[0].active_value #=> String
resp.domain_config.modifying_properties[0].pending_value #=> String
resp.domain_config.modifying_properties[0].value_type #=> String, one of "PLAIN_TEXT", "STRINGIFIED_JSON"
resp.domain_config.deployment_strategy_options.options.deployment_strategy #=> String, one of "Default", "CapacityOptimized"
resp.domain_config.deployment_strategy_options.status.creation_date #=> Time
resp.domain_config.deployment_strategy_options.status.update_date #=> Time
resp.domain_config.deployment_strategy_options.status.update_version #=> Integer
resp.domain_config.deployment_strategy_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.deployment_strategy_options.status.pending_deletion #=> Boolean
resp.domain_config.automated_snapshot_pause_options.options.enabled #=> Boolean
resp.domain_config.automated_snapshot_pause_options.options.start_time #=> Time
resp.domain_config.automated_snapshot_pause_options.options.end_time #=> Time
resp.domain_config.automated_snapshot_pause_options.options.state #=> String, one of "Active", "Completed", "Scheduled", "Disabled"
resp.domain_config.automated_snapshot_pause_options.status.creation_date #=> Time
resp.domain_config.automated_snapshot_pause_options.status.update_date #=> Time
resp.domain_config.automated_snapshot_pause_options.status.update_version #=> Integer
resp.domain_config.automated_snapshot_pause_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.automated_snapshot_pause_options.status.pending_deletion #=> Boolean
resp.dry_run_results.deployment_type #=> String
resp.dry_run_results.message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the Elasticsearch domain that you are updating.

  • :elasticsearch_cluster_config (Types::ElasticsearchClusterConfig) —

    The type and number of instances to instantiate for the domain cluster.

  • :ebs_options (Types::EBSOptions) —

    Specify the type and size of the EBS volume that you want to use.

  • :snapshot_options (Types::SnapshotOptions) —

    Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

  • :vpc_options (Types::VPCOptions) —

    Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

  • :cognito_options (Types::CognitoOptions) —

    Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

  • :advanced_options (Hash<String,String>) —

    Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.

  • :access_policies (String) —

    IAM access policy as a JSON-formatted string.

  • :log_publishing_options (Hash<String,Types::LogPublishingOption>) —

    Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.

  • :domain_endpoint_options (Types::DomainEndpointOptions) —

    Options to specify configuration that will be applied to the domain endpoint.

  • :advanced_security_options (Types::AdvancedSecurityOptionsInput) —

    Specifies advanced security options.

  • :node_to_node_encryption_options (Types::NodeToNodeEncryptionOptions) —

    Specifies the NodeToNodeEncryptionOptions.

  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) —

    Specifies the Encryption At Rest Options.

  • :auto_tune_options (Types::AutoTuneOptions) —

    Specifies Auto-Tune options.

  • :dry_run (Boolean) —

    This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

  • :deployment_strategy_options (Types::DeploymentStrategyOptions) —

    Specifies the deployment strategy options.

  • :automated_snapshot_pause_options (Types::AutomatedSnapshotPauseRequestOptions) —

    Specifies the automated snapshot pause options for the domain.

    Suspending snapshots reduces data protection. You cannot restore your domain to points in time when snapshots are suspended. Use this feature only for short-term operational needs such as migrations or maintenance windows.

    Maximum suspension duration: 3 days.

Returns:



3440
3441
3442
3443
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3440

def update_elasticsearch_domain_config(params = {}, options = {})
  req = build_request(:update_elasticsearch_domain_config, params)
  req.send_request(options)
end

#update_package(params = {}) ⇒ Types::UpdatePackageResponse

Updates a package for use with Amazon ES domains.

Examples:

Request syntax with placeholder values


resp = client.update_package({
  package_id: "PackageID", # required
  package_source: { # required
    s3_bucket_name: "S3BucketName",
    s3_key: "S3Key",
  },
  package_description: "PackageDescription",
  commit_message: "CommitMessage",
})

Response structure


resp.package_details.package_id #=> String
resp.package_details.package_name #=> String
resp.package_details.package_type #=> String, one of "TXT-DICTIONARY"
resp.package_details.package_description #=> String
resp.package_details.package_status #=> String, one of "COPYING", "COPY_FAILED", "VALIDATING", "VALIDATION_FAILED", "AVAILABLE", "DELETING", "DELETED", "DELETE_FAILED"
resp.package_details.created_at #=> Time
resp.package_details.last_updated_at #=> Time
resp.package_details.available_package_version #=> String
resp.package_details.error_details.error_type #=> String
resp.package_details.error_details.error_message #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :package_id (required, String) —

    Unique identifier for the package.

  • :package_source (required, Types::PackageSource) —

    The S3 location for importing the package specified as S3BucketName and S3Key

  • :package_description (String) —

    New description of the package.

  • :commit_message (String) —

    An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.

Returns:



3492
3493
3494
3495
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3492

def update_package(params = {}, options = {})
  req = build_request(:update_package, params)
  req.send_request(options)
end

#update_vpc_endpoint(params = {}) ⇒ Types::UpdateVpcEndpointResponse

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Examples:

Request syntax with placeholder values


resp = client.update_vpc_endpoint({
  vpc_endpoint_id: "VpcEndpointId", # required
  vpc_options: { # required
    subnet_ids: ["String"],
    security_group_ids: ["String"],
  },
})

Response structure


resp.vpc_endpoint.vpc_endpoint_id #=> String
resp.vpc_endpoint.vpc_endpoint_owner #=> String
resp.vpc_endpoint.domain_arn #=> String
resp.vpc_endpoint.vpc_options.vpc_id #=> String
resp.vpc_endpoint.vpc_options.subnet_ids #=> Array
resp.vpc_endpoint.vpc_options.subnet_ids[0] #=> String
resp.vpc_endpoint.vpc_options.availability_zones #=> Array
resp.vpc_endpoint.vpc_options.availability_zones[0] #=> String
resp.vpc_endpoint.vpc_options.security_group_ids #=> Array
resp.vpc_endpoint.vpc_options.security_group_ids[0] #=> String
resp.vpc_endpoint.status #=> String, one of "CREATING", "CREATE_FAILED", "ACTIVE", "UPDATING", "UPDATE_FAILED", "DELETING", "DELETE_FAILED"
resp.vpc_endpoint.endpoint #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :vpc_endpoint_id (required, String) —

    Unique identifier of the VPC endpoint to be updated.

  • :vpc_options (required, Types::VPCOptions) —

    The security groups and/or subnets to add, remove, or modify.

Returns:



3536
3537
3538
3539
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3536

def update_vpc_endpoint(params = {}, options = {})
  req = build_request(:update_vpc_endpoint, params)
  req.send_request(options)
end

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

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

Examples:

Request syntax with placeholder values


resp = client.upgrade_elasticsearch_domain({
  domain_name: "DomainName", # required
  target_version: "ElasticsearchVersionString", # required
  perform_check_only: false,
})

Response structure


resp.domain_name #=> String
resp.target_version #=> String
resp.perform_check_only #=> Boolean
resp.change_progress_details.change_id #=> String
resp.change_progress_details.message #=> String
resp.change_progress_details.config_change_status #=> String, one of "Pending", "Initializing", "Validating", "ValidationFailed", "ApplyingChanges", "Completed", "PendingUserInput", "Cancelled"
resp.change_progress_details.start_time #=> Time
resp.change_progress_details.last_updated_time #=> Time
resp.change_progress_details.initiated_by #=> String, one of "CUSTOMER", "SERVICE"

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

  • :target_version (required, String) —

    The version of Elasticsearch that you intend to upgrade the domain to.

  • :perform_check_only (Boolean) —

    This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

Returns:



3587
3588
3589
3590
 
# File 'gems/aws-sdk-elasticsearchservice/lib/aws-sdk-elasticsearchservice/client.rb', line 3587

def upgrade_elasticsearch_domain(params = {}, options = {})
  req = build_request(:upgrade_elasticsearch_domain, params)
  req.send_request(options)
end