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.