You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

Class: AWS.OpenSearchServerless

Inherits:
AWS.Service show all
Identifier:
opensearchserverless
API Version:
2021-11-01
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Use the Amazon OpenSearch Serverless API to create, configure, and manage OpenSearch Serverless collections and security policies.

OpenSearch Serverless is an on-demand, pre-provisioned serverless configuration for Amazon OpenSearch Service. OpenSearch Serverless removes the operational complexities of provisioning, configuring, and tuning your OpenSearch clusters. It enables you to easily search and analyze petabytes of data without having to worry about the underlying infrastructure and data management.

To learn more about OpenSearch Serverless, see What is Amazon OpenSearch Serverless?

Sending a Request Using OpenSearchServerless

var opensearchserverless = new AWS.OpenSearchServerless();
opensearchserverless.batchGetCollection(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the OpenSearchServerless object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var opensearchserverless = new AWS.OpenSearchServerless({apiVersion: '2021-11-01'});

You can also set the API version globally in AWS.config.apiVersions using the opensearchserverless service identifier:

AWS.config.apiVersions = {
  opensearchserverless: '2021-11-01',
  // other service API versions
};

var opensearchserverless = new AWS.OpenSearchServerless();

Version:

  • 2021-11-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.OpenSearchServerless(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a OpenSearchServerless object

var opensearchserverless = new AWS.OpenSearchServerless({apiVersion: '2021-11-01'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.OpenSearchServerless.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.OpenSearchServerless.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.OpenSearchServerless.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

batchGetCollection(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchGetCollection operation

var params = {
  ids: [
    'STRING_VALUE',
    /* more items */
  ],
  names: [
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.batchGetCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • 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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • collectionDetails — (Array<map>)

        Details about each collection.

        • arn — (String)

          The Amazon Resource Name (ARN) of the collection.

        • collectionEndpoint — (String)

          Collection-specific endpoint used to submit index, search, and data upload requests to an OpenSearch Serverless collection.

        • createdDate — (Integer)

          The Epoch time when the collection was created.

        • dashboardEndpoint — (String)

          Collection-specific endpoint used to access OpenSearch Dashboards.

        • description — (String)

          A description of the collection.

        • id — (String)

          A unique identifier for the collection.

        • kmsKeyArn — (String)

          The ARN of the Amazon Web Services KMS key used to encrypt the collection.

        • lastModifiedDate — (Integer)

          The date and time when the collection was last modified.

        • name — (String)

          The name of the collection.

        • status — (String)

          The current status of the collection.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • type — (String)

          The type of collection.

          Possible values include:
          • "SEARCH"
          • "TIMESERIES"
      • collectionErrorDetails — (Array<map>)

        Error information for the request.

        • errorCode — (String)

          The error code for the request. For example, NOT_FOUND.

        • errorMessage — (String)

          A description of the error. For example, The specified Collection is not found.

        • id — (String)

          If the request contains collection IDs, the response includes the IDs provided in the request.

        • name — (String)

          If the request contains collection names, the response includes the names provided in the request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

batchGetVpcEndpoint(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the batchGetVpcEndpoint operation

var params = {
  ids: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.batchGetVpcEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ids — (Array<String>)

      A list of VPC endpoint identifiers.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • vpcEndpointDetails — (Array<map>)

        Details about the specified VPC endpoint.

        • createdDate — (Integer)

          The date the endpoint was created.

        • id — (String)

          The unique identifier of the endpoint.

        • name — (String)

          The name of the endpoint.

        • securityGroupIds — (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.

        • status — (String)

          The current status of the endpoint.

          Possible values include:
          • "PENDING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • subnetIds — (Array<String>)

          The ID of the subnets from which you access OpenSearch Serverless.

        • vpcId — (String)

          The ID of the VPC from which you access OpenSearch Serverless

      • vpcEndpointErrorDetails — (Array<map>)

        Error information for a failed request.

        • errorCode — (String)

          The error code for the failed request.

        • errorMessage — (String)

          An error message describing the reason for the failure.

        • id — (String)

          The unique identifier of the VPC endpoint.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createAccessPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createAccessPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE', /* required */
  type: data, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
opensearchserverless.createAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

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

    • name — (String)

      The name of the policy.

    • policy — (String)

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

    • type — (String)

      The type of policy.

      Possible values include:
      • "data"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accessPolicyDetail — (map)

        Details about the created access policy.

        • createdDate — (Integer)

          The date the policy was created.

        • description — (String)

          The description of the policy.

        • lastModifiedDate — (Integer)

          The timestamp of when the policy was last modified.

        • name — (String)

          The name of the policy.

        • policy — (map)

          The JSON policy document without any whitespaces.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of access policy.

          Possible values include:
          • "data"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createCollection(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createCollection operation

var params = {
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  type: SEARCH | TIMESERIES
};
opensearchserverless.createCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      Description of the collection.

    • name — (String)

      Name of the collection.

    • tags — (Array<map>)

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

      • keyrequired — (String)

        The key to use in the tag.

      • valuerequired — (String)

        The value of the tag.

    • type — (String)

      The type of collection.

      Possible values include:
      • "SEARCH"
      • "TIMESERIES"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • createCollectionDetail — (map)

        Details about the collection.

        • arn — (String)

          The Amazon Resource Name (ARN) of the collection.

        • createdDate — (Integer)

          The Epoch time when the collection was created.

        • description — (String)

          A description of the collection.

        • id — (String)

          The unique identifier of the collection.

        • kmsKeyArn — (String)

          The Amazon Resource Name (ARN) of the KMS key with which to encrypt the collection.

        • lastModifiedDate — (Integer)

          The date and time when the collection was last modified.

        • name — (String)

          The name of the collection.

        • status — (String)

          The current status of the collection.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • type — (String)

          The type of collection.

          Possible values include:
          • "SEARCH"
          • "TIMESERIES"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSecurityConfig(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createSecurityConfig operation

var params = {
  name: 'STRING_VALUE', /* required */
  type: saml, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  samlOptions: {
    metadata: 'STRING_VALUE', /* required */
    groupAttribute: 'STRING_VALUE',
    sessionTimeout: 'NUMBER_VALUE',
    userAttribute: 'STRING_VALUE'
  }
};
opensearchserverless.createSecurityConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      A description of the security configuration.

    • name — (String)

      The name of the security configuration.

    • samlOptions — (map)

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

      • groupAttribute — (String)

        The group attribute for this SAML integration.

      • metadatarequired — (String)

        The XML IdP metadata file generated from your identity provider.

      • sessionTimeout — (Integer)

        The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.

      • userAttribute — (String)

        A user attribute for this SAML integration.

    • type — (String)

      The type of security configuration.

      Possible values include:
      • "saml"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • securityConfigDetail — (map)

        Details about the created security configuration.

        • configVersion — (String)

          The version of the security configuration.

        • createdDate — (Integer)

          The date the configuration was created.

        • description — (String)

          The description of the security configuration.

        • id — (String)

          The unique identifier of the security configuration.

        • lastModifiedDate — (Integer)

          The timestamp of when the configuration was last modified.

        • samlOptions — (map)

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

          • groupAttribute — (String)

            The group attribute for this SAML integration.

          • metadatarequired — (String)

            The XML IdP metadata file generated from your identity provider.

          • sessionTimeout — (Integer)

            The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.

          • userAttribute — (String)

            A user attribute for this SAML integration.

        • type — (String)

          The type of security configuration.

          Possible values include:
          • "saml"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createSecurityPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the createSecurityPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE', /* required */
  type: encryption | network, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
opensearchserverless.createSecurityPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

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

    • name — (String)

      The name of the policy.

    • policy — (String)

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

    • type — (String)

      The type of security policy.

      Possible values include:
      • "encryption"
      • "network"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • securityPolicyDetail — (map)

        Details about the created security policy.

        • createdDate — (Integer)

          The date the policy was created.

        • description — (String)

          The description of the security policy.

        • lastModifiedDate — (Integer)

          The timestamp of when the policy was last modified.

        • name — (String)

          The name of the policy.

        • policy — (map)

          The JSON policy document without any whitespaces.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of security policy.

          Possible values include:
          • "encryption"
          • "network"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createVpcEndpoint(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the createVpcEndpoint operation

var params = {
  name: 'STRING_VALUE', /* required */
  subnetIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  vpcId: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  securityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.createVpcEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • name — (String)

      The name of the interface endpoint.

    • securityGroupIds — (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.

    • subnetIds — (Array<String>)

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

    • vpcId — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • createVpcEndpointDetail — (map)

        Details about the created interface VPC endpoint.

        • id — (String)

          The unique identifier of the endpoint.

        • name — (String)

          The name of the endpoint.

        • status — (String)

          The current status in the endpoint creation process.

          Possible values include:
          • "PENDING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteAccessPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteAccessPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  type: data, /* required */
  clientToken: 'STRING_VALUE'
};
opensearchserverless.deleteAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • name — (String)

      The name of the policy to delete.

    • type — (String)

      The type of policy.

      Possible values include:
      • "data"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteCollection(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteCollection operation

var params = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
opensearchserverless.deleteCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • id — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deleteCollectionDetail — (map)

        Details of the deleted collection.

        • id — (String)

          The unique identifier of the collection.

        • name — (String)

          The name of the collection.

        • status — (String)

          The current status of the collection.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSecurityConfig(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteSecurityConfig operation

var params = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
opensearchserverless.deleteSecurityConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • id — (String)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteSecurityPolicy(params = {}, callback) ⇒ AWS.Request

Deletes an OpenSearch Serverless security policy.

Service Reference:

Examples:

Calling the deleteSecurityPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  type: encryption | network, /* required */
  clientToken: 'STRING_VALUE'
};
opensearchserverless.deleteSecurityPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • name — (String)

      The name of the policy to delete.

    • type — (String)

      The type of policy.

      Possible values include:
      • "encryption"
      • "network"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteVpcEndpoint(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the deleteVpcEndpoint operation

var params = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE'
};
opensearchserverless.deleteVpcEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • id — (String)

      The VPC endpoint identifier.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • deleteVpcEndpointDetail — (map)

        Details about the deleted endpoint.

        • id — (String)

          The unique identifier of the endpoint.

        • name — (String)

          The name of the endpoint.

        • status — (String)

          The current status of the endpoint deletion process.

          Possible values include:
          • "PENDING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAccessPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getAccessPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  type: data /* required */
};
opensearchserverless.getAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the access policy.

    • type — (String)

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

      Possible values include:
      • "data"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accessPolicyDetail — (map)

        Details about the requested access policy.

        • createdDate — (Integer)

          The date the policy was created.

        • description — (String)

          The description of the policy.

        • lastModifiedDate — (Integer)

          The timestamp of when the policy was last modified.

        • name — (String)

          The name of the policy.

        • policy — (map)

          The JSON policy document without any whitespaces.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of access policy.

          Possible values include:
          • "data"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getAccountSettings(params = {}, callback) ⇒ AWS.Request

Returns account-level settings related to OpenSearch Serverless.

Service Reference:

Examples:

Calling the getAccountSettings operation

var params = {
};
opensearchserverless.getAccountSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountSettingsDetail — (map)

        OpenSearch Serverless-related details for the current account.

        • capacityLimits — (map)

          The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Autoscaling.

          • maxIndexingCapacityInOCU — (Integer)

            The maximum indexing capacity for collections.

          • maxSearchCapacityInOCU — (Integer)

            The maximum search capacity for collections.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPoliciesStats(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getPoliciesStats operation

var params = {
};
opensearchserverless.getPoliciesStats(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • AccessPolicyStats — (map)

        Information about the data access policies in your account.

        • DataPolicyCount — (Integer)

          The number of data access policies in the current account.

      • SecurityConfigStats — (map)

        Information about the security configurations in your account.

        • SamlConfigCount — (Integer)

          The number of security configurations in the current account.

      • SecurityPolicyStats — (map)

        Information about the security policies in your account.

        • EncryptionPolicyCount — (Integer)

          The number of encryption policies in the current account.

        • NetworkPolicyCount — (Integer)

          The number of network policies in the current account.

      • TotalPolicyCount — (Integer)

        The total number of OpenSearch Serverless security policies and configurations in your account.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSecurityConfig(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the getSecurityConfig operation

var params = {
  id: 'STRING_VALUE' /* required */
};
opensearchserverless.getSecurityConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • id — (String)

      The unique identifier of the security configuration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • securityConfigDetail — (map)

        Details of the requested security configuration.

        • configVersion — (String)

          The version of the security configuration.

        • createdDate — (Integer)

          The date the configuration was created.

        • description — (String)

          The description of the security configuration.

        • id — (String)

          The unique identifier of the security configuration.

        • lastModifiedDate — (Integer)

          The timestamp of when the configuration was last modified.

        • samlOptions — (map)

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

          • groupAttribute — (String)

            The group attribute for this SAML integration.

          • metadatarequired — (String)

            The XML IdP metadata file generated from your identity provider.

          • sessionTimeout — (Integer)

            The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.

          • userAttribute — (String)

            A user attribute for this SAML integration.

        • type — (String)

          The type of security configuration.

          Possible values include:
          • "saml"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSecurityPolicy(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the getSecurityPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  type: encryption | network /* required */
};
opensearchserverless.getSecurityPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • name — (String)

      The name of the security policy.

    • type — (String)

      The type of security policy.

      Possible values include:
      • "encryption"
      • "network"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • securityPolicyDetail — (map)

        Details about the requested security policy.

        • createdDate — (Integer)

          The date the policy was created.

        • description — (String)

          The description of the security policy.

        • lastModifiedDate — (Integer)

          The timestamp of when the policy was last modified.

        • name — (String)

          The name of the policy.

        • policy — (map)

          The JSON policy document without any whitespaces.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of security policy.

          Possible values include:
          • "encryption"
          • "network"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAccessPolicies(params = {}, callback) ⇒ AWS.Request

Returns information about a list of OpenSearch Serverless access policies.

Service Reference:

Examples:

Calling the listAccessPolicies operation

var params = {
  type: data, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resource: [
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.listAccessPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (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 collection or indexes) that policies can apply to.

    • type — (String)

      The type of access policy.

      Possible values include:
      • "data"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accessPolicySummaries — (Array<map>)

        Details about the requested access policies.

        • createdDate — (Integer)

          The Epoch time when the access policy was created.

        • description — (String)

          The description of the access policy.

        • lastModifiedDate — (Integer)

          The date and time when the collection was last modified.

        • name — (String)

          The name of the access policy.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of access policy. Currently the only available type is data.

          Possible values include:
          • "data"
      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listCollections(params = {}, callback) ⇒ AWS.Request

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

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

Service Reference:

Examples:

Calling the listCollections operation

var params = {
  collectionFilters: {
    name: 'STRING_VALUE',
    status: CREATING | DELETING | ACTIVE | FAILED
  },
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
opensearchserverless.listCollections(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • collectionFilters — (map)

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

      • name — (String)

        The name of the collection.

      • status — (String)

        The current status of the collection.

        Possible values include:
        • "CREATING"
        • "DELETING"
        • "ACTIVE"
        • "FAILED"
    • maxResults — (Integer)

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

    • nextToken — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • collectionSummaries — (Array<map>)

        Details about each collection.

        • arn — (String)

          The Amazon Resource Name (ARN) of the collection.

        • id — (String)

          The unique identifier of the collection.

        • name — (String)

          The name of the collection.

        • status — (String)

          The current status of the collection.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSecurityConfigs(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listSecurityConfigs operation

var params = {
  type: saml, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE'
};
opensearchserverless.listSecurityConfigs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (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 — (String)

      The type of security configuration.

      Possible values include:
      • "saml"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

      • securityConfigSummaries — (Array<map>)

        Details about the security configurations in your account.

        • configVersion — (String)

          The version of the security configuration.

        • createdDate — (Integer)

          The Epoch time when the security configuration was created.

        • description — (String)

          The description of the security configuration.

        • id — (String)

          The unique identifier of the security configuration.

        • lastModifiedDate — (Integer)

          The timestamp of when the configuration was last modified.

        • type — (String)

          The type of security configuration.

          Possible values include:
          • "saml"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listSecurityPolicies(params = {}, callback) ⇒ AWS.Request

Returns information about configured OpenSearch Serverless security policies.

Service Reference:

Examples:

Calling the listSecurityPolicies operation

var params = {
  type: encryption | network, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resource: [
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.listSecurityPolicies(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (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 — (String)

      The type of policy.

      Possible values include:
      • "encryption"
      • "network"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

      • securityPolicySummaries — (Array<map>)

        Details about the security policies in your account.

        • createdDate — (Integer)

          The date the policy was created.

        • description — (String)

          The description of the security policy.

        • lastModifiedDate — (Integer)

          The timestamp of when the policy was last modified.

        • name — (String)

          The name of the policy.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of security policy.

          Possible values include:
          • "encryption"
          • "network"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  resourceArn: 'STRING_VALUE' /* required */
};
opensearchserverless.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • tags — (Array<map>)

        The tags associated with the resource.

        • keyrequired — (String)

          The key to use in the tag.

        • valuerequired — (String)

          The value of the tag.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listVpcEndpoints(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the listVpcEndpoints operation

var params = {
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  vpcEndpointFilters: {
    status: PENDING | DELETING | ACTIVE | FAILED
  }
};
opensearchserverless.listVpcEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • maxResults — (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.

    • nextToken — (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.

    • vpcEndpointFilters — (map)

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

      • status — (String)

        The current status of the endpoint.

        Possible values include:
        • "PENDING"
        • "DELETING"
        • "ACTIVE"
        • "FAILED"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • nextToken — (String)

        When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.

      • vpcEndpointSummaries — (Array<map>)

        Details about each VPC endpoint, including the name and current status.

        • id — (String)

          The unique identifier of the endpoint.

        • name — (String)

          The name of the endpoint.

        • status — (String)

          The current status of the endpoint.

          Possible values include:
          • "PENDING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tags: [ /* required */
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
opensearchserverless.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (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 — (Array<map>)

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

      • keyrequired — (String)

        The key to use in the tag.

      • valuerequired — (String)

        The value of the tag.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  resourceArn: 'STRING_VALUE', /* required */
  tagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • resourceArn — (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.

    • tagKeys — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAccessPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateAccessPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  policyVersion: 'STRING_VALUE', /* required */
  type: data, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  policy: 'STRING_VALUE'
};
opensearchserverless.updateAccessPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

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

    • name — (String)

      The name of the policy.

    • policy — (String)

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

    • policyVersion — (String)

      The version of the policy being updated.

    • type — (String)

      The type of policy.

      Possible values include:
      • "data"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accessPolicyDetail — (map)

        Details about the updated access policy.

        • createdDate — (Integer)

          The date the policy was created.

        • description — (String)

          The description of the policy.

        • lastModifiedDate — (Integer)

          The timestamp of when the policy was last modified.

        • name — (String)

          The name of the policy.

        • policy — (map)

          The JSON policy document without any whitespaces.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of access policy.

          Possible values include:
          • "data"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateAccountSettings(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateAccountSettings operation

var params = {
  capacityLimits: {
    maxIndexingCapacityInOCU: 'NUMBER_VALUE',
    maxSearchCapacityInOCU: 'NUMBER_VALUE'
  }
};
opensearchserverless.updateAccountSettings(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • capacityLimits — (map)

      The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Autoscaling.

      • maxIndexingCapacityInOCU — (Integer)

        The maximum indexing capacity for collections.

      • maxSearchCapacityInOCU — (Integer)

        The maximum search capacity for collections.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • accountSettingsDetail — (map)

        OpenSearch Serverless-related settings for the current Amazon Web Services account.

        • capacityLimits — (map)

          The maximum capacity limits for all OpenSearch Serverless collections, in OpenSearch Compute Units (OCUs). These limits are used to scale your collections based on the current workload. For more information, see Autoscaling.

          • maxIndexingCapacityInOCU — (Integer)

            The maximum indexing capacity for collections.

          • maxSearchCapacityInOCU — (Integer)

            The maximum search capacity for collections.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateCollection(params = {}, callback) ⇒ AWS.Request

Updates an OpenSearch Serverless collection.

Service Reference:

Examples:

Calling the updateCollection operation

var params = {
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
opensearchserverless.updateCollection(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

      A description of the collection.

    • id — (String)

      The unique identifier of the collection.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • updateCollectionDetail — (map)

        Details about the updated collection.

        • arn — (String)

          The Amazon Resource Name (ARN) of the collection.

        • createdDate — (Integer)

          The date and time when the collection was created.

        • description — (String)

          The description of the collection.

        • id — (String)

          The unique identifier of the collection.

        • lastModifiedDate — (Integer)

          The date and time when the collection was last modified.

        • name — (String)

          The name of the collection.

        • status — (String)

          The current status of the collection.

          Possible values include:
          • "CREATING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • type — (String)

          The collection type.

          Possible values include:
          • "SEARCH"
          • "TIMESERIES"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSecurityConfig(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateSecurityConfig operation

var params = {
  configVersion: 'STRING_VALUE', /* required */
  id: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  samlOptions: {
    metadata: 'STRING_VALUE', /* required */
    groupAttribute: 'STRING_VALUE',
    sessionTimeout: 'NUMBER_VALUE',
    userAttribute: 'STRING_VALUE'
  }
};
opensearchserverless.updateSecurityConfig(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • configVersion — (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.

    • id — (String)

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

    • samlOptions — (map)

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

      • groupAttribute — (String)

        The group attribute for this SAML integration.

      • metadatarequired — (String)

        The XML IdP metadata file generated from your identity provider.

      • sessionTimeout — (Integer)

        The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.

      • userAttribute — (String)

        A user attribute for this SAML integration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • securityConfigDetail — (map)

        Details about the updated security configuration.

        • configVersion — (String)

          The version of the security configuration.

        • createdDate — (Integer)

          The date the configuration was created.

        • description — (String)

          The description of the security configuration.

        • id — (String)

          The unique identifier of the security configuration.

        • lastModifiedDate — (Integer)

          The timestamp of when the configuration was last modified.

        • samlOptions — (map)

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

          • groupAttribute — (String)

            The group attribute for this SAML integration.

          • metadatarequired — (String)

            The XML IdP metadata file generated from your identity provider.

          • sessionTimeout — (Integer)

            The session timeout, in minutes. Minimum is 15 minutes and maximum is 1440 minutes (24 hours or 1 day). Default is 60 minutes.

          • userAttribute — (String)

            A user attribute for this SAML integration.

        • type — (String)

          The type of security configuration.

          Possible values include:
          • "saml"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateSecurityPolicy(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateSecurityPolicy operation

var params = {
  name: 'STRING_VALUE', /* required */
  policyVersion: 'STRING_VALUE', /* required */
  type: encryption | network, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  policy: 'STRING_VALUE'
};
opensearchserverless.updateSecurityPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • description — (String)

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

    • name — (String)

      The name of the policy.

    • policy — (String)

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

    • policyVersion — (String)

      The version of the policy being updated.

    • type — (String)

      The type of access policy.

      Possible values include:
      • "encryption"
      • "network"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • securityPolicyDetail — (map)

        Details about the updated security policy.

        • createdDate — (Integer)

          The date the policy was created.

        • description — (String)

          The description of the security policy.

        • lastModifiedDate — (Integer)

          The timestamp of when the policy was last modified.

        • name — (String)

          The name of the policy.

        • policy — (map)

          The JSON policy document without any whitespaces.

        • policyVersion — (String)

          The version of the policy.

        • type — (String)

          The type of security policy.

          Possible values include:
          • "encryption"
          • "network"

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateVpcEndpoint(params = {}, callback) ⇒ AWS.Request

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

Service Reference:

Examples:

Calling the updateVpcEndpoint operation

var params = {
  id: 'STRING_VALUE', /* required */
  addSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  addSubnetIds: [
    'STRING_VALUE',
    /* more items */
  ],
  clientToken: 'STRING_VALUE',
  removeSecurityGroupIds: [
    'STRING_VALUE',
    /* more items */
  ],
  removeSubnetIds: [
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.updateVpcEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • addSecurityGroupIds — (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.

    • addSubnetIds — (Array<String>)

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

    • clientToken — (String)

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

      If a token is not provided, the SDK will use a version 4 UUID.
    • id — (String)

      The unique identifier of the interface endpoint to update.

    • removeSecurityGroupIds — (Array<String>)

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

    • removeSubnetIds — (Array<String>)

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

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • UpdateVpcEndpointDetail — (map)

        Details about the updated VPC endpoint.

        • id — (String)

          The unique identifier of the endpoint.

        • lastModifiedDate — (Integer)

          The timestamp of when the endpoint was last modified.

        • name — (String)

          The name of the endpoint.

        • securityGroupIds — (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.

        • status — (String)

          The current status of the endpoint update process.

          Possible values include:
          • "PENDING"
          • "DELETING"
          • "ACTIVE"
          • "FAILED"
        • subnetIds — (Array<String>)

          The ID of the subnets from which you access OpenSearch Serverless.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.