Class: Aws::OpenSearchService::Client

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

Overview

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

client = Aws::OpenSearchService::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):

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

    Your AWS credentials. This can be an 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, and :session_token options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
    • ~/.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::InstanceProfileCredentails 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)
  • :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.

  • :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 —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the :region option. You should only configure an :endpoint when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :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.

  • :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.

  • :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.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

  • :token_provider (Aws::TokenProvider) —

    A Bearer Token Provider. This can be an 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::OpenSearchService::EndpointProvider) —

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

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

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

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a Timeout::Error.

  • :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_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_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.

  • :ssl_timeout (Float) — default: nil —

    Sets the SSL timeout in seconds.

  • :http_wire_trace (Boolean) — default: false —

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

  • :ssl_verify_peer (Boolean) — default: true —

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

  • :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.



365
366
367
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 365

def initialize(*args)
  super
end

Instance Method Details

#accept_inbound_connection(params = {}) ⇒ Types::AcceptInboundConnectionResponse

Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Examples:

Request syntax with placeholder values


resp = client.accept_inbound_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
resp.connection.local_domain_info.aws_domain_information.region #=> String
resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
resp.connection.remote_domain_info.aws_domain_information.region #=> String
resp.connection.connection_id #=> String
resp.connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.connection.connection_status.message #=> String
resp.connection.connection_mode #=> String, one of "DIRECT", "VPC_ENDPOINT"

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String) —

    The ID of the inbound connection to accept.

Returns:

See Also:



410
411
412
413
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 410

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

#add_tags(params = {}) ⇒ Struct

Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.

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) —

    Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.

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

    List of resource tags.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



449
450
451
452
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 449

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 OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

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 to associate with a domain. Use DescribePackages to find this value.

  • :domain_name (required, String) —

    Name of the domain to associate the package with.

Returns:

See Also:



497
498
499
500
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 497

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 Amazon Web Services account ID to grant access to.

Returns:

See Also:



531
532
533
534
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 531

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

#cancel_service_software_update(params = {}) ⇒ Types::CancelServiceSoftwareUpdateResponse

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the domain's UpdateStatus is PENDING_UPDATE. For more information, see Service software updates in Amazon OpenSearch Service.

Examples:

Request syntax with placeholder values


resp = client.cancel_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) —

    Name of the OpenSearch Service domain that you want to cancel the service software update on.

Returns:

See Also:



575
576
577
578
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 575

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

#create_domain(params = {}) ⇒ Types::CreateDomainResponse

Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.

Examples:

Request syntax with placeholder values


resp = client.create_domain({
  domain_name: "DomainName", # required
  engine_version: "VersionString",
  cluster_config: {
    instance_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
    instance_count: 1,
    dedicated_master_enabled: false,
    zone_awareness_enabled: false,
    zone_awareness_config: {
      availability_zone_count: 1,
    },
    dedicated_master_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
    dedicated_master_count: 1,
    warm_enabled: false,
    warm_type: "ultrawarm1.medium.search", # accepts ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search
    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
    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,
  },
  tag_list: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  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",
      },
    ],
    use_off_peak_window: false,
  },
  off_peak_window_options: {
    enabled: false,
    off_peak_window: {
      window_start_time: {
        hours: 1, # required
        minutes: 1, # required
      },
    },
  },
  software_update_options: {
    auto_software_update_enabled: false,
  },
})

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.engine_version #=> String
resp.domain_status.cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status.cluster_config.instance_count #=> Integer
resp.domain_status.cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status.cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status.cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status.cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status.cluster_config.dedicated_master_count #=> Integer
resp.domain_status.cluster_config.warm_enabled #=> Boolean
resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
resp.domain_status.cluster_config.warm_count #=> Integer
resp.domain_status.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"
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.auto_tune_options.use_off_peak_window #=> Boolean
resp.domain_status.change_progress_details.change_id #=> String
resp.domain_status.change_progress_details.message #=> String
resp.domain_status.off_peak_window_options.enabled #=> Boolean
resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.

  • :engine_version (String) —

    String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example, OpenSearch_1.0 or Elasticsearch_7.9. For more information, see Creating and managing Amazon OpenSearch Service domains.

  • :cluster_config (Types::ClusterConfig) —

    Container for the cluster configuration of a domain.

  • :ebs_options (Types::EBSOptions) —

    Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.

  • :access_policies (String) —

    Identity and Access Management (IAM) policy document specifying the access policies for the new domain.

  • :snapshot_options (Types::SnapshotOptions) —

    DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.

  • :vpc_options (Types::VPCOptions) —

    Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

  • :cognito_options (Types::CognitoOptions) —

    Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) —

    Key-value pairs to enable encryption at rest.

  • :node_to_node_encryption_options (Types::NodeToNodeEncryptionOptions) —

    Enables node-to-node encryption.

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

    Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

    • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

    • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

    • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

    • "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

    For more information, see Advanced cluster parameters.

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

    Key-value pairs to configure slow log publishing.

  • :domain_endpoint_options (Types::DomainEndpointOptions) —

    Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

  • :advanced_security_options (Types::AdvancedSecurityOptionsInput) —

    Options for fine-grained access control.

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

    List of tags to add to the domain upon creation.

  • :auto_tune_options (Types::AutoTuneOptionsInput) —

    Options for Auto-Tune.

  • :off_peak_window_options (Types::OffPeakWindowOptions) —

    Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.

  • :software_update_options (Types::SoftwareUpdateOptions) —

    Software update options for the domain.

Returns:

See Also:



915
916
917
918
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 915

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

#create_outbound_connection(params = {}) ⇒ Types::CreateOutboundConnectionResponse

Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Examples:

Request syntax with placeholder values


resp = client.create_outbound_connection({
  local_domain_info: { # required
    aws_domain_information: {
      owner_id: "OwnerId",
      domain_name: "DomainName", # required
      region: "Region",
    },
  },
  remote_domain_info: { # required
    aws_domain_information: {
      owner_id: "OwnerId",
      domain_name: "DomainName", # required
      region: "Region",
    },
  },
  connection_alias: "ConnectionAlias", # required
  connection_mode: "DIRECT", # accepts DIRECT, VPC_ENDPOINT
})

Response structure


resp.local_domain_info.aws_domain_information.owner_id #=> String
resp.local_domain_info.aws_domain_information.domain_name #=> String
resp.local_domain_info.aws_domain_information.region #=> String
resp.remote_domain_info.aws_domain_information.owner_id #=> String
resp.remote_domain_info.aws_domain_information.domain_name #=> String
resp.remote_domain_info.aws_domain_information.region #=> String
resp.connection_alias #=> String
resp.connection_status.status_code #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.connection_status.message #=> String
resp.connection_id #=> String
resp.connection_mode #=> String, one of "DIRECT", "VPC_ENDPOINT"
resp.connection_properties.endpoint #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :local_domain_info (required, Types::DomainInformationContainer) —

    Name and Region of the source (local) domain.

  • :remote_domain_info (required, Types::DomainInformationContainer) —

    Name and Region of the destination (remote) domain.

  • :connection_alias (required, String) —

    Name of the connection.

  • :connection_mode (String) —

    The connection mode.

Returns:

See Also:



991
992
993
994
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 991

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

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

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

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 name for the package.

  • :package_type (required, String) —

    Type of package.

  • :package_description (String) —

    Description of the package.

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

    The Amazon S3 location from which to import the package.

Returns:

See Also:



1049
1050
1051
1052
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1049

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 create the endpoint for.

  • :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:

See Also:



1101
1102
1103
1104
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1101

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

#delete_domain(params = {}) ⇒ Types::DeleteDomainResponse

Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.

Examples:

Request syntax with placeholder values


resp = client.delete_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.engine_version #=> String
resp.domain_status.cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status.cluster_config.instance_count #=> Integer
resp.domain_status.cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status.cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status.cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status.cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status.cluster_config.dedicated_master_count #=> Integer
resp.domain_status.cluster_config.warm_enabled #=> Boolean
resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
resp.domain_status.cluster_config.warm_count #=> Integer
resp.domain_status.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"
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.auto_tune_options.use_off_peak_window #=> Boolean
resp.domain_status.change_progress_details.change_id #=> String
resp.domain_status.change_progress_details.message #=> String
resp.domain_status.off_peak_window_options.enabled #=> Boolean
resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain you want to permanently delete.

Returns:

See Also:



1209
1210
1211
1212
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1209

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

#delete_inbound_connection(params = {}) ⇒ Types::DeleteInboundConnectionResponse

Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Examples:

Request syntax with placeholder values


resp = client.delete_inbound_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
resp.connection.local_domain_info.aws_domain_information.region #=> String
resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
resp.connection.remote_domain_info.aws_domain_information.region #=> String
resp.connection.connection_id #=> String
resp.connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.connection.connection_status.message #=> String
resp.connection.connection_mode #=> String, one of "DIRECT", "VPC_ENDPOINT"

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String) —

    The ID of the inbound connection to permanently delete.

Returns:

See Also:



1253
1254
1255
1256
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1253

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

#delete_outbound_connection(params = {}) ⇒ Types::DeleteOutboundConnectionResponse

Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.

Examples:

Request syntax with placeholder values


resp = client.delete_outbound_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
resp.connection.local_domain_info.aws_domain_information.region #=> String
resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
resp.connection.remote_domain_info.aws_domain_information.region #=> String
resp.connection.connection_id #=> String
resp.connection.connection_alias #=> String
resp.connection.connection_status.status_code #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.connection.connection_status.message #=> String
resp.connection.connection_mode #=> String, one of "DIRECT", "VPC_ENDPOINT"
resp.connection.connection_properties.endpoint #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String) —

    The ID of the outbound connection you want to permanently delete.

Returns:

See Also:



1299
1300
1301
1302
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1299

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

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

Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.

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) —

    The internal ID of the package you want to delete. Use DescribePackages to find this value.

Returns:

See Also:



1342
1343
1344
1345
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1342

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.

Returns:

See Also:



1373
1374
1375
1376
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1373

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

#describe_domain(params = {}) ⇒ Types::DescribeDomainResponse

Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.

Examples:

Request syntax with placeholder values


resp = client.describe_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.engine_version #=> String
resp.domain_status.cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status.cluster_config.instance_count #=> Integer
resp.domain_status.cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status.cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status.cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status.cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status.cluster_config.dedicated_master_count #=> Integer
resp.domain_status.cluster_config.warm_enabled #=> Boolean
resp.domain_status.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
resp.domain_status.cluster_config.warm_count #=> Integer
resp.domain_status.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"
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.auto_tune_options.use_off_peak_window #=> Boolean
resp.domain_status.change_progress_details.change_id #=> String
resp.domain_status.change_progress_details.message #=> String
resp.domain_status.off_peak_window_options.enabled #=> Boolean
resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
resp.domain_status.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
resp.domain_status.software_update_options.auto_software_update_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain that you want information about.

Returns:

See Also:



1482
1483
1484
1485
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1482

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

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

Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.

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) —

    Name of the domain that you want Auto-Tune details about.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial DescribeDomainAutoTunes operation returns a nextToken, you can include the returned nextToken in subsequent DescribeDomainAutoTunes operations, which returns results in the next page.

Returns:

See Also:



1537
1538
1539
1540
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1537

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 an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain to get progress information for.

  • :change_id (String) —

    The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.

Returns:

See Also:



1589
1590
1591
1592
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1589

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

#describe_domain_config(params = {}) ⇒ Types::DescribeDomainConfigResponse

Returns the configuration of an Amazon OpenSearch Service domain.

Examples:

Request syntax with placeholder values


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

Response structure


resp.domain_config.engine_version.options #=> String
resp.domain_config.engine_version.status.creation_date #=> Time
resp.domain_config.engine_version.status.update_date #=> Time
resp.domain_config.engine_version.status.update_version #=> Integer
resp.domain_config.engine_version.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.engine_version.status.pending_deletion #=> Boolean
resp.domain_config.cluster_config.options.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_config.cluster_config.options.instance_count #=> Integer
resp.domain_config.cluster_config.options.dedicated_master_enabled #=> Boolean
resp.domain_config.cluster_config.options.zone_awareness_enabled #=> Boolean
resp.domain_config.cluster_config.options.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_config.cluster_config.options.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_config.cluster_config.options.dedicated_master_count #=> Integer
resp.domain_config.cluster_config.options.warm_enabled #=> Boolean
resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
resp.domain_config.cluster_config.options.warm_count #=> Integer
resp.domain_config.cluster_config.options.cold_storage_options.enabled #=> Boolean
resp.domain_config.cluster_config.status.creation_date #=> Time
resp.domain_config.cluster_config.status.update_date #=> Time
resp.domain_config.cluster_config.status.update_version #=> Integer
resp.domain_config.cluster_config.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.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"
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.options.use_off_peak_window #=> Boolean
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.off_peak_window_options.options.enabled #=> Boolean
resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer
resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer
resp.domain_config.off_peak_window_options.status.creation_date #=> Time
resp.domain_config.off_peak_window_options.status.update_date #=> Time
resp.domain_config.off_peak_window_options.status.update_version #=> Integer
resp.domain_config.off_peak_window_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.off_peak_window_options.status.pending_deletion #=> Boolean
resp.domain_config.software_update_options.options.auto_software_update_enabled #=> Boolean
resp.domain_config.software_update_options.status.creation_date #=> Time
resp.domain_config.software_update_options.status.update_date #=> Time
resp.domain_config.software_update_options.status.update_version #=> Integer
resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.software_update_options.status.pending_deletion #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    Name of the OpenSearch Service domain configuration that you want to describe.

Returns:

See Also:



1765
1766
1767
1768
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1765

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

#describe_domains(params = {}) ⇒ Types::DescribeDomainsResponse

Returns domain configuration information about the specified Amazon OpenSearch Service domains.

Examples:

Request syntax with placeholder values


resp = client.describe_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].engine_version #=> String
resp.domain_status_list[0].cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status_list[0].cluster_config.instance_count #=> Integer
resp.domain_status_list[0].cluster_config.dedicated_master_enabled #=> Boolean
resp.domain_status_list[0].cluster_config.zone_awareness_enabled #=> Boolean
resp.domain_status_list[0].cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_status_list[0].cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_status_list[0].cluster_config.dedicated_master_count #=> Integer
resp.domain_status_list[0].cluster_config.warm_enabled #=> Boolean
resp.domain_status_list[0].cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
resp.domain_status_list[0].cluster_config.warm_count #=> Integer
resp.domain_status_list[0].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"
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].auto_tune_options.use_off_peak_window #=> Boolean
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].off_peak_window_options.enabled #=> Boolean
resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
resp.domain_status_list[0].off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
resp.domain_status_list[0].software_update_options.auto_software_update_enabled #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

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

    Array of OpenSearch Service domain names that you want information about. If you don't specify any domains, OpenSearch Service returns information about all domains owned by the account.

Returns:

See Also:



1876
1877
1878
1879
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 1876

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

#describe_dry_run_progress(params = {}) ⇒ Types::DescribeDryRunProgressResponse

Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.

Examples:

Request syntax with placeholder values


resp = client.describe_dry_run_progress({
  domain_name: "DomainName", # required
  dry_run_id: "GUID",
  load_dry_run_config: false,
})

Response structure


resp.dry_run_progress_status.dry_run_id #=> String
resp.dry_run_progress_status.dry_run_status #=> String
resp.dry_run_progress_status.creation_date #=> String
resp.dry_run_progress_status.update_date #=> String
resp.dry_run_progress_status.validation_failures #=> Array
resp.dry_run_progress_status.validation_failures[0].code #=> String
resp.dry_run_progress_status.validation_failures[0].message #=> String
resp.dry_run_config.domain_id #=> String
resp.dry_run_config.domain_name #=> String
resp.dry_run_config.arn #=> String
resp.dry_run_config.created #=> Boolean
resp.dry_run_config.deleted #=> Boolean
resp.dry_run_config.endpoint #=> String
resp.dry_run_config.endpoints #=> Hash
resp.dry_run_config.endpoints["String"] #=> String
resp.dry_run_config.processing #=> Boolean
resp.dry_run_config.upgrade_processing #=> Boolean
resp.dry_run_config.engine_version #=> String
resp.dry_run_config.cluster_config.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.dry_run_config.cluster_config.instance_count #=> Integer
resp.dry_run_config.cluster_config.dedicated_master_enabled #=> Boolean
resp.dry_run_config.cluster_config.zone_awareness_enabled #=> Boolean
resp.dry_run_config.cluster_config.zone_awareness_config.availability_zone_count #=> Integer
resp.dry_run_config.cluster_config.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.dry_run_config.cluster_config.dedicated_master_count #=> Integer
resp.dry_run_config.cluster_config.warm_enabled #=> Boolean
resp.dry_run_config.cluster_config.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
resp.dry_run_config.cluster_config.warm_count #=> Integer
resp.dry_run_config.cluster_config.cold_storage_options.enabled #=> Boolean
resp.dry_run_config.ebs_options.ebs_enabled #=> Boolean
resp.dry_run_config.ebs_options.volume_type #=> String, one of "standard", "gp2", "io1", "gp3"
resp.dry_run_config.ebs_options.volume_size #=> Integer
resp.dry_run_config.ebs_options.iops #=> Integer
resp.dry_run_config.ebs_options.throughput #=> Integer
resp.dry_run_config.access_policies #=> String
resp.dry_run_config.snapshot_options.automated_snapshot_start_hour #=> Integer
resp.dry_run_config.vpc_options.vpc_id #=> String
resp.dry_run_config.vpc_options.subnet_ids #=> Array
resp.dry_run_config.vpc_options.subnet_ids[0] #=> String
resp.dry_run_config.vpc_options.availability_zones #=> Array
resp.dry_run_config.vpc_options.availability_zones[0] #=> String
resp.dry_run_config.vpc_options.security_group_ids #=> Array
resp.dry_run_config.vpc_options.security_group_ids[0] #=> String
resp.dry_run_config.cognito_options.enabled #=> Boolean
resp.dry_run_config.cognito_options.user_pool_id #=> String
resp.dry_run_config.cognito_options.identity_pool_id #=> String
resp.dry_run_config.cognito_options.role_arn #=> String
resp.dry_run_config.encryption_at_rest_options.enabled #=> Boolean
resp.dry_run_config.encryption_at_rest_options.kms_key_id #=> String
resp.dry_run_config.node_to_node_encryption_options.enabled #=> Boolean
resp.dry_run_config.advanced_options #=> Hash
resp.dry_run_config.advanced_options["String"] #=> String
resp.dry_run_config.log_publishing_options #=> Hash
resp.dry_run_config.log_publishing_options["LogType"].cloud_watch_logs_log_group_arn #=> String
resp.dry_run_config.log_publishing_options["LogType"].enabled #=> Boolean
resp.dry_run_config.service_software_options.current_version #=> String
resp.dry_run_config.service_software_options.new_version #=> String
resp.dry_run_config.service_software_options.update_available #=> Boolean
resp.dry_run_config.service_software_options.cancellable #=> Boolean
resp.dry_run_config.service_software_options.update_status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.dry_run_config.service_software_options.description #=> String
resp.dry_run_config.service_software_options.automated_update_date #=> Time
resp.dry_run_config.service_software_options.optional_deployment #=> Boolean
resp.dry_run_config.domain_endpoint_options.enforce_https #=> Boolean
resp.dry_run_config.domain_endpoint_options.tls_security_policy #=> String, one of "Policy-Min-TLS-1-0-2019-07", "Policy-Min-TLS-1-2-2019-07"
resp.dry_run_config.domain_endpoint_options.custom_endpoint_enabled #=> Boolean
resp.dry_run_config.domain_endpoint_options.custom_endpoint #=> String
resp.dry_run_config.domain_endpoint_options.custom_endpoint_certificate_arn #=> String
resp.dry_run_config.advanced_security_options.enabled #=> Boolean
resp.dry_run_config.advanced_security_options.internal_user_database_enabled #=> Boolean
resp.dry_run_config.advanced_security_options.saml_options.enabled #=> Boolean
resp.dry_run_config.advanced_security_options.saml_options.idp.metadata_content #=> String
resp.dry_run_config.advanced_security_options.saml_options.idp.entity_id #=> String
resp.dry_run_config.advanced_security_options.saml_options.subject_key #=> String
resp.dry_run_config.advanced_security_options.saml_options.roles_key #=> String
resp.dry_run_config.advanced_security_options.saml_options.session_timeout_minutes #=> Integer
resp.dry_run_config.advanced_security_options.anonymous_auth_disable_date #=> Time
resp.dry_run_config.advanced_security_options.anonymous_auth_enabled #=> Boolean
resp.dry_run_config.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.dry_run_config.auto_tune_options.error_message #=> String
resp.dry_run_config.auto_tune_options.use_off_peak_window #=> Boolean
resp.dry_run_config.change_progress_details.change_id #=> String
resp.dry_run_config.change_progress_details.message #=> String
resp.dry_run_config.off_peak_window_options.enabled #=> Boolean
resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.hours #=> Integer
resp.dry_run_config.off_peak_window_options.off_peak_window.window_start_time.minutes #=> Integer
resp.dry_run_config.software_update_options.auto_software_update_enabled #=> 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 domain.

  • :dry_run_id (String) —

    The unique identifier of the dry run.

  • :load_dry_run_config (Boolean) —

    Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.

Returns:

See Also:



2010
2011
2012
2013
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2010

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

#describe_inbound_connections(params = {}) ⇒ Types::DescribeInboundConnectionsResponse

Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

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_connections({
  filters: [
    {
      name: "NonEmptyString",
      values: ["NonEmptyString"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connections #=> Array
resp.connections[0].local_domain_info.aws_domain_information.owner_id #=> String
resp.connections[0].local_domain_info.aws_domain_information.domain_name #=> String
resp.connections[0].local_domain_info.aws_domain_information.region #=> String
resp.connections[0].remote_domain_info.aws_domain_information.owner_id #=> String
resp.connections[0].remote_domain_info.aws_domain_information.domain_name #=> String
resp.connections[0].remote_domain_info.aws_domain_information.region #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.connections[0].connection_status.message #=> String
resp.connections[0].connection_mode #=> String, one of "DIRECT", "VPC_ENDPOINT"
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 connections.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial DescribeInboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeInboundConnections operations, which returns results in the next page.

Returns:

See Also:



2077
2078
2079
2080
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2077

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

#describe_instance_type_limits(params = {}) ⇒ Types::DescribeInstanceTypeLimitsResponse

Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.

Examples:

Request syntax with placeholder values


resp = client.describe_instance_type_limits({
  domain_name: "DomainName",
  instance_type: "m3.medium.search", # required, accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
  engine_version: "VersionString", # 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) —

    The name of the domain. Only specify if you need the limits for an existing domain.

  • :instance_type (required, String) —

    The OpenSearch Service instance type for which you need limit information.

  • :engine_version (required, String) —

    Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Returns:

See Also:



2131
2132
2133
2134
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2131

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

#describe_outbound_connections(params = {}) ⇒ Types::DescribeOutboundConnectionsResponse

Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.

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_connections({
  filters: [
    {
      name: "NonEmptyString",
      values: ["NonEmptyString"],
    },
  ],
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.connections #=> Array
resp.connections[0].local_domain_info.aws_domain_information.owner_id #=> String
resp.connections[0].local_domain_info.aws_domain_information.domain_name #=> String
resp.connections[0].local_domain_info.aws_domain_information.region #=> String
resp.connections[0].remote_domain_info.aws_domain_information.owner_id #=> String
resp.connections[0].remote_domain_info.aws_domain_information.domain_name #=> String
resp.connections[0].remote_domain_info.aws_domain_information.region #=> String
resp.connections[0].connection_id #=> String
resp.connections[0].connection_alias #=> String
resp.connections[0].connection_status.status_code #=> String, one of "VALIDATING", "VALIDATION_FAILED", "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.connections[0].connection_status.message #=> String
resp.connections[0].connection_mode #=> String, one of "DIRECT", "VPC_ENDPOINT"
resp.connections[0].connection_properties.endpoint #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    List of filter names and values that you can use for requests.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial DescribeOutboundConnections operation returns a nextToken, you can include the returned nextToken in subsequent DescribeOutboundConnections operations, which returns results in the next page.

Returns:

See Also:



2198
2199
2200
2201
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2198

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

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

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

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) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Returns:

See Also:



2263
2264
2265
2266
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2263

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

#describe_reserved_instance_offerings(params = {}) ⇒ Types::DescribeReservedInstanceOfferingsResponse

Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

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_instance_offerings({
  reserved_instance_offering_id: "GUID",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.reserved_instance_offerings #=> Array
resp.reserved_instance_offerings[0].reserved_instance_offering_id #=> String
resp.reserved_instance_offerings[0].instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.reserved_instance_offerings[0].duration #=> Integer
resp.reserved_instance_offerings[0].fixed_price #=> Float
resp.reserved_instance_offerings[0].usage_price #=> Float
resp.reserved_instance_offerings[0].currency_code #=> String
resp.reserved_instance_offerings[0].payment_option #=> String, one of "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT"
resp.reserved_instance_offerings[0].recurring_charges #=> Array
resp.reserved_instance_offerings[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_instance_offerings[0].recurring_charges[0].recurring_charge_frequency #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :reserved_instance_offering_id (String) —

    The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial DescribeReservedInstanceOfferings operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstanceOfferings operations, which returns results in the next page.

Returns:

See Also:



2325
2326
2327
2328
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2325

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

#describe_reserved_instances(params = {}) ⇒ Types::DescribeReservedInstancesResponse

Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.

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_instances({
  reserved_instance_id: "GUID",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.next_token #=> String
resp.reserved_instances #=> Array
resp.reserved_instances[0].reservation_name #=> String
resp.reserved_instances[0].reserved_instance_id #=> String
resp.reserved_instances[0].billing_subscription_id #=> Integer
resp.reserved_instances[0].reserved_instance_offering_id #=> String
resp.reserved_instances[0].instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.reserved_instances[0].start_time #=> Time
resp.reserved_instances[0].duration #=> Integer
resp.reserved_instances[0].fixed_price #=> Float
resp.reserved_instances[0].usage_price #=> Float
resp.reserved_instances[0].currency_code #=> String
resp.reserved_instances[0].instance_count #=> Integer
resp.reserved_instances[0].state #=> String
resp.reserved_instances[0].payment_option #=> String, one of "ALL_UPFRONT", "PARTIAL_UPFRONT", "NO_UPFRONT"
resp.reserved_instances[0].recurring_charges #=> Array
resp.reserved_instances[0].recurring_charges[0].recurring_charge_amount #=> Float
resp.reserved_instances[0].recurring_charges[0].recurring_charge_frequency #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :reserved_instance_id (String) —

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

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial DescribeReservedInstances operation returns a nextToken, you can include the returned nextToken in subsequent DescribeReservedInstances operations, which returns results in the next page.

Returns:

See Also:



2393
2394
2395
2396
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2393

def describe_reserved_instances(params = {}, options = {})
  req = build_request(:describe_reserved_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:

See Also:



2438
2439
2440
2441
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2438

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

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

Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.

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 to dissociate from the domain. Use ListPackagesForDomain to find this value.

  • :domain_name (required, String) —

    Name of the domain to dissociate the package from.

Returns:

See Also:



2488
2489
2490
2491
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2488

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

#get_compatible_versions(params = {}) ⇒ Types::GetCompatibleVersionsResponse

Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.

Examples:

Request syntax with placeholder values


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

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (String) —

    The name of an existing domain. Provide this parameter to limit the results to a single domain.

Returns:

See Also:



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

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

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

Returns a list of Amazon OpenSearch Service package versions, along with their creation time and commit message. For more information, see Custom packages for Amazon OpenSearch Service.

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) —

    The unique identifier of the package.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial GetPackageVersionHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetPackageVersionHistory operations, which returns results in the next page.

Returns:

See Also:



2576
2577
2578
2579
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2576

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 performed on an Amazon OpenSearch Service 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 existing domain.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial GetUpgradeHistory operation returns a nextToken, you can include the returned nextToken in subsequent GetUpgradeHistory operations, which returns results in the next page.

Returns:

See Also:



2630
2631
2632
2633
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2630

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

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

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service 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 domain of the domain to get upgrade status information for.

Returns:

See Also:



2663
2664
2665
2666
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2663

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 names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

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) —

    Filters the output by domain engine type.

Returns:

See Also:



2694
2695
2696
2697
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2694

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 OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

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 unique identifier of the package for which to list associated domains.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial ListDomainsForPackage operation returns a nextToken, you can include the returned nextToken in subsequent ListDomainsForPackage operations, which returns results in the next page.

Returns:

See Also:



2755
2756
2757
2758
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2755

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

#list_instance_type_details(params = {}) ⇒ Types::ListInstanceTypeDetailsResponse

Lists all instance types and available features for a given OpenSearch or Elasticsearch version.

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_instance_type_details({
  engine_version: "VersionString", # required
  domain_name: "DomainName",
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.instance_type_details #=> Array
resp.instance_type_details[0].instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.instance_type_details[0].encryption_enabled #=> Boolean
resp.instance_type_details[0].cognito_enabled #=> Boolean
resp.instance_type_details[0].app_logs_enabled #=> Boolean
resp.instance_type_details[0].advanced_security_enabled #=> Boolean
resp.instance_type_details[0].warm_enabled #=> Boolean
resp.instance_type_details[0].instance_role #=> Array
resp.instance_type_details[0].instance_role[0] #=> String
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :engine_version (required, String) —

    Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

  • :domain_name (String) —

    Name of the domain to list instance type details for.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial ListInstanceTypeDetails operation returns a nextToken, you can include the returned nextToken in subsequent ListInstanceTypeDetails operations, which returns results in the next page.

Returns:

See Also:



2814
2815
2816
2817
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2814

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

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

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

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) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial ListPackagesForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListPackagesForDomain operations, which returns results in the next page.

Returns:

See Also:



2874
2875
2876
2877
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2874

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

#list_scheduled_actions(params = {}) ⇒ Types::ListScheduledActionsResponse

Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.

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_scheduled_actions({
  domain_name: "DomainName", # required
  max_results: 1,
  next_token: "NextToken",
})

Response structure


resp.scheduled_actions #=> Array
resp.scheduled_actions[0].id #=> String
resp.scheduled_actions[0].type #=> String, one of "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
resp.scheduled_actions[0].severity #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.scheduled_actions[0].scheduled_time #=> Integer
resp.scheduled_actions[0].description #=> String
resp.scheduled_actions[0].scheduled_by #=> String, one of "CUSTOMER", "SYSTEM"
resp.scheduled_actions[0].status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "FAILED", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.scheduled_actions[0].mandatory #=> Boolean
resp.scheduled_actions[0].cancellable #=> Boolean
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain.

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial ListScheduledActions operation returns a nextToken, you can include the returned nextToken in subsequent ListScheduledActions operations, which returns results in the next page.

Returns:

See Also:



2934
2935
2936
2937
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2934

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

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

Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

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) —

    Amazon Resource Name (ARN) for the domain to view tags for.

Returns:

See Also:



2969
2970
2971
2972
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 2969

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

#list_versions(params = {}) ⇒ Types::ListVersionsResponse

Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

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_versions({
  max_results: 1,
  next_token: "NextToken",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :max_results (Integer) —

    An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.

  • :next_token (String) —

    If your initial ListVersions operation returns a nextToken, you can include the returned nextToken in subsequent ListVersions operations, which returns results in the next page.

Returns:

See Also:



3010
3011
3012
3013
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3010

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

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

Retrieves information about each Amazon Web Services 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) —

    If your initial ListVpcEndpointAccess operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpointAccess operations, which returns results in the next page.

Returns:

See Also:



3052
3053
3054
3055
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3052

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 Amazon Web Services 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) —

    If your initial ListVpcEndpoints operation returns a nextToken, you can include the returned nextToken in subsequent ListVpcEndpoints operations, which returns results in the next page.

Returns:

See Also:



3089
3090
3091
3092
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3089

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) —

    The name of the domain to list associated VPC endpoints for.

  • :next_token (String) —

    If your initial ListEndpointsForDomain operation returns a nextToken, you can include the returned nextToken in subsequent ListEndpointsForDomain operations, which returns results in the next page.

Returns:

See Also:



3131
3132
3133
3134
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3131

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

#purchase_reserved_instance_offering(params = {}) ⇒ Types::PurchaseReservedInstanceOfferingResponse

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Examples:

Request syntax with placeholder values


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

Response structure


resp.reserved_instance_id #=> String
resp.reservation_name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :reserved_instance_offering_id (required, String) —

    The ID of the Reserved Instance offering to purchase.

  • :reservation_name (required, String) —

    A customer-specified identifier to track this reservation.

  • :instance_count (Integer) —

    The number of OpenSearch instances to reserve.

Returns:

See Also:



3169
3170
3171
3172
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3169

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

#reject_inbound_connection(params = {}) ⇒ Types::RejectInboundConnectionResponse

Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.

Examples:

Request syntax with placeholder values


resp = client.reject_inbound_connection({
  connection_id: "ConnectionId", # required
})

Response structure


resp.connection.local_domain_info.aws_domain_information.owner_id #=> String
resp.connection.local_domain_info.aws_domain_information.domain_name #=> String
resp.connection.local_domain_info.aws_domain_information.region #=> String
resp.connection.remote_domain_info.aws_domain_information.owner_id #=> String
resp.connection.remote_domain_info.aws_domain_information.domain_name #=> String
resp.connection.remote_domain_info.aws_domain_information.region #=> String
resp.connection.connection_id #=> String
resp.connection.connection_status.status_code #=> String, one of "PENDING_ACCEPTANCE", "APPROVED", "PROVISIONING", "ACTIVE", "REJECTING", "REJECTED", "DELETING", "DELETED"
resp.connection.connection_status.message #=> String
resp.connection.connection_mode #=> String, one of "DIRECT", "VPC_ENDPOINT"

Parameters:

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

    ({})

Options Hash (params):

  • :connection_id (required, String) —

    The unique identifier of the inbound connection to reject.

Returns:

See Also:



3207
3208
3209
3210
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3207

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

#remove_tags(params = {}) ⇒ Struct

Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.

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) —

    The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.

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

    The list of tag keys to remove from the domain.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



3240
3241
3242
3243
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3240

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.

See Also:



3267
3268
3269
3270
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3267

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

#start_service_software_update(params = {}) ⇒ Types::StartServiceSoftwareUpdateResponse

Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.

Examples:

Request syntax with placeholder values


resp = client.start_service_software_update({
  domain_name: "DomainName", # required
  schedule_at: "NOW", # accepts NOW, TIMESTAMP, OFF_PEAK_WINDOW
  desired_start_time: 1,
})

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.

  • :schedule_at (String) —

    When to start the service software update.

    • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

    • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

    • OFF_PEAK_WINDOW - Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.

    Default: NOW if you don't specify a value for DesiredStartTime, and TIMESTAMP if you do.

  • :desired_start_time (Integer) —

    The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set ScheduleAt to TIMESTAMP.

Returns:

See Also:



3334
3335
3336
3337
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3334

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

#update_domain_config(params = {}) ⇒ Types::UpdateDomainConfigResponse

Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.

Examples:

Request syntax with placeholder values


resp = client.update_domain_config({
  domain_name: "DomainName", # required
  cluster_config: {
    instance_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
    instance_count: 1,
    dedicated_master_enabled: false,
    zone_awareness_enabled: false,
    zone_awareness_config: {
      availability_zone_count: 1,
    },
    dedicated_master_type: "m3.medium.search", # accepts m3.medium.search, m3.large.search, m3.xlarge.search, m3.2xlarge.search, m4.large.search, m4.xlarge.search, m4.2xlarge.search, m4.4xlarge.search, m4.10xlarge.search, m5.large.search, m5.xlarge.search, m5.2xlarge.search, m5.4xlarge.search, m5.12xlarge.search, m5.24xlarge.search, r5.large.search, r5.xlarge.search, r5.2xlarge.search, r5.4xlarge.search, r5.12xlarge.search, r5.24xlarge.search, c5.large.search, c5.xlarge.search, c5.2xlarge.search, c5.4xlarge.search, c5.9xlarge.search, c5.18xlarge.search, t3.nano.search, t3.micro.search, t3.small.search, t3.medium.search, t3.large.search, t3.xlarge.search, t3.2xlarge.search, ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search, t2.micro.search, t2.small.search, t2.medium.search, r3.large.search, r3.xlarge.search, r3.2xlarge.search, r3.4xlarge.search, r3.8xlarge.search, i2.xlarge.search, i2.2xlarge.search, d2.xlarge.search, d2.2xlarge.search, d2.4xlarge.search, d2.8xlarge.search, c4.large.search, c4.xlarge.search, c4.2xlarge.search, c4.4xlarge.search, c4.8xlarge.search, r4.large.search, r4.xlarge.search, r4.2xlarge.search, r4.4xlarge.search, r4.8xlarge.search, r4.16xlarge.search, i3.large.search, i3.xlarge.search, i3.2xlarge.search, i3.4xlarge.search, i3.8xlarge.search, i3.16xlarge.search, r6g.large.search, r6g.xlarge.search, r6g.2xlarge.search, r6g.4xlarge.search, r6g.8xlarge.search, r6g.12xlarge.search, m6g.large.search, m6g.xlarge.search, m6g.2xlarge.search, m6g.4xlarge.search, m6g.8xlarge.search, m6g.12xlarge.search, c6g.large.search, c6g.xlarge.search, c6g.2xlarge.search, c6g.4xlarge.search, c6g.8xlarge.search, c6g.12xlarge.search, r6gd.large.search, r6gd.xlarge.search, r6gd.2xlarge.search, r6gd.4xlarge.search, r6gd.8xlarge.search, r6gd.12xlarge.search, r6gd.16xlarge.search, t4g.small.search, t4g.medium.search
    dedicated_master_count: 1,
    warm_enabled: false,
    warm_type: "ultrawarm1.medium.search", # accepts ultrawarm1.medium.search, ultrawarm1.large.search, ultrawarm1.xlarge.search
    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,
    },
  },
  encryption_at_rest_options: {
    enabled: false,
    kms_key_id: "KmsKeyId",
  },
  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
    custom_endpoint_enabled: false,
    custom_endpoint: "DomainNameFqdn",
    custom_endpoint_certificate_arn: "ARN",
  },
  node_to_node_encryption_options: {
    enabled: false,
  },
  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
    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",
      },
    ],
    use_off_peak_window: false,
  },
  dry_run: false,
  dry_run_mode: "Basic", # accepts Basic, Verbose
  off_peak_window_options: {
    enabled: false,
    off_peak_window: {
      window_start_time: {
        hours: 1, # required
        minutes: 1, # required
      },
    },
  },
  software_update_options: {
    auto_software_update_enabled: false,
  },
})

Response structure


resp.domain_config.engine_version.options #=> String
resp.domain_config.engine_version.status.creation_date #=> Time
resp.domain_config.engine_version.status.update_date #=> Time
resp.domain_config.engine_version.status.update_version #=> Integer
resp.domain_config.engine_version.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.engine_version.status.pending_deletion #=> Boolean
resp.domain_config.cluster_config.options.instance_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_config.cluster_config.options.instance_count #=> Integer
resp.domain_config.cluster_config.options.dedicated_master_enabled #=> Boolean
resp.domain_config.cluster_config.options.zone_awareness_enabled #=> Boolean
resp.domain_config.cluster_config.options.zone_awareness_config.availability_zone_count #=> Integer
resp.domain_config.cluster_config.options.dedicated_master_type #=> String, one of "m3.medium.search", "m3.large.search", "m3.xlarge.search", "m3.2xlarge.search", "m4.large.search", "m4.xlarge.search", "m4.2xlarge.search", "m4.4xlarge.search", "m4.10xlarge.search", "m5.large.search", "m5.xlarge.search", "m5.2xlarge.search", "m5.4xlarge.search", "m5.12xlarge.search", "m5.24xlarge.search", "r5.large.search", "r5.xlarge.search", "r5.2xlarge.search", "r5.4xlarge.search", "r5.12xlarge.search", "r5.24xlarge.search", "c5.large.search", "c5.xlarge.search", "c5.2xlarge.search", "c5.4xlarge.search", "c5.9xlarge.search", "c5.18xlarge.search", "t3.nano.search", "t3.micro.search", "t3.small.search", "t3.medium.search", "t3.large.search", "t3.xlarge.search", "t3.2xlarge.search", "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search", "t2.micro.search", "t2.small.search", "t2.medium.search", "r3.large.search", "r3.xlarge.search", "r3.2xlarge.search", "r3.4xlarge.search", "r3.8xlarge.search", "i2.xlarge.search", "i2.2xlarge.search", "d2.xlarge.search", "d2.2xlarge.search", "d2.4xlarge.search", "d2.8xlarge.search", "c4.large.search", "c4.xlarge.search", "c4.2xlarge.search", "c4.4xlarge.search", "c4.8xlarge.search", "r4.large.search", "r4.xlarge.search", "r4.2xlarge.search", "r4.4xlarge.search", "r4.8xlarge.search", "r4.16xlarge.search", "i3.large.search", "i3.xlarge.search", "i3.2xlarge.search", "i3.4xlarge.search", "i3.8xlarge.search", "i3.16xlarge.search", "r6g.large.search", "r6g.xlarge.search", "r6g.2xlarge.search", "r6g.4xlarge.search", "r6g.8xlarge.search", "r6g.12xlarge.search", "m6g.large.search", "m6g.xlarge.search", "m6g.2xlarge.search", "m6g.4xlarge.search", "m6g.8xlarge.search", "m6g.12xlarge.search", "c6g.large.search", "c6g.xlarge.search", "c6g.2xlarge.search", "c6g.4xlarge.search", "c6g.8xlarge.search", "c6g.12xlarge.search", "r6gd.large.search", "r6gd.xlarge.search", "r6gd.2xlarge.search", "r6gd.4xlarge.search", "r6gd.8xlarge.search", "r6gd.12xlarge.search", "r6gd.16xlarge.search", "t4g.small.search", "t4g.medium.search"
resp.domain_config.cluster_config.options.dedicated_master_count #=> Integer
resp.domain_config.cluster_config.options.warm_enabled #=> Boolean
resp.domain_config.cluster_config.options.warm_type #=> String, one of "ultrawarm1.medium.search", "ultrawarm1.large.search", "ultrawarm1.xlarge.search"
resp.domain_config.cluster_config.options.warm_count #=> Integer
resp.domain_config.cluster_config.options.cold_storage_options.enabled #=> Boolean
resp.domain_config.cluster_config.status.creation_date #=> Time
resp.domain_config.cluster_config.status.update_date #=> Time
resp.domain_config.cluster_config.status.update_version #=> Integer
resp.domain_config.cluster_config.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.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"
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.options.use_off_peak_window #=> Boolean
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.off_peak_window_options.options.enabled #=> Boolean
resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.hours #=> Integer
resp.domain_config.off_peak_window_options.options.off_peak_window.window_start_time.minutes #=> Integer
resp.domain_config.off_peak_window_options.status.creation_date #=> Time
resp.domain_config.off_peak_window_options.status.update_date #=> Time
resp.domain_config.off_peak_window_options.status.update_version #=> Integer
resp.domain_config.off_peak_window_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.off_peak_window_options.status.pending_deletion #=> Boolean
resp.domain_config.software_update_options.options.auto_software_update_enabled #=> Boolean
resp.domain_config.software_update_options.status.creation_date #=> Time
resp.domain_config.software_update_options.status.update_date #=> Time
resp.domain_config.software_update_options.status.update_version #=> Integer
resp.domain_config.software_update_options.status.state #=> String, one of "RequiresIndexDocuments", "Processing", "Active"
resp.domain_config.software_update_options.status.pending_deletion #=> Boolean
resp.dry_run_results.deployment_type #=> String
resp.dry_run_results.message #=> String
resp.dry_run_progress_status.dry_run_id #=> String
resp.dry_run_progress_status.dry_run_status #=> String
resp.dry_run_progress_status.creation_date #=> String
resp.dry_run_progress_status.update_date #=> String
resp.dry_run_progress_status.validation_failures #=> Array
resp.dry_run_progress_status.validation_failures[0].code #=> String
resp.dry_run_progress_status.validation_failures[0].message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain that you're updating.

  • :cluster_config (Types::ClusterConfig) —

    Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.

  • :ebs_options (Types::EBSOptions) —

    The type and size of the EBS volume to attach to instances in the domain.

  • :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 a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

  • :cognito_options (Types::CognitoOptions) —

    Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.

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

    Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:

    • "rest.action.multi.allow_explicit_index": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true.

    • "indices.fielddata.cache.size": "80" - Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded.

    • "indices.query.bool.max_clause_count": "1024" - Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in a TooManyClauses error.

    • "override_main_response_version": "true" | "false" - Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.

    For more information, see Advanced cluster parameters.

  • :access_policies (String) —

    Identity and Access Management (IAM) access policy as a JSON-formatted string.

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

    Options to publish OpenSearch logs to Amazon CloudWatch Logs.

  • :encryption_at_rest_options (Types::EncryptionAtRestOptions) —

    Encryption at rest options for the domain.

  • :domain_endpoint_options (Types::DomainEndpointOptions) —

    Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.

  • :node_to_node_encryption_options (Types::NodeToNodeEncryptionOptions) —

    Node-to-node encryption options for the domain.

  • :advanced_security_options (Types::AdvancedSecurityOptionsInput) —

    Options for fine-grained access control.

  • :auto_tune_options (Types::AutoTuneOptions) —

    Options for Auto-Tune.

  • :dry_run (Boolean) —

    This flag, when set to True, specifies whether the UpdateDomain request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.

  • :dry_run_mode (String) —

    The type of dry run to perform.

    • Basic only returns the type of deployment (blue/green or dynamic) that the update will cause.

    • Verbose runs an additional check to validate the changes you're making. For more information, see Validating a domain update.

  • :off_peak_window_options (Types::OffPeakWindowOptions) —

    Off-peak window options for the domain.

  • :software_update_options (Types::SoftwareUpdateOptions) —

    Service software update options for the domain.

Returns:

See Also:



3739
3740
3741
3742
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3739

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

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

Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

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) —

    The unique identifier for the package.

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

    Amazon S3 bucket and key for the package.

  • :package_description (String) —

    A new description of the package.

  • :commit_message (String) —

    Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

Returns:

See Also:



3798
3799
3800
3801
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3798

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

#update_scheduled_action(params = {}) ⇒ Types::UpdateScheduledActionResponse

Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.

Examples:

Request syntax with placeholder values


resp = client.update_scheduled_action({
  domain_name: "DomainName", # required
  action_id: "String", # required
  action_type: "SERVICE_SOFTWARE_UPDATE", # required, accepts SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, JVM_YOUNG_GEN_TUNING
  schedule_at: "NOW", # required, accepts NOW, TIMESTAMP, OFF_PEAK_WINDOW
  desired_start_time: 1,
})

Response structure


resp.scheduled_action.id #=> String
resp.scheduled_action.type #=> String, one of "SERVICE_SOFTWARE_UPDATE", "JVM_HEAP_SIZE_TUNING", "JVM_YOUNG_GEN_TUNING"
resp.scheduled_action.severity #=> String, one of "HIGH", "MEDIUM", "LOW"
resp.scheduled_action.scheduled_time #=> Integer
resp.scheduled_action.description #=> String
resp.scheduled_action.scheduled_by #=> String, one of "CUSTOMER", "SYSTEM"
resp.scheduled_action.status #=> String, one of "PENDING_UPDATE", "IN_PROGRESS", "FAILED", "COMPLETED", "NOT_ELIGIBLE", "ELIGIBLE"
resp.scheduled_action.mandatory #=> Boolean
resp.scheduled_action.cancellable #=> Boolean

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    The name of the domain to reschedule an action for.

  • :action_id (required, String) —

    The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.

  • :action_type (required, String) —

    The type of action to reschedule. Can be one of SERVICE_SOFTWARE_UPDATE, JVM_HEAP_SIZE_TUNING, or JVM_YOUNG_GEN_TUNING. To retrieve this value, send a ListScheduledActions request.

  • :schedule_at (required, String) —

    When to schedule the action.

    • NOW - Immediately schedules the update to happen in the current hour if there's capacity available.

    • TIMESTAMP - Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value for DesiredStartTime.

    • OFF_PEAK_WINDOW - Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.

  • :desired_start_time (Integer) —

    The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set ScheduleAt to TIMESTAMP.

Returns:

See Also:



3882
3883
3884
3885
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3882

def update_scheduled_action(params = {}, options = {})
  req = build_request(:update_scheduled_action, 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) —

    The unique identifier of the endpoint.

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

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

Returns:

See Also:



3928
3929
3930
3931
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3928

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

#upgrade_domain(params = {}) ⇒ Types::UpgradeDomainResponse

Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

Examples:

Request syntax with placeholder values


resp = client.upgrade_domain({
  domain_name: "DomainName", # required
  target_version: "VersionString", # required
  perform_check_only: false,
  advanced_options: {
    "String" => "String",
  },
})

Response structure


resp.upgrade_id #=> String
resp.domain_name #=> String
resp.target_version #=> String
resp.perform_check_only #=> Boolean
resp.advanced_options #=> Hash
resp.advanced_options["String"] #=> String
resp.change_progress_details.change_id #=> String
resp.change_progress_details.message #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :domain_name (required, String) —

    Name of the OpenSearch Service domain that you want to upgrade.

  • :target_version (required, String) —

    OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.

  • :perform_check_only (Boolean) —

    When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

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

    Only supports the override_main_response_version parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.

Returns:

See Also:



3990
3991
3992
3993
 
# File 'gems/aws-sdk-opensearchservice/lib/aws-sdk-opensearchservice/client.rb', line 3990

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