Class: Aws::OpenSearchServerless::Client

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

Overview

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

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

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

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

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

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

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

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

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

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

    Your AWS credentials. 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, :session_token, and :account_id options.
    • ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY'], ENV['AWS_SESSION_TOKEN'], and ENV['AWS_ACCOUNT_ID']
    • ~/.aws/credentials
    • ~/.aws/config
    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of Aws::InstanceProfileCredentials or Aws::ECSCredentials to enable retries and extended timeouts. Instance profile credential fetching can be disabled by setting ENV['AWS_EC2_METADATA_DISABLED'] to true.
  • :region (required, String) —

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

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

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

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

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

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

  • :disable_request_compression (Boolean) — default: false —

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

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

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

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

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

  • :endpoint_cache_max_threads (Integer) — default: 10 —

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

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

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

  • :endpoint_discovery (Boolean) — default: false —

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

  • :ignore_configured_endpoint_urls (Boolean) —

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

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

    The log formatter.

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

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

  • :logger (Logger) —

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

  • :max_attempts (Integer) — default: 3 —

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

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

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

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

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

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

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

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

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

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

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

  • :retry_base_delay (Float) — default: 0.3 —

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

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

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

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

  • :retry_limit (Integer) — default: 3 —

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

  • :retry_max_delay (Integer) — default: 0 —

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

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

    Specifies which retry algorithm to use. Values are:

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

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

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

  • :sdk_ua_app_id (String) —

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

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

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

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

    Disables request parameter conversion, validation, and formatting. Also disables response data type conversions. The request parameters hash must be formatted exactly as the API expects.This option is useful when you want to ensure the highest level of performance by avoiding overhead of walking request parameters and response data structures.

  • :stub_responses (Boolean) — default: false —

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

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

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

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

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

    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::OpenSearchServerless::EndpointProvider) —

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

  • :http_continue_timeout (Float) — default: 1 —

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

  • :http_idle_timeout (Float) — default: 5 —

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

  • :http_open_timeout (Float) — default: 15 —

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

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

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

  • :http_read_timeout (Float) — default: 60 —

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

  • :http_wire_trace (Boolean) — default: false —

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

  • :on_chunk_received (Proc) —

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

  • :on_chunk_sent (Proc) —

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

  • :raise_response_errors (Boolean) — default: true —

    When true, response errors are raised.

  • :ssl_ca_bundle (String) —

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

  • :ssl_ca_directory (String) —

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

  • :ssl_ca_store (String) —

    Sets the X509::Store to verify peer certificate.

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

    Sets a client certificate when creating http connections.

  • :ssl_key (OpenSSL::PKey) —

    Sets a client key when creating http connections.

  • :ssl_timeout (Float) —

    Sets the SSL timeout in seconds

  • :ssl_verify_peer (Boolean) — default: true —

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



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

def initialize(*args)
  super
end

Instance Method Details

#batch_get_collection(params = {}) ⇒ Types::BatchGetCollectionResponse

Returns attributes for one or more collections, including the collection endpoint and the OpenSearch Dashboards endpoint. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Examples:

Request syntax with placeholder values


resp = client.batch_get_collection({
  ids: ["CollectionId"],
  names: ["CollectionName"],
})

Response structure


resp.collection_details #=> Array
resp.collection_details[0].arn #=> String
resp.collection_details[0].collection_endpoint #=> String
resp.collection_details[0].created_date #=> Integer
resp.collection_details[0].dashboard_endpoint #=> String
resp.collection_details[0].description #=> String
resp.collection_details[0].failure_code #=> String
resp.collection_details[0].failure_message #=> String
resp.collection_details[0].id #=> String
resp.collection_details[0].kms_key_arn #=> String
resp.collection_details[0].last_modified_date #=> Integer
resp.collection_details[0].name #=> String
resp.collection_details[0].standby_replicas #=> String, one of "ENABLED", "DISABLED"
resp.collection_details[0].status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
resp.collection_details[0].type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"
resp.collection_error_details #=> Array
resp.collection_error_details[0].error_code #=> String
resp.collection_error_details[0].error_message #=> String
resp.collection_error_details[0].id #=> String
resp.collection_error_details[0].name #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :ids (Array<String>) —

    A list of collection IDs. You can't provide names and IDs in the same request. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

  • :names (Array<String>) —

    A list of collection names. You can't provide names and IDs in the same request.

Returns:

See Also:



541
542
543
544
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 541

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

#batch_get_effective_lifecycle_policy(params = {}) ⇒ Types::BatchGetEffectiveLifecyclePolicyResponse

Returns a list of successful and failed retrievals for the OpenSearch Serverless indexes. For more information, see Viewing data lifecycle policies.

Examples:

Request syntax with placeholder values


resp = client.batch_get_effective_lifecycle_policy({
  resource_identifiers: [ # required
    {
      resource: "ResourceName", # required
      type: "retention", # required, accepts retention
    },
  ],
})

Response structure


resp.effective_lifecycle_policy_details #=> Array
resp.effective_lifecycle_policy_details[0].no_min_retention_period #=> Boolean
resp.effective_lifecycle_policy_details[0].policy_name #=> String
resp.effective_lifecycle_policy_details[0].resource #=> String
resp.effective_lifecycle_policy_details[0].resource_type #=> String, one of "index"
resp.effective_lifecycle_policy_details[0].retention_period #=> String
resp.effective_lifecycle_policy_details[0].type #=> String, one of "retention"
resp.effective_lifecycle_policy_error_details #=> Array
resp.effective_lifecycle_policy_error_details[0].error_code #=> String
resp.effective_lifecycle_policy_error_details[0].error_message #=> String
resp.effective_lifecycle_policy_error_details[0].resource #=> String
resp.effective_lifecycle_policy_error_details[0].type #=> String, one of "retention"

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



592
593
594
595
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 592

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

#batch_get_lifecycle_policy(params = {}) ⇒ Types::BatchGetLifecyclePolicyResponse

Returns one or more configured OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

Examples:

Request syntax with placeholder values


resp = client.batch_get_lifecycle_policy({
  identifiers: [ # required
    {
      name: "PolicyName", # required
      type: "retention", # required, accepts retention
    },
  ],
})

Response structure


resp.lifecycle_policy_details #=> Array
resp.lifecycle_policy_details[0].created_date #=> Integer
resp.lifecycle_policy_details[0].description #=> String
resp.lifecycle_policy_details[0].last_modified_date #=> Integer
resp.lifecycle_policy_details[0].name #=> String
resp.lifecycle_policy_details[0].policy_version #=> String
resp.lifecycle_policy_details[0].type #=> String, one of "retention"
resp.lifecycle_policy_error_details #=> Array
resp.lifecycle_policy_error_details[0].error_code #=> String
resp.lifecycle_policy_error_details[0].error_message #=> String
resp.lifecycle_policy_error_details[0].name #=> String
resp.lifecycle_policy_error_details[0].type #=> String, one of "retention"

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



643
644
645
646
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 643

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

#batch_get_vpc_endpoint(params = {}) ⇒ Types::BatchGetVpcEndpointResponse

Returns attributes for one or more VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Examples:

Request syntax with placeholder values


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

Response structure


resp.vpc_endpoint_details #=> Array
resp.vpc_endpoint_details[0].created_date #=> Integer
resp.vpc_endpoint_details[0].failure_code #=> String
resp.vpc_endpoint_details[0].failure_message #=> String
resp.vpc_endpoint_details[0].id #=> String
resp.vpc_endpoint_details[0].name #=> String
resp.vpc_endpoint_details[0].security_group_ids #=> Array
resp.vpc_endpoint_details[0].security_group_ids[0] #=> String
resp.vpc_endpoint_details[0].status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"
resp.vpc_endpoint_details[0].subnet_ids #=> Array
resp.vpc_endpoint_details[0].subnet_ids[0] #=> String
resp.vpc_endpoint_details[0].vpc_id #=> String
resp.vpc_endpoint_error_details #=> Array
resp.vpc_endpoint_error_details[0].error_code #=> String
resp.vpc_endpoint_error_details[0].error_message #=> String
resp.vpc_endpoint_error_details[0].id #=> String

Parameters:

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

    ({})

Options Hash (params):

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

    A list of VPC endpoint identifiers.

Returns:

See Also:



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

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

#create_access_policy(params = {}) ⇒ Types::CreateAccessPolicyResponse

Creates a data access policy for OpenSearch Serverless. Access policies limit access to collections and the resources within them, and allow a user to access that data irrespective of the access mechanism or network source. For more information, see Data access control for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.create_access_policy({
  client_token: "ClientToken",
  description: "PolicyDescription",
  name: "PolicyName", # required
  policy: "PolicyDocument", # required
  type: "data", # required, accepts data
})

Response structure


resp.access_policy_detail.created_date #=> Integer
resp.access_policy_detail.description #=> String
resp.access_policy_detail.last_modified_date #=> Integer
resp.access_policy_detail.name #=> String
resp.access_policy_detail.policy_version #=> String
resp.access_policy_detail.type #=> String, one of "data"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the policy. Typically used to store information about the permissions defined in the policy.

  • :name (required, String) —

    The name of the policy.

  • :policy (required, String) —

    The JSON policy document to use as the content for the policy.

  • :type (required, String) —

    The type of policy.

Returns:

See Also:



755
756
757
758
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 755

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

#create_collection(params = {}) ⇒ Types::CreateCollectionResponse

Creates a new OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Examples:

Request syntax with placeholder values


resp = client.create_collection({
  client_token: "ClientToken",
  description: "CreateCollectionRequestDescriptionString",
  name: "CollectionName", # required
  standby_replicas: "ENABLED", # accepts ENABLED, DISABLED
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
  type: "SEARCH", # accepts SEARCH, TIMESERIES, VECTORSEARCH
})

Response structure


resp.create_collection_detail.arn #=> String
resp.create_collection_detail.created_date #=> Integer
resp.create_collection_detail.description #=> String
resp.create_collection_detail.id #=> String
resp.create_collection_detail.kms_key_arn #=> String
resp.create_collection_detail.last_modified_date #=> Integer
resp.create_collection_detail.name #=> String
resp.create_collection_detail.standby_replicas #=> String, one of "ENABLED", "DISABLED"
resp.create_collection_detail.status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
resp.create_collection_detail.type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    Description of the collection.

  • :name (required, String) —

    Name of the collection.

  • :standby_replicas (String) —

    Indicates whether standby replicas should be used for a collection.

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

    An arbitrary set of tags (key–value pairs) to associate with the OpenSearch Serverless collection.

  • :type (String) —

    The type of collection.

Returns:

See Also:



828
829
830
831
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 828

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

#create_lifecycle_policy(params = {}) ⇒ Types::CreateLifecyclePolicyResponse

Creates a lifecyle policy to be applied to OpenSearch Serverless indexes. Lifecycle policies define the number of days or hours to retain the data on an OpenSearch Serverless index. For more information, see Creating data lifecycle policies.

Examples:

Request syntax with placeholder values


resp = client.create_lifecycle_policy({
  client_token: "ClientToken",
  description: "PolicyDescription",
  name: "PolicyName", # required
  policy: "PolicyDocument", # required
  type: "retention", # required, accepts retention
})

Response structure


resp.lifecycle_policy_detail.created_date #=> Integer
resp.lifecycle_policy_detail.description #=> String
resp.lifecycle_policy_detail.last_modified_date #=> Integer
resp.lifecycle_policy_detail.name #=> String
resp.lifecycle_policy_detail.policy_version #=> String
resp.lifecycle_policy_detail.type #=> String, one of "retention"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the lifecycle policy.

  • :name (required, String) —

    The name of the lifecycle policy.

  • :policy (required, String) —

    The JSON policy document to use as the content for the lifecycle policy.

  • :type (required, String) —

    The type of lifecycle policy.

Returns:

See Also:



889
890
891
892
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 889

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

#create_security_config(params = {}) ⇒ Types::CreateSecurityConfigResponse

Specifies a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.create_security_config({
  client_token: "ClientToken",
  description: "ConfigDescription",
  iam_identity_center_options: {
    group_attribute: "GroupId", # accepts GroupId, GroupName
    instance_arn: "IamIdentityCenterInstanceArn", # required
    user_attribute: "UserId", # accepts UserId, UserName, Email
  },
  name: "ConfigName", # required
  saml_options: {
    group_attribute: "samlGroupAttribute",
    metadata: "samlMetadata", # required
    session_timeout: 1,
    user_attribute: "samlUserAttribute",
  },
  type: "saml", # required, accepts saml, iamidentitycenter
})

Response structure


resp.security_config_detail.config_version #=> String
resp.security_config_detail.created_date #=> Integer
resp.security_config_detail.description #=> String
resp.security_config_detail.iam_identity_center_options.application_arn #=> String
resp.security_config_detail.iam_identity_center_options.application_description #=> String
resp.security_config_detail.iam_identity_center_options.application_name #=> String
resp.security_config_detail.iam_identity_center_options.group_attribute #=> String, one of "GroupId", "GroupName"
resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
resp.security_config_detail.iam_identity_center_options.user_attribute #=> String, one of "UserId", "UserName", "Email"
resp.security_config_detail.id #=> String
resp.security_config_detail.last_modified_date #=> Integer
resp.security_config_detail.saml_options.group_attribute #=> String
resp.security_config_detail.saml_options.metadata #=> String
resp.security_config_detail.saml_options.session_timeout #=> Integer
resp.security_config_detail.saml_options.user_attribute #=> String
resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the security configuration.

  • :iam_identity_center_options (Types::CreateIamIdentityCenterConfigOptions) —

    Describes IAM Identity Center options in the form of a key-value map. This field is required if you specify iamidentitycenter for the type parameter.

  • :name (required, String) —

    The name of the security configuration.

  • :saml_options (Types::SamlConfigOptions) —

    Describes SAML options in in the form of a key-value map. This field is required if you specify saml for the type parameter.

  • :type (required, String) —

    The type of security configuration.

Returns:

See Also:



974
975
976
977
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 974

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

#create_security_policy(params = {}) ⇒ Types::CreateSecurityPolicyResponse

Creates a security policy to be used by one or more OpenSearch Serverless collections. Security policies provide access to a collection and its OpenSearch Dashboards endpoint from public networks or specific VPC endpoints. They also allow you to secure a collection with a KMS encryption key. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.create_security_policy({
  client_token: "ClientToken",
  description: "PolicyDescription",
  name: "PolicyName", # required
  policy: "PolicyDocument", # required
  type: "encryption", # required, accepts encryption, network
})

Response structure


resp.security_policy_detail.created_date #=> Integer
resp.security_policy_detail.description #=> String
resp.security_policy_detail.last_modified_date #=> Integer
resp.security_policy_detail.name #=> String
resp.security_policy_detail.policy_version #=> String
resp.security_policy_detail.type #=> String, one of "encryption", "network"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the policy. Typically used to store information about the permissions defined in the policy.

  • :name (required, String) —

    The name of the policy.

  • :policy (required, String) —

    The JSON policy document to use as the content for the new policy.

  • :type (required, String) —

    The type of security policy.

Returns:

See Also:



1039
1040
1041
1042
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1039

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

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

Creates an OpenSearch Serverless-managed interface VPC endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Examples:

Request syntax with placeholder values


resp = client.create_vpc_endpoint({
  client_token: "ClientToken",
  name: "VpcEndpointName", # required
  security_group_ids: ["SecurityGroupId"],
  subnet_ids: ["SubnetId"], # required
  vpc_id: "VpcId", # required
})

Response structure


resp.create_vpc_endpoint_detail.id #=> String
resp.create_vpc_endpoint_detail.name #=> String
resp.create_vpc_endpoint_detail.status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    The name of the interface endpoint.

  • :security_group_ids (Array<String>) —

    The unique identifiers of the security groups that define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

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

    The ID of one or more subnets from which you'll access OpenSearch Serverless.

  • :vpc_id (required, String) —

    The ID of the VPC from which you'll access OpenSearch Serverless.

Returns:

See Also:



1098
1099
1100
1101
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1098

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

#delete_access_policy(params = {}) ⇒ Struct

Deletes an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.delete_access_policy({
  client_token: "ClientToken",
  name: "PolicyName", # required
  type: "data", # required, accepts data
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    The name of the policy to delete.

  • :type (required, String) —

    The type of policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1137
1138
1139
1140
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1137

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

#delete_collection(params = {}) ⇒ Types::DeleteCollectionResponse

Deletes an OpenSearch Serverless collection. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Examples:

Request syntax with placeholder values


resp = client.delete_collection({
  client_token: "ClientToken",
  id: "CollectionId", # required
})

Response structure


resp.delete_collection_detail.id #=> String
resp.delete_collection_detail.name #=> String
resp.delete_collection_detail.status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :id (required, String) —

    The unique identifier of the collection. For example, 1iu5usc406kd. The ID is part of the collection endpoint. You can also retrieve it using the ListCollections API.

Returns:

See Also:



1186
1187
1188
1189
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1186

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

#delete_lifecycle_policy(params = {}) ⇒ Struct

Deletes an OpenSearch Serverless lifecycle policy. For more information, see Deleting data lifecycle policies.

Examples:

Request syntax with placeholder values


resp = client.delete_lifecycle_policy({
  client_token: "ClientToken",
  name: "PolicyName", # required
  type: "retention", # required, accepts retention
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    The name of the policy to delete.

  • :type (required, String) —

    The type of lifecycle policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1225
1226
1227
1228
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1225

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

#delete_security_config(params = {}) ⇒ Struct

Deletes a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.delete_security_config({
  client_token: "ClientToken",
  id: "SecurityConfigId", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :id (required, String) —

    The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1263
1264
1265
1266
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1263

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

#delete_security_policy(params = {}) ⇒ Struct

Deletes an OpenSearch Serverless security policy.

Examples:

Request syntax with placeholder values


resp = client.delete_security_policy({
  client_token: "ClientToken",
  name: "PolicyName", # required
  type: "encryption", # required, accepts encryption, network
})

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :name (required, String) —

    The name of the policy to delete.

  • :type (required, String) —

    The type of policy.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1297
1298
1299
1300
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1297

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

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

Deletes an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Examples:

Request syntax with placeholder values


resp = client.delete_vpc_endpoint({
  client_token: "ClientToken",
  id: "VpcEndpointId", # required
})

Response structure


resp.delete_vpc_endpoint_detail.id #=> String
resp.delete_vpc_endpoint_detail.name #=> String
resp.delete_vpc_endpoint_detail.status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :id (required, String) —

    The VPC endpoint identifier.

Returns:

See Also:



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

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

#get_access_policy(params = {}) ⇒ Types::GetAccessPolicyResponse

Returns an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.get_access_policy({
  name: "PolicyName", # required
  type: "data", # required, accepts data
})

Response structure


resp.access_policy_detail.created_date #=> Integer
resp.access_policy_detail.description #=> String
resp.access_policy_detail.last_modified_date #=> Integer
resp.access_policy_detail.name #=> String
resp.access_policy_detail.policy_version #=> String
resp.access_policy_detail.type #=> String, one of "data"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the access policy.

  • :type (required, String) —

    Tye type of policy. Currently, the only supported value is data.

Returns:

See Also:



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

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

#get_account_settings(params = {}) ⇒ Types::GetAccountSettingsResponse

Returns account-level settings related to OpenSearch Serverless.

Examples:

Response structure


resp..capacity_limits.max_indexing_capacity_in_ocu #=> Integer
resp..capacity_limits.max_search_capacity_in_ocu #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



1403
1404
1405
1406
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1403

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

#get_policies_stats(params = {}) ⇒ Types::GetPoliciesStatsResponse

Returns statistical information about your OpenSearch Serverless access policies, security configurations, and security policies.

Examples:

Response structure


resp.access_policy_stats.data_policy_count #=> Integer
resp.lifecycle_policy_stats.retention_policy_count #=> Integer
resp.security_config_stats.saml_config_count #=> Integer
resp.security_policy_stats.encryption_policy_count #=> Integer
resp.security_policy_stats.network_policy_count #=> Integer
resp.total_policy_count #=> Integer

Parameters:

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

    ({})

Returns:

See Also:



1432
1433
1434
1435
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1432

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

#get_security_config(params = {}) ⇒ Types::GetSecurityConfigResponse

Returns information about an OpenSearch Serverless security configuration. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.get_security_config({
  id: "SecurityConfigId", # required
})

Response structure


resp.security_config_detail.config_version #=> String
resp.security_config_detail.created_date #=> Integer
resp.security_config_detail.description #=> String
resp.security_config_detail.iam_identity_center_options.application_arn #=> String
resp.security_config_detail.iam_identity_center_options.application_description #=> String
resp.security_config_detail.iam_identity_center_options.application_name #=> String
resp.security_config_detail.iam_identity_center_options.group_attribute #=> String, one of "GroupId", "GroupName"
resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
resp.security_config_detail.iam_identity_center_options.user_attribute #=> String, one of "UserId", "UserName", "Email"
resp.security_config_detail.id #=> String
resp.security_config_detail.last_modified_date #=> Integer
resp.security_config_detail.saml_options.group_attribute #=> String
resp.security_config_detail.saml_options.metadata #=> String
resp.security_config_detail.saml_options.session_timeout #=> Integer
resp.security_config_detail.saml_options.user_attribute #=> String
resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"

Parameters:

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

    ({})

Options Hash (params):

  • :id (required, String) —

    The unique identifier of the security configuration.

Returns:

See Also:



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

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

#get_security_policy(params = {}) ⇒ Types::GetSecurityPolicyResponse

Returns information about a configured OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.get_security_policy({
  name: "PolicyName", # required
  type: "encryption", # required, accepts encryption, network
})

Response structure


resp.security_policy_detail.created_date #=> Integer
resp.security_policy_detail.description #=> String
resp.security_policy_detail.last_modified_date #=> Integer
resp.security_policy_detail.name #=> String
resp.security_policy_detail.policy_version #=> String
resp.security_policy_detail.type #=> String, one of "encryption", "network"

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String) —

    The name of the security policy.

  • :type (required, String) —

    The type of security policy.

Returns:

See Also:



1526
1527
1528
1529
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1526

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

#list_access_policies(params = {}) ⇒ Types::ListAccessPoliciesResponse

Returns information about a list of OpenSearch Serverless access policies.

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_access_policies({
  max_results: 1,
  next_token: "String",
  resource: ["Resource"],
  type: "data", # required, accepts data
})

Response structure


resp.access_policy_summaries #=> Array
resp.access_policy_summaries[0].created_date #=> Integer
resp.access_policy_summaries[0].description #=> String
resp.access_policy_summaries[0].last_modified_date #=> Integer
resp.access_policy_summaries[0].name #=> String
resp.access_policy_summaries[0].policy_version #=> String
resp.access_policy_summaries[0].type #=> String, one of "data"
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. The default is 20.

  • :next_token (String) —

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

  • :resource (Array<String>) —

    Resource filters (can be collections or indexes) that policies can apply to.

  • :type (required, String) —

    The type of access policy.

Returns:

See Also:



1583
1584
1585
1586
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1583

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

#list_collections(params = {}) ⇒ Types::ListCollectionsResponse

Lists all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.

Make sure to include an empty request body {} if you don't include any collection filters in the request.

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_collections({
  collection_filters: {
    name: "CollectionName",
    status: "CREATING", # accepts CREATING, DELETING, ACTIVE, FAILED
  },
  max_results: 1,
  next_token: "String",
})

Response structure


resp.collection_summaries #=> Array
resp.collection_summaries[0].arn #=> String
resp.collection_summaries[0].id #=> String
resp.collection_summaries[0].name #=> String
resp.collection_summaries[0].status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :collection_filters (Types::CollectionFilters) —

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

  • :max_results (Integer) —

    The maximum number of results to return. Default is 20. You can use nextToken to get the next page of results.

  • :next_token (String) —

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

Returns:

See Also:



1643
1644
1645
1646
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1643

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

#list_lifecycle_policies(params = {}) ⇒ Types::ListLifecyclePoliciesResponse

Returns a list of OpenSearch Serverless lifecycle policies. For more information, see Viewing data lifecycle policies.

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_lifecycle_policies({
  max_results: 1,
  next_token: "String",
  resources: ["LifecycleResource"],
  type: "retention", # required, accepts retention
})

Response structure


resp.lifecycle_policy_summaries #=> Array
resp.lifecycle_policy_summaries[0].created_date #=> Integer
resp.lifecycle_policy_summaries[0].description #=> String
resp.lifecycle_policy_summaries[0].last_modified_date #=> Integer
resp.lifecycle_policy_summaries[0].name #=> String
resp.lifecycle_policy_summaries[0].policy_version #=> String
resp.lifecycle_policy_summaries[0].type #=> String, one of "retention"
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 use nextToken to get the next page of results. The default is 10.

  • :next_token (String) —

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

  • :resources (Array<String>) —

    Resource filters that policies can apply to. Currently, the only supported resource type is index.

  • :type (required, String) —

    The type of lifecycle policy.

Returns:

See Also:



1704
1705
1706
1707
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1704

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

#list_security_configs(params = {}) ⇒ Types::ListSecurityConfigsResponse

Returns information about configured OpenSearch Serverless security configurations. For more information, see SAML authentication for Amazon OpenSearch Serverless.

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_security_configs({
  max_results: 1,
  next_token: "String",
  type: "saml", # required, accepts saml, iamidentitycenter
})

Response structure


resp.next_token #=> String
resp.security_config_summaries #=> Array
resp.security_config_summaries[0].config_version #=> String
resp.security_config_summaries[0].created_date #=> Integer
resp.security_config_summaries[0].description #=> String
resp.security_config_summaries[0].id #=> String
resp.security_config_summaries[0].last_modified_date #=> Integer
resp.security_config_summaries[0].type #=> String, one of "saml", "iamidentitycenter"

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. The default is 20.

  • :next_token (String) —

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

  • :type (required, String) —

    The type of security configuration.

Returns:

See Also:



1761
1762
1763
1764
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1761

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

#list_security_policies(params = {}) ⇒ Types::ListSecurityPoliciesResponse

Returns information about configured OpenSearch Serverless security policies.

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_security_policies({
  max_results: 1,
  next_token: "String",
  resource: ["Resource"],
  type: "encryption", # required, accepts encryption, network
})

Response structure


resp.next_token #=> String
resp.security_policy_summaries #=> Array
resp.security_policy_summaries[0].created_date #=> Integer
resp.security_policy_summaries[0].description #=> String
resp.security_policy_summaries[0].last_modified_date #=> Integer
resp.security_policy_summaries[0].name #=> String
resp.security_policy_summaries[0].policy_version #=> String
resp.security_policy_summaries[0].type #=> String, one of "encryption", "network"

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. The default is 20.

  • :next_token (String) —

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

  • :resource (Array<String>) —

    Resource filters (can be collection or indexes) that policies can apply to.

  • :type (required, String) —

    The type of policy.

Returns:

See Also:



1818
1819
1820
1821
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1818

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

#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse

Returns the tags for an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

Examples:

Request syntax with placeholder values


resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

Returns:

See Also:



1856
1857
1858
1859
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1856

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

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

Returns the OpenSearch Serverless-managed interface VPC endpoints associated with the current account. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

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_vpc_endpoints({
  max_results: 1,
  next_token: "String",
  vpc_endpoint_filters: {
    status: "PENDING", # accepts PENDING, DELETING, ACTIVE, FAILED
  },
})

Response structure


resp.next_token #=> String
resp.vpc_endpoint_summaries #=> Array
resp.vpc_endpoint_summaries[0].id #=> String
resp.vpc_endpoint_summaries[0].name #=> String
resp.vpc_endpoint_summaries[0].status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"

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. The default is 20.

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

  • :vpc_endpoint_filters (Types::VpcEndpointFilters) —

    Filter the results according to the current status of the VPC endpoint. Possible statuses are CREATING, DELETING, UPDATING, ACTIVE, and FAILED.

Returns:

See Also:



1913
1914
1915
1916
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1913

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

#tag_resource(params = {}) ⇒ Struct

Associates tags with an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

Examples:

Request syntax with placeholder values


resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

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

    A list of tags (key-value pairs) to add to the resource. All tag keys in the request must be unique.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1953
1954
1955
1956
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1953

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

#untag_resource(params = {}) ⇒ Struct

Removes a tag or set of tags from an OpenSearch Serverless resource. For more information, see Tagging Amazon OpenSearch Serverless collections.

Examples:

Request syntax with placeholder values


resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) of the resource to remove tags from. The resource must be active (not in the DELETING state), and must be owned by the account ID included in the request.

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

    The tag or set of tags to remove from the resource. All tag keys in the request must be unique.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1988
1989
1990
1991
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 1988

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

#update_access_policy(params = {}) ⇒ Types::UpdateAccessPolicyResponse

Updates an OpenSearch Serverless access policy. For more information, see Data access control for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.update_access_policy({
  client_token: "ClientToken",
  description: "PolicyDescription",
  name: "PolicyName", # required
  policy: "PolicyDocument",
  policy_version: "PolicyVersion", # required
  type: "data", # required, accepts data
})

Response structure


resp.access_policy_detail.created_date #=> Integer
resp.access_policy_detail.description #=> String
resp.access_policy_detail.last_modified_date #=> Integer
resp.access_policy_detail.name #=> String
resp.access_policy_detail.policy_version #=> String
resp.access_policy_detail.type #=> String, one of "data"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the policy. Typically used to store information about the permissions defined in the policy.

  • :name (required, String) —

    The name of the policy.

  • :policy (String) —

    The JSON policy document to use as the content for the policy.

  • :policy_version (required, String) —

    The version of the policy being updated.

  • :type (required, String) —

    The type of policy.

Returns:

See Also:



2051
2052
2053
2054
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2051

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

#update_account_settings(params = {}) ⇒ Types::UpdateAccountSettingsResponse

Update the OpenSearch Serverless settings for the current Amazon Web Services account. For more information, see Managing capacity limits for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.({
  capacity_limits: {
    max_indexing_capacity_in_ocu: 1,
    max_search_capacity_in_ocu: 1,
  },
})

Response structure


resp..capacity_limits.max_indexing_capacity_in_ocu #=> Integer
resp..capacity_limits.max_search_capacity_in_ocu #=> Integer

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



2096
2097
2098
2099
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2096

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

#update_collection(params = {}) ⇒ Types::UpdateCollectionResponse

Updates an OpenSearch Serverless collection.

Examples:

Request syntax with placeholder values


resp = client.update_collection({
  client_token: "ClientToken",
  description: "UpdateCollectionRequestDescriptionString",
  id: "CollectionId", # required
})

Response structure


resp.update_collection_detail.arn #=> String
resp.update_collection_detail.created_date #=> Integer
resp.update_collection_detail.description #=> String
resp.update_collection_detail.id #=> String
resp.update_collection_detail.last_modified_date #=> Integer
resp.update_collection_detail.name #=> String
resp.update_collection_detail.status #=> String, one of "CREATING", "DELETING", "ACTIVE", "FAILED"
resp.update_collection_detail.type #=> String, one of "SEARCH", "TIMESERIES", "VECTORSEARCH"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the collection.

  • :id (required, String) —

    The unique identifier of the collection.

Returns:

See Also:



2143
2144
2145
2146
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2143

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

#update_lifecycle_policy(params = {}) ⇒ Types::UpdateLifecyclePolicyResponse

Updates an OpenSearch Serverless access policy. For more information, see Updating data lifecycle policies.

Examples:

Request syntax with placeholder values


resp = client.update_lifecycle_policy({
  client_token: "ClientToken",
  description: "PolicyDescription",
  name: "PolicyName", # required
  policy: "PolicyDocument",
  policy_version: "PolicyVersion", # required
  type: "retention", # required, accepts retention
})

Response structure


resp.lifecycle_policy_detail.created_date #=> Integer
resp.lifecycle_policy_detail.description #=> String
resp.lifecycle_policy_detail.last_modified_date #=> Integer
resp.lifecycle_policy_detail.name #=> String
resp.lifecycle_policy_detail.policy_version #=> String
resp.lifecycle_policy_detail.type #=> String, one of "retention"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the lifecycle policy.

  • :name (required, String) —

    The name of the policy.

  • :policy (String) —

    The JSON policy document to use as the content for the lifecycle policy.

  • :policy_version (required, String) —

    The version of the policy being updated.

  • :type (required, String) —

    The type of lifecycle policy.

Returns:

See Also:



2206
2207
2208
2209
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2206

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

#update_security_config(params = {}) ⇒ Types::UpdateSecurityConfigResponse

Updates a security configuration for OpenSearch Serverless. For more information, see SAML authentication for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.update_security_config({
  client_token: "ClientToken",
  config_version: "PolicyVersion", # required
  description: "ConfigDescription",
  iam_identity_center_options_updates: {
    group_attribute: "GroupId", # accepts GroupId, GroupName
    user_attribute: "UserId", # accepts UserId, UserName, Email
  },
  id: "SecurityConfigId", # required
  saml_options: {
    group_attribute: "samlGroupAttribute",
    metadata: "samlMetadata", # required
    session_timeout: 1,
    user_attribute: "samlUserAttribute",
  },
})

Response structure


resp.security_config_detail.config_version #=> String
resp.security_config_detail.created_date #=> Integer
resp.security_config_detail.description #=> String
resp.security_config_detail.iam_identity_center_options.application_arn #=> String
resp.security_config_detail.iam_identity_center_options.application_description #=> String
resp.security_config_detail.iam_identity_center_options.application_name #=> String
resp.security_config_detail.iam_identity_center_options.group_attribute #=> String, one of "GroupId", "GroupName"
resp.security_config_detail.iam_identity_center_options.instance_arn #=> String
resp.security_config_detail.iam_identity_center_options.user_attribute #=> String, one of "UserId", "UserName", "Email"
resp.security_config_detail.id #=> String
resp.security_config_detail.last_modified_date #=> Integer
resp.security_config_detail.saml_options.group_attribute #=> String
resp.security_config_detail.saml_options.metadata #=> String
resp.security_config_detail.saml_options.session_timeout #=> Integer
resp.security_config_detail.saml_options.user_attribute #=> String
resp.security_config_detail.type #=> String, one of "saml", "iamidentitycenter"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :config_version (required, String) —

    The version of the security configuration to be updated. You can find the most recent version of a security configuration using the GetSecurityPolicy command.

  • :description (String) —

    A description of the security configuration.

  • :iam_identity_center_options_updates (Types::UpdateIamIdentityCenterConfigOptions) —

    Describes IAM Identity Center options in the form of a key-value map.

  • :id (required, String) —

    The security configuration identifier. For SAML the ID will be saml/<accountId>/<idpProviderName>. For example, saml/123456789123/OKTADev.

  • :saml_options (Types::SamlConfigOptions) —

    SAML options in in the form of a key-value map.

Returns:

See Also:



2291
2292
2293
2294
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2291

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

#update_security_policy(params = {}) ⇒ Types::UpdateSecurityPolicyResponse

Updates an OpenSearch Serverless security policy. For more information, see Network access for Amazon OpenSearch Serverless and Encryption at rest for Amazon OpenSearch Serverless.

Examples:

Request syntax with placeholder values


resp = client.update_security_policy({
  client_token: "ClientToken",
  description: "PolicyDescription",
  name: "PolicyName", # required
  policy: "PolicyDocument",
  policy_version: "PolicyVersion", # required
  type: "encryption", # required, accepts encryption, network
})

Response structure


resp.security_policy_detail.created_date #=> Integer
resp.security_policy_detail.description #=> String
resp.security_policy_detail.last_modified_date #=> Integer
resp.security_policy_detail.name #=> String
resp.security_policy_detail.policy_version #=> String
resp.security_policy_detail.type #=> String, one of "encryption", "network"

Parameters:

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

    ({})

Options Hash (params):

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :description (String) —

    A description of the policy. Typically used to store information about the permissions defined in the policy.

  • :name (required, String) —

    The name of the policy.

  • :policy (String) —

    The JSON policy document to use as the content for the new policy.

  • :policy_version (required, String) —

    The version of the policy being updated.

  • :type (required, String) —

    The type of access policy.

Returns:

See Also:



2356
2357
2358
2359
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2356

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

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

Updates an OpenSearch Serverless-managed interface endpoint. For more information, see Access Amazon OpenSearch Serverless using an interface endpoint.

Examples:

Request syntax with placeholder values


resp = client.update_vpc_endpoint({
  add_security_group_ids: ["SecurityGroupId"],
  add_subnet_ids: ["SubnetId"],
  client_token: "ClientToken",
  id: "VpcEndpointId", # required
  remove_security_group_ids: ["SecurityGroupId"],
  remove_subnet_ids: ["SubnetId"],
})

Response structure


resp.update_vpc_endpoint_detail.id #=> String
resp.update_vpc_endpoint_detail.last_modified_date #=> Integer
resp.update_vpc_endpoint_detail.name #=> String
resp.update_vpc_endpoint_detail.security_group_ids #=> Array
resp.update_vpc_endpoint_detail.security_group_ids[0] #=> String
resp.update_vpc_endpoint_detail.status #=> String, one of "PENDING", "DELETING", "ACTIVE", "FAILED"
resp.update_vpc_endpoint_detail.subnet_ids #=> Array
resp.update_vpc_endpoint_detail.subnet_ids[0] #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :add_security_group_ids (Array<String>) —

    The unique identifiers of the security groups to add to the endpoint. Security groups define the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.

  • :add_subnet_ids (Array<String>) —

    The ID of one or more subnets to add to the endpoint.

  • :client_token (String) —

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

    A suitable default value is auto-generated. You should normally not need to pass this option.**

  • :id (required, String) —

    The unique identifier of the interface endpoint to update.

  • :remove_security_group_ids (Array<String>) —

    The unique identifiers of the security groups to remove from the endpoint.

  • :remove_subnet_ids (Array<String>) —

    The unique identifiers of the subnets to remove from the endpoint.

Returns:

See Also:



2424
2425
2426
2427
 
# File 'gems/aws-sdk-opensearchserverless/lib/aws-sdk-opensearchserverless/client.rb', line 2424

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