Class: AWS.OpenSearchServerless

var params = {
  resourceIdentifiers: [ /* required */
    {
      resource: 'STRING_VALUE', /* required */
      type: retention /* required */
    },
    /* more items */
  ]
};
opensearchserverless.batchGetEffectiveLifecyclePolicy(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: {}) —
  • resourceIdentifiers — (Array<map>)

    The unique identifiers of policy types and resource names.

    • resource — required — (String)

      The name of the OpenSearch Serverless ilndex resource.

    • type — required — (String)

      The type of lifecycle policy.

      Possible values include:
      • "retention"

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:

    • effectiveLifecyclePolicyDetails — (Array<map>)

      A list of lifecycle policies applied to the OpenSearch Serverless indexes.

      • noMinRetentionPeriod — (Boolean)

        The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

      • policyName — (String)

        The name of the lifecycle policy.

      • resource — (String)

        The name of the OpenSearch Serverless index resource.

      • resourceType — (String)

        The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

        Possible values include:
        • "index"
      • retentionPeriod — (String)

        The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

      • type — (String)

        The type of lifecycle policy.

        Possible values include:
        • "retention"
    • effectiveLifecyclePolicyErrorDetails — (Array<map>)

      A list of resources for which retrieval failed.

      • errorCode — (String)

        The error code for the request.

      • errorMessage — (String)

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

      • resource — (String)

        The name of OpenSearch Serverless index resource.

      • type — (String)

        The type of lifecycle policy.

        Possible values include:
        • "retention"

Returns:

• (AWS.Request) —

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

var params = {
  identifiers: [ /* required */
    {
      name: 'STRING_VALUE', /* required */
      type: retention /* required */
    },
    /* more items */
  ]
};
opensearchserverless.batchGetLifecyclePolicy(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: {}) —
  • identifiers — (Array<map>)

    The unique identifiers of policy types and policy names.

    • name — required — (String)

      The name of the lifecycle policy.

    • type — required — (String)

      The type of lifecycle policy.

      Possible values include:
      • "retention"

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:

    • lifecyclePolicyDetails — (Array<map>)

      A list of lifecycle policies matched to the input policy name and policy type.

      • createdDate — (Integer)

        The date the lifecycle policy was created.

      • description — (String)

        The description of the lifecycle policy.

      • lastModifiedDate — (Integer)

        The timestamp of when the lifecycle policy was last modified.

      • name — (String)

        The name of the lifecycle policy.

      • policy — (map)

        The JSON policy document without any whitespaces.

      • policyVersion — (String)

        The version of the lifecycle policy.

      • type — (String)

        The type of lifecycle policy.

        Possible values include:
        • "retention"
    • lifecyclePolicyErrorDetails — (Array<map>)

      A list of lifecycle policy names and policy types for which retrieval failed.

      • errorCode — (String)

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

      • errorMessage — (String)

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

      • name — (String)

        The name of the lifecycle policy.

      • type — (String)

        The type of lifecycle policy.

        Possible values include:
        • "retention"

Returns:

• (AWS.Request) —

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

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.

      • failureCode — (String)

        A failure code associated with the request.

      • failureMessage — (String)

        A message associated with the failure code.

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

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.

var params = {
  name: 'STRING_VALUE', /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  standbyReplicas: ENABLED | DISABLED,
  tags: [
    {
      key: 'STRING_VALUE', /* required */
      value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  type: SEARCH | TIMESERIES | VECTORSEARCH
};
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.

  • standbyReplicas — (String)

    Indicates whether standby replicas should be used for a collection.

    Possible values include:
    • "ENABLED"
    • "DISABLED"
  • tags — (Array<map>)

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

    • key — required — (String)

      The key to use in the tag.

    • value — required — (String)

      The value of the tag.

  • type — (String)

    The type of collection.

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

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.

      • standbyReplicas — (String)

        Creates details about an OpenSearch Serverless collection.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • 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"
        • "VECTORSEARCH"

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  policy: 'STRING_VALUE', /* required */
  type: retention, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE'
};
opensearchserverless.createLifecyclePolicy(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.
  • description — (String)

    A description of the lifecycle policy.

  • name — (String)

    The name of the lifecycle policy.

  • policy — (String)

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

  • type — (String)

    The type of lifecycle policy.

    Possible values include:
    • "retention"

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:

    • lifecyclePolicyDetail — (map)

      Details about the created lifecycle policy.

      • createdDate — (Integer)

        The date the lifecycle policy was created.

      • description — (String)

        The description of the lifecycle policy.

      • lastModifiedDate — (Integer)

        The timestamp of when the lifecycle policy was last modified.

      • name — (String)

        The name of the lifecycle policy.

      • policy — (map)

        The JSON policy document without any whitespaces.

      • policyVersion — (String)

        The version of the lifecycle policy.

      • type — (String)

        The type of lifecycle policy.

        Possible values include:
        • "retention"

Returns:

• (AWS.Request) —

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

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. This field is required if you specify saml for the type parameter.

    • groupAttribute — (String)

      The group attribute for this SAML integration.

    • metadata — required — (String)

      The XML IdP metadata file generated from your identity provider.

    • sessionTimeout — (Integer)

      The session timeout, in minutes. Default is 60 minutes (12 hours).

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

        • metadata — required — (String)

          The XML IdP metadata file generated from your identity provider.

        • sessionTimeout — (Integer)

          The session timeout, in minutes. Default is 60 minutes (12 hours).

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

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.

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.

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.

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.

var params = {
  name: 'STRING_VALUE', /* required */
  type: retention, /* required */
  clientToken: 'STRING_VALUE'
};
opensearchserverless.deleteLifecyclePolicy(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 lifecycle policy.

    Possible values include:
    • "retention"

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.

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.

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.

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.

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.

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 Managing capacity limits for Amazon OpenSearch Serverless.

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

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.

    • LifecyclePolicyStats — (map)

      Information about the lifecycle policies in your account.

      • RetentionPolicyCount — (Integer)

        The number of retention lifecycle 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.

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.

        • metadata — required — (String)

          The XML IdP metadata file generated from your identity provider.

        • sessionTimeout — (Integer)

          The session timeout, in minutes. Default is 60 minutes (12 hours).

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

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.

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 collections 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.

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)

    A 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.

var params = {
  type: retention, /* required */
  maxResults: 'NUMBER_VALUE',
  nextToken: 'STRING_VALUE',
  resources: [
    'STRING_VALUE',
    /* more items */
  ]
};
opensearchserverless.listLifecyclePolicies(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 use nextToken to get the next page of results. The default is 10.

  • nextToken — (String)

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

  • resources — (Array<String>)

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

  • type — (String)

    The type of lifecycle policy.

    Possible values include:
    • "retention"

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:

    • lifecyclePolicySummaries — (Array<map>)

      Details about the requested lifecycle policies.

      • createdDate — (Integer)

        The Epoch time when the lifecycle policy was created.

      • description — (String)

        The description of the lifecycle policy.

      • lastModifiedDate — (Integer)

        The date and time when the lifecycle policy was last modified.

      • name — (String)

        The name of the lifecycle policy.

      • policyVersion — (String)

        The version of the lifecycle policy.

      • type — (String)

        The type of lifecycle policy.

        Possible values include:
        • "retention"
    • 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.

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.

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.

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.

      • key — required — (String)

        The key to use in the tag.

      • value — required — (String)

        The value of the tag.

Returns:

• (AWS.Request) —

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

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.

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.

    • key — required — (String)

      The key to use in the tag.

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

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.

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.

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 Managing capacity limits for Amazon OpenSearch Serverless.

    • 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 Managing capacity limits for Amazon OpenSearch Serverless.

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

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"
        • "VECTORSEARCH"

Returns:

• (AWS.Request) —

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

var params = {
  name: 'STRING_VALUE', /* required */
  policyVersion: 'STRING_VALUE', /* required */
  type: retention, /* required */
  clientToken: 'STRING_VALUE',
  description: 'STRING_VALUE',
  policy: 'STRING_VALUE'
};
opensearchserverless.updateLifecyclePolicy(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.
  • description — (String)

    A description of the lifecycle policy.

  • name — (String)

    The name of the policy.

  • policy — (String)

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

  • policyVersion — (String)

    The version of the policy being updated.

  • type — (String)

    The type of lifecycle policy.

    Possible values include:
    • "retention"

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:

    • lifecyclePolicyDetail — (map)

      Details about the updated lifecycle policy.

      • createdDate — (Integer)

        The date the lifecycle policy was created.

      • description — (String)

        The description of the lifecycle policy.

      • lastModifiedDate — (Integer)

        The timestamp of when the lifecycle policy was last modified.

      • name — (String)

        The name of the lifecycle policy.

      • policy — (map)

        The JSON policy document without any whitespaces.

      • policyVersion — (String)

        The version of the lifecycle policy.

      • type — (String)

        The type of lifecycle policy.

        Possible values include:
        • "retention"

Returns:

• (AWS.Request) —

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

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.

    • metadata — required — (String)

      The XML IdP metadata file generated from your identity provider.

    • sessionTimeout — (Integer)

      The session timeout, in minutes. Default is 60 minutes (12 hours).

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

        • metadata — required — (String)

          The XML IdP metadata file generated from your identity provider.

        • sessionTimeout — (Integer)

          The session timeout, in minutes. Default is 60 minutes (12 hours).

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

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.

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.