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

Class: AWS.OpenSearch

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

Overview

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

Service Description

Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains.

For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide . The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.

Sending a Request Using OpenSearch

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

Locking the API Version

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

var opensearch = new AWS.OpenSearch({apiVersion: '2021-01-01'});

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

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

var opensearch = new AWS.OpenSearch();

Version:

  • 2021-01-01

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a OpenSearch object

var opensearch = new AWS.OpenSearch({apiVersion: '2021-01-01'});

Options Hash (options):

  • params (map)

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

  • endpoint (String|AWS.Endpoint)

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

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

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

  • credentialProvider (AWS.CredentialProviderChain)

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

  • region (String)

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

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

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

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

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

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

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

  • convertResponseTypes (Boolean)

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

  • correctClockSkew (Boolean)

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

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

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

  • s3DisableBodySigning (Boolean)

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

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

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

  • s3UseArnRegion (Boolean)

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

  • retryDelayOptions (map)

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

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

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

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

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

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

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

  • logger (#write, #log)

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

  • systemClockOffset (Number)

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

  • signatureVersion (String)

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

  • signatureCache (Boolean)

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

  • dynamoDbCrc32 (Boolean)

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

  • useAccelerateEndpoint (Boolean)

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

  • clientSideMonitoring (Boolean)

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

  • endpointDiscoveryEnabled (Boolean|undefined)

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

  • endpointCacheSize (Number)

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

  • hostPrefixEnabled (Boolean)

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

  • stsRegionalEndpoints ('legacy'|'regional')

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

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

endpointAWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

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

Service Reference:

Examples:

Calling the acceptInboundConnection operation

var params = {
  ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.acceptInboundConnection(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: {})
    • ConnectionId — (String)

      The ID of the inbound connection to accept.

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:

      • Connection — (map)

        Information about the accepted inbound connection.

        • LocalDomainInfo — (map)

          Information about the source (local) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • RemoteDomainInfo — (map)

          Information about the destination (remote) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • ConnectionId — (String)

          The unique identifier of the connection.

        • ConnectionStatus — (map)

          The current status of the connection.

          • StatusCode — (String)

            The status code for the connection. Can be one of the following:

            • PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.

            • APPROVED: Inbound connection is pending acceptance by the remote domain owner.

            • PROVISIONING: Inbound connection is being provisioned.

            • ACTIVE: Inbound connection is active and ready to use.

            • REJECTING: Inbound connection rejection is in process.

            • REJECTED: Inbound connection is rejected.

            • DELETING: Inbound connection deletion is in progress.

            • DELETED: Inbound connection is deleted and can no longer be used.

            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Information about the connection.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the addTags operation

var params = {
  ARN: 'STRING_VALUE', /* required */
  TagList: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
opensearch.addTags(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: {})
    • ARN — (String)

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

    • TagList — (Array<map>)

      List of resource tags.

      • Keyrequired — (String)

        The tag key. Tag keys must be unique for the domain to which they are attached.

      • Valuerequired — (String)

        The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

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.

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

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Service Reference:

Examples:

Calling the associatePackage operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  PackageID: 'STRING_VALUE' /* required */
};
opensearch.associatePackage(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: {})
    • PackageID — (String)

      Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

    • DomainName — (String)

      Name of the domain to associate the package with.

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:

      • DomainPackageDetails — (map)

        Information about a package that is associated with a domain.

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • LastUpdated — (Date)

          Timestamp of the most recent update to the package association status.

        • DomainName — (String)

          Name of the domain that the package is associated with.

        • DomainPackageStatus — (String)

          State of the association.

          Possible values include:
          • "ASSOCIATING"
          • "ASSOCIATION_FAILED"
          • "ACTIVE"
          • "DISSOCIATING"
          • "DISSOCIATION_FAILED"
        • PackageVersion — (String)

          The current version of the package.

        • ReferencePath — (String)

          Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

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

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

Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Service Reference:

Examples:

Calling the authorizeVpcEndpointAccess operation

var params = {
  Account: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.authorizeVpcEndpointAccess(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: {})
    • DomainName — (String)

      The name of the OpenSearch Service domain to provide access to.

    • Account — (String)

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

      • AuthorizedPrincipal — (map)

        Information about the Amazon Web Services account or service that was provided access to the domain.

        • PrincipalType — (String)

          The type of principal.

          Possible values include:
          • "AWS_ACCOUNT"
          • "AWS_SERVICE"
        • Principal — (String)

          The IAM principal that is allowed access to the domain.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the cancelServiceSoftwareUpdate operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.cancelServiceSoftwareUpdate(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: {})
    • DomainName — (String)

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

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:

      • ServiceSoftwareOptions — (map)

        Container for the state of your domain relative to the latest service software.

        • CurrentVersion — (String)

          The current service software version present on the domain.

        • NewVersion — (String)

          The new service software version, if one is available.

        • UpdateAvailable — (Boolean)

          True if you're able to update your service software version. False if you can't update your service software version.

        • Cancellable — (Boolean)

          True if you're able to cancel your service software version update. False if you can't cancel your service software update.

        • UpdateStatus — (String)

          The status of your service software update.

          Possible values include:
          • "PENDING_UPDATE"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "NOT_ELIGIBLE"
          • "ELIGIBLE"
        • Description — (String)

          A description of the service software update status.

        • AutomatedUpdateDate — (Date)

          The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

        • OptionalDeployment — (Boolean)

          True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the createDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AccessPolicies: 'STRING_VALUE',
  AdvancedOptions: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  AdvancedSecurityOptions: {
    AnonymousAuthEnabled: true || false,
    Enabled: true || false,
    InternalUserDatabaseEnabled: true || false,
    MasterUserOptions: {
      MasterUserARN: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      MasterUserPassword: 'STRING_VALUE'
    },
    SAMLOptions: {
      Enabled: true || false,
      Idp: {
        EntityId: 'STRING_VALUE', /* required */
        MetadataContent: 'STRING_VALUE' /* required */
      },
      MasterBackendRole: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      RolesKey: 'STRING_VALUE',
      SessionTimeoutMinutes: 'NUMBER_VALUE',
      SubjectKey: 'STRING_VALUE'
    }
  },
  AutoTuneOptions: {
    DesiredState: ENABLED | DISABLED,
    MaintenanceSchedules: [
      {
        CronExpressionForRecurrence: 'STRING_VALUE',
        Duration: {
          Unit: HOURS,
          Value: 'NUMBER_VALUE'
        },
        StartAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ]
  },
  ClusterConfig: {
    ColdStorageOptions: {
      Enabled: true || false /* required */
    },
    DedicatedMasterCount: 'NUMBER_VALUE',
    DedicatedMasterEnabled: true || false,
    DedicatedMasterType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
    InstanceCount: 'NUMBER_VALUE',
    InstanceType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
    WarmCount: 'NUMBER_VALUE',
    WarmEnabled: true || false,
    WarmType: ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search,
    ZoneAwarenessConfig: {
      AvailabilityZoneCount: 'NUMBER_VALUE'
    },
    ZoneAwarenessEnabled: true || false
  },
  CognitoOptions: {
    Enabled: true || false,
    IdentityPoolId: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE',
    UserPoolId: 'STRING_VALUE'
  },
  DomainEndpointOptions: {
    CustomEndpoint: 'STRING_VALUE',
    CustomEndpointCertificateArn: 'STRING_VALUE',
    CustomEndpointEnabled: true || false,
    EnforceHTTPS: true || false,
    TLSSecurityPolicy: Policy-Min-TLS-1-0-2019-07 | Policy-Min-TLS-1-2-2019-07
  },
  EBSOptions: {
    EBSEnabled: true || false,
    Iops: 'NUMBER_VALUE',
    Throughput: 'NUMBER_VALUE',
    VolumeSize: 'NUMBER_VALUE',
    VolumeType: standard | gp2 | io1 | gp3
  },
  EncryptionAtRestOptions: {
    Enabled: true || false,
    KmsKeyId: 'STRING_VALUE'
  },
  EngineVersion: 'STRING_VALUE',
  LogPublishingOptions: {
    '<LogType>': {
      CloudWatchLogsLogGroupArn: 'STRING_VALUE',
      Enabled: true || false
    },
    /* '<LogType>': ... */
  },
  NodeToNodeEncryptionOptions: {
    Enabled: true || false
  },
  SnapshotOptions: {
    AutomatedSnapshotStartHour: 'NUMBER_VALUE'
  },
  TagList: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  VPCOptions: {
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
opensearch.createDomain(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: {})
    • DomainName — (String)

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

    • EngineVersion — (String)

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

    • ClusterConfig — (map)

      Container for the cluster configuration of a domain.

      • InstanceType — (String)

        Instance type of data nodes in the cluster.

        Possible values include:
        • "m3.medium.search"
        • "m3.large.search"
        • "m3.xlarge.search"
        • "m3.2xlarge.search"
        • "m4.large.search"
        • "m4.xlarge.search"
        • "m4.2xlarge.search"
        • "m4.4xlarge.search"
        • "m4.10xlarge.search"
        • "m5.large.search"
        • "m5.xlarge.search"
        • "m5.2xlarge.search"
        • "m5.4xlarge.search"
        • "m5.12xlarge.search"
        • "m5.24xlarge.search"
        • "r5.large.search"
        • "r5.xlarge.search"
        • "r5.2xlarge.search"
        • "r5.4xlarge.search"
        • "r5.12xlarge.search"
        • "r5.24xlarge.search"
        • "c5.large.search"
        • "c5.xlarge.search"
        • "c5.2xlarge.search"
        • "c5.4xlarge.search"
        • "c5.9xlarge.search"
        • "c5.18xlarge.search"
        • "t3.nano.search"
        • "t3.micro.search"
        • "t3.small.search"
        • "t3.medium.search"
        • "t3.large.search"
        • "t3.xlarge.search"
        • "t3.2xlarge.search"
        • "ultrawarm1.medium.search"
        • "ultrawarm1.large.search"
        • "ultrawarm1.xlarge.search"
        • "t2.micro.search"
        • "t2.small.search"
        • "t2.medium.search"
        • "r3.large.search"
        • "r3.xlarge.search"
        • "r3.2xlarge.search"
        • "r3.4xlarge.search"
        • "r3.8xlarge.search"
        • "i2.xlarge.search"
        • "i2.2xlarge.search"
        • "d2.xlarge.search"
        • "d2.2xlarge.search"
        • "d2.4xlarge.search"
        • "d2.8xlarge.search"
        • "c4.large.search"
        • "c4.xlarge.search"
        • "c4.2xlarge.search"
        • "c4.4xlarge.search"
        • "c4.8xlarge.search"
        • "r4.large.search"
        • "r4.xlarge.search"
        • "r4.2xlarge.search"
        • "r4.4xlarge.search"
        • "r4.8xlarge.search"
        • "r4.16xlarge.search"
        • "i3.large.search"
        • "i3.xlarge.search"
        • "i3.2xlarge.search"
        • "i3.4xlarge.search"
        • "i3.8xlarge.search"
        • "i3.16xlarge.search"
        • "r6g.large.search"
        • "r6g.xlarge.search"
        • "r6g.2xlarge.search"
        • "r6g.4xlarge.search"
        • "r6g.8xlarge.search"
        • "r6g.12xlarge.search"
        • "m6g.large.search"
        • "m6g.xlarge.search"
        • "m6g.2xlarge.search"
        • "m6g.4xlarge.search"
        • "m6g.8xlarge.search"
        • "m6g.12xlarge.search"
        • "c6g.large.search"
        • "c6g.xlarge.search"
        • "c6g.2xlarge.search"
        • "c6g.4xlarge.search"
        • "c6g.8xlarge.search"
        • "c6g.12xlarge.search"
        • "r6gd.large.search"
        • "r6gd.xlarge.search"
        • "r6gd.2xlarge.search"
        • "r6gd.4xlarge.search"
        • "r6gd.8xlarge.search"
        • "r6gd.12xlarge.search"
        • "r6gd.16xlarge.search"
        • "t4g.small.search"
        • "t4g.medium.search"
      • InstanceCount — (Integer)

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • DedicatedMasterEnabled — (Boolean)

        Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

      • ZoneAwarenessEnabled — (Boolean)

        Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

      • ZoneAwarenessConfig — (map)

        Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

        • AvailabilityZoneCount — (Integer)

          If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

      • DedicatedMasterType — (String)

        OpenSearch Service instance type of the dedicated master nodes in the cluster.

        Possible values include:
        • "m3.medium.search"
        • "m3.large.search"
        • "m3.xlarge.search"
        • "m3.2xlarge.search"
        • "m4.large.search"
        • "m4.xlarge.search"
        • "m4.2xlarge.search"
        • "m4.4xlarge.search"
        • "m4.10xlarge.search"
        • "m5.large.search"
        • "m5.xlarge.search"
        • "m5.2xlarge.search"
        • "m5.4xlarge.search"
        • "m5.12xlarge.search"
        • "m5.24xlarge.search"
        • "r5.large.search"
        • "r5.xlarge.search"
        • "r5.2xlarge.search"
        • "r5.4xlarge.search"
        • "r5.12xlarge.search"
        • "r5.24xlarge.search"
        • "c5.large.search"
        • "c5.xlarge.search"
        • "c5.2xlarge.search"
        • "c5.4xlarge.search"
        • "c5.9xlarge.search"
        • "c5.18xlarge.search"
        • "t3.nano.search"
        • "t3.micro.search"
        • "t3.small.search"
        • "t3.medium.search"
        • "t3.large.search"
        • "t3.xlarge.search"
        • "t3.2xlarge.search"
        • "ultrawarm1.medium.search"
        • "ultrawarm1.large.search"
        • "ultrawarm1.xlarge.search"
        • "t2.micro.search"
        • "t2.small.search"
        • "t2.medium.search"
        • "r3.large.search"
        • "r3.xlarge.search"
        • "r3.2xlarge.search"
        • "r3.4xlarge.search"
        • "r3.8xlarge.search"
        • "i2.xlarge.search"
        • "i2.2xlarge.search"
        • "d2.xlarge.search"
        • "d2.2xlarge.search"
        • "d2.4xlarge.search"
        • "d2.8xlarge.search"
        • "c4.large.search"
        • "c4.xlarge.search"
        • "c4.2xlarge.search"
        • "c4.4xlarge.search"
        • "c4.8xlarge.search"
        • "r4.large.search"
        • "r4.xlarge.search"
        • "r4.2xlarge.search"
        • "r4.4xlarge.search"
        • "r4.8xlarge.search"
        • "r4.16xlarge.search"
        • "i3.large.search"
        • "i3.xlarge.search"
        • "i3.2xlarge.search"
        • "i3.4xlarge.search"
        • "i3.8xlarge.search"
        • "i3.16xlarge.search"
        • "r6g.large.search"
        • "r6g.xlarge.search"
        • "r6g.2xlarge.search"
        • "r6g.4xlarge.search"
        • "r6g.8xlarge.search"
        • "r6g.12xlarge.search"
        • "m6g.large.search"
        • "m6g.xlarge.search"
        • "m6g.2xlarge.search"
        • "m6g.4xlarge.search"
        • "m6g.8xlarge.search"
        • "m6g.12xlarge.search"
        • "c6g.large.search"
        • "c6g.xlarge.search"
        • "c6g.2xlarge.search"
        • "c6g.4xlarge.search"
        • "c6g.8xlarge.search"
        • "c6g.12xlarge.search"
        • "r6gd.large.search"
        • "r6gd.xlarge.search"
        • "r6gd.2xlarge.search"
        • "r6gd.4xlarge.search"
        • "r6gd.8xlarge.search"
        • "r6gd.12xlarge.search"
        • "r6gd.16xlarge.search"
        • "t4g.small.search"
        • "t4g.medium.search"
      • DedicatedMasterCount — (Integer)

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • WarmEnabled — (Boolean)

        Whether to enable warm storage for the cluster.

      • WarmType — (String)

        The instance type for the cluster's warm nodes.

        Possible values include:
        • "ultrawarm1.medium.search"
        • "ultrawarm1.large.search"
        • "ultrawarm1.xlarge.search"
      • WarmCount — (Integer)

        The number of warm nodes in the cluster.

      • ColdStorageOptions — (map)

        Container for cold storage configuration options.

        • Enabledrequired — (Boolean)

          Whether to enable or disable cold storage on the domain.

    • EBSOptions — (map)

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

      • EBSEnabled — (Boolean)

        Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

      • VolumeType — (String)

        Specifies the type of EBS volumes attached to data nodes.

        Possible values include:
        • "standard"
        • "gp2"
        • "io1"
        • "gp3"
      • VolumeSize — (Integer)

        Specifies the size (in GiB) of EBS volumes attached to data nodes.

      • Iops — (Integer)

        Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

      • Throughput — (Integer)

        Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

    • AccessPolicies — (String)

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

    • SnapshotOptions — (map)

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

      • AutomatedSnapshotStartHour — (Integer)

        The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

    • VPCOptions — (map)

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

      • SubnetIds — (Array<String>)

        A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

      • SecurityGroupIds — (Array<String>)

        The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

    • CognitoOptions — (map)

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

      • Enabled — (Boolean)

        Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      • UserPoolId — (String)

        The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • IdentityPoolId — (String)

        The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • RoleArn — (String)

        The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

    • EncryptionAtRestOptions — (map)

      Key-value pairs to enable encryption at rest.

      • Enabled — (Boolean)

        True to enable encryption at rest.

      • KmsKeyId — (String)

        The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

    • NodeToNodeEncryptionOptions — (map)

      Enables node-to-node encryption.

      • Enabled — (Boolean)

        True to enable node-to-node encryption.

    • AdvancedOptions — (map<String>)

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

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

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

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

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

      For more information, see Advanced cluster parameters.

    • LogPublishingOptions — (map<map>)

      Key-value pairs to configure slow log publishing.

      • CloudWatchLogsLogGroupArn — (String)

        The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

      • Enabled — (Boolean)

        Whether the log should be published.

    • DomainEndpointOptions — (map)

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

      • EnforceHTTPS — (Boolean)

        True to require that all traffic to the domain arrive over HTTPS.

      • TLSSecurityPolicy — (String)

        Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

        Can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

        Possible values include:
        • "Policy-Min-TLS-1-0-2019-07"
        • "Policy-Min-TLS-1-2-2019-07"
      • CustomEndpointEnabled — (Boolean)

        Whether to enable a custom endpoint for the domain.

      • CustomEndpoint — (String)

        The fully qualified URL for the custom endpoint.

      • CustomEndpointCertificateArn — (String)

        The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

    • AdvancedSecurityOptions — (map)

      Options for fine-grained access control.

      • Enabled — (Boolean)

        True to enable fine-grained access control.

      • InternalUserDatabaseEnabled — (Boolean)

        True to enable the internal user database.

      • MasterUserOptions — (map)

        Container for information about the master user.

        • MasterUserARN — (String)

          Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

        • MasterUserName — (String)

          User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

        • MasterUserPassword — (String)

          Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

      • SAMLOptions — (map)

        Container for information about the SAML configuration for OpenSearch Dashboards.

        • Enabled — (Boolean)

          True to enable SAML authentication for a domain.

        • Idp — (map)

          The SAML Identity Provider's information.

          • MetadataContentrequired — (String)

            The metadata of the SAML application, in XML format.

          • EntityIdrequired — (String)

            The unique entity ID of the application in the SAML identity provider.

        • MasterUserName — (String)

          The SAML master user name, which is stored in the domain's internal user database.

        • MasterBackendRole — (String)

          The backend role that the SAML master user is mapped to.

        • SubjectKey — (String)

          Element of the SAML assertion to use for the user name. Default is NameID.

        • RolesKey — (String)

          Element of the SAML assertion to use for backend roles. Default is roles.

        • SessionTimeoutMinutes — (Integer)

          The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

      • AnonymousAuthEnabled — (Boolean)

        True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

    • TagList — (Array<map>)

      List of tags to add to the domain upon creation.

      • Keyrequired — (String)

        The tag key. Tag keys must be unique for the domain to which they are attached.

      • Valuerequired — (String)

        The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

    • AutoTuneOptions — (map)

      Options for Auto-Tune.

      • DesiredState — (String)

        Whether Auto-Tune is enabled or disabled.

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

        A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance schedules are overwrite, not append. If your request includes no schedules, the request deletes all existing schedules. To preserve existing schedules, make a call to DescribeDomainConfig first and use the MaintenanceSchedules portion of the response as the basis for this section.

        • StartAt — (Date)

          The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

        • Duration — (map)

          The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

          • Value — (Integer)

            Integer to specify the value of a maintenance schedule duration.

          • Unit — (String)

            The unit of measurement for the duration of a maintenance schedule.

            Possible values include:
            • "HOURS"
        • CronExpressionForRecurrence — (String)

          A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

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:

      • DomainStatus — (map)

        The status of the newly created domain.

        • DomainIdrequired — (String)

          Unique identifier for the domain.

        • DomainNamerequired — (String)

          Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

        • Created — (Boolean)

          Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

        • Endpoints — (map<String>)

          The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

          The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

        • EngineVersion — (String)

          Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

        • ClusterConfigrequired — (map)

          Container for the cluster configuration of the domain.

          • InstanceType — (String)

            Instance type of data nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • InstanceCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • DedicatedMasterEnabled — (Boolean)

            Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

          • ZoneAwarenessEnabled — (Boolean)

            Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

          • ZoneAwarenessConfig — (map)

            Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

            • AvailabilityZoneCount — (Integer)

              If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

          • DedicatedMasterType — (String)

            OpenSearch Service instance type of the dedicated master nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • DedicatedMasterCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • WarmEnabled — (Boolean)

            Whether to enable warm storage for the cluster.

          • WarmType — (String)

            The instance type for the cluster's warm nodes.

            Possible values include:
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
          • WarmCount — (Integer)

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Container for cold storage configuration options.

            • Enabledrequired — (Boolean)

              Whether to enable or disable cold storage on the domain.

        • EBSOptions — (map)

          Container for EBS-based storage settings for the domain.

          • EBSEnabled — (Boolean)

            Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

          • VolumeType — (String)

            Specifies the type of EBS volumes attached to data nodes.

            Possible values include:
            • "standard"
            • "gp2"
            • "io1"
            • "gp3"
          • VolumeSize — (Integer)

            Specifies the size (in GiB) of EBS volumes attached to data nodes.

          • Iops — (Integer)

            Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

          • Throughput — (Integer)

            Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

        • AccessPolicies — (String)

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

        • SnapshotOptions — (map)

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

          • AutomatedSnapshotStartHour — (Integer)

            The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

        • VPCOptions — (map)

          The VPC configuration for the domain.

          • VPCId — (String)

            The ID for your VPC. Amazon VPC generates this value when you create a VPC.

          • SubnetIds — (Array<String>)

            A list of subnet IDs associated with the VPC endpoints for the domain.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones associated with the VPC subnets.

          • SecurityGroupIds — (Array<String>)

            The list of security group IDs associated with the VPC endpoints for the domain.

        • CognitoOptions — (map)

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

          • Enabled — (Boolean)

            Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

          • UserPoolId — (String)

            The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

        • EncryptionAtRestOptions — (map)

          Encryption at rest settings for the domain.

          • Enabled — (Boolean)

            True to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

        • NodeToNodeEncryptionOptions — (map)

          Whether node-to-node encryption is enabled or disabled.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Key-value pairs that specify advanced configuration options.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the domain.

          • CloudWatchLogsLogGroupArn — (String)

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled — (Boolean)

            Whether the log should be published.

        • ServiceSoftwareOptions — (map)

          The current status of the domain's service software.

          • CurrentVersion — (String)

            The current service software version present on the domain.

          • NewVersion — (String)

            The new service software version, if one is available.

          • UpdateAvailable — (Boolean)

            True if you're able to update your service software version. False if you can't update your service software version.

          • Cancellable — (Boolean)

            True if you're able to cancel your service software version update. False if you can't cancel your service software update.

          • UpdateStatus — (String)

            The status of your service software update.

            Possible values include:
            • "PENDING_UPDATE"
            • "IN_PROGRESS"
            • "COMPLETED"
            • "NOT_ELIGIBLE"
            • "ELIGIBLE"
          • Description — (String)

            A description of the service software update status.

          • AutomatedUpdateDate — (Date)

            The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

          • OptionalDeployment — (Boolean)

            True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

        • DomainEndpointOptions — (map)

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

          • EnforceHTTPS — (Boolean)

            True to require that all traffic to the domain arrive over HTTPS.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

            Can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

            Possible values include:
            • "Policy-Min-TLS-1-0-2019-07"
            • "Policy-Min-TLS-1-2-2019-07"
          • CustomEndpointEnabled — (Boolean)

            Whether to enable a custom endpoint for the domain.

          • CustomEndpoint — (String)

            The fully qualified URL for the custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

        • AdvancedSecurityOptions — (map)

          Settings for fine-grained access control.

          • Enabled — (Boolean)

            True if fine-grained access control is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Container for information about the SAML configuration for OpenSearch Dashboards.

            • Enabled — (Boolean)

              True if SAML is enabled.

            • Idp — (map)

              Describes the SAML identity provider's information.

              • MetadataContentrequired — (String)

                The metadata of the SAML application, in XML format.

              • EntityIdrequired — (String)

                The unique entity ID of the application in the SAML identity provider.

            • SubjectKey — (String)

              The key used for matching the SAML subject attribute.

            • RolesKey — (String)

              The key used for matching the SAML roles attribute.

            • SessionTimeoutMinutes — (Integer)

              The duration, in minutes, after which a user session becomes inactive.

          • AnonymousAuthDisableDate — (Date)

            Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

          • AnonymousAuthEnabled — (Boolean)

            True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

        • AutoTuneOptions — (map)

          Auto-Tune settings for the domain.

          • State — (String)

            The current state of Auto-Tune on the domain.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
            • "ENABLE_IN_PROGRESS"
            • "DISABLE_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_SCHEDULED"
            • "DISABLED_AND_ROLLBACK_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_COMPLETE"
            • "DISABLED_AND_ROLLBACK_ERROR"
            • "ERROR"
          • ErrorMessage — (String)

            Any errors that occurred while enabling or disabling Auto-Tune.

        • ChangeProgressDetails — (map)

          Information about a configuration change happening on the domain.

          • ChangeId — (String)

            The ID of the configuration change.

          • Message — (String)

            A message corresponding to the status of the configuration change.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the createOutboundConnection operation

var params = {
  ConnectionAlias: 'STRING_VALUE', /* required */
  LocalDomainInfo: { /* required */
    AWSDomainInformation: {
      DomainName: 'STRING_VALUE', /* required */
      OwnerId: 'STRING_VALUE',
      Region: 'STRING_VALUE'
    }
  },
  RemoteDomainInfo: { /* required */
    AWSDomainInformation: {
      DomainName: 'STRING_VALUE', /* required */
      OwnerId: 'STRING_VALUE',
      Region: 'STRING_VALUE'
    }
  }
};
opensearch.createOutboundConnection(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: {})
    • LocalDomainInfo — (map)

      Name and Region of the source (local) domain.

      • AWSDomainInformation — (map)

        Information about an Amazon OpenSearch Service domain.

        • OwnerId — (String)

          The Amazon Web Services account ID of the domain owner.

        • DomainNamerequired — (String)

          Name of the domain.

        • Region — (String)

          The Amazon Web Services Region in which the domain is located.

    • RemoteDomainInfo — (map)

      Name and Region of the destination (remote) domain.

      • AWSDomainInformation — (map)

        Information about an Amazon OpenSearch Service domain.

        • OwnerId — (String)

          The Amazon Web Services account ID of the domain owner.

        • DomainNamerequired — (String)

          Name of the domain.

        • Region — (String)

          The Amazon Web Services Region in which the domain is located.

    • ConnectionAlias — (String)

      Name of the connection.

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:

      • LocalDomainInfo — (map)

        Information about the source (local) domain.

        • AWSDomainInformation — (map)

          Information about an Amazon OpenSearch Service domain.

          • OwnerId — (String)

            The Amazon Web Services account ID of the domain owner.

          • DomainNamerequired — (String)

            Name of the domain.

          • Region — (String)

            The Amazon Web Services Region in which the domain is located.

      • RemoteDomainInfo — (map)

        Information about the destination (remote) domain.

        • AWSDomainInformation — (map)

          Information about an Amazon OpenSearch Service domain.

          • OwnerId — (String)

            The Amazon Web Services account ID of the domain owner.

          • DomainNamerequired — (String)

            Name of the domain.

          • Region — (String)

            The Amazon Web Services Region in which the domain is located.

      • ConnectionAlias — (String)

        Name of the connection.

      • ConnectionStatus — (map)

        The status of the connection.

        • StatusCode — (String)

          The status code for the outbound connection. Can be one of the following:

          • VALIDATING - The outbound connection request is being validated.

          • VALIDATION_FAILED - Validation failed for the connection request.

          • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.

          • APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.

          • PROVISIONING - Outbound connection request is in process.

          • ACTIVE - Outbound connection is active and ready to use.

          • REJECTING - Outbound connection rejection by remote domain owner is in progress.

          • REJECTED - Outbound connection request is rejected by remote domain owner.

          • DELETING - Outbound connection deletion is in progress.

          • DELETED - Outbound connection is deleted and can no longer be used.

          Possible values include:
          • "VALIDATING"
          • "VALIDATION_FAILED"
          • "PENDING_ACCEPTANCE"
          • "APPROVED"
          • "PROVISIONING"
          • "ACTIVE"
          • "REJECTING"
          • "REJECTED"
          • "DELETING"
          • "DELETED"
        • Message — (String)

          Verbose information for the outbound connection.

      • ConnectionId — (String)

        The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the createPackage operation

var params = {
  PackageName: 'STRING_VALUE', /* required */
  PackageSource: { /* required */
    S3BucketName: 'STRING_VALUE',
    S3Key: 'STRING_VALUE'
  },
  PackageType: TXT-DICTIONARY, /* required */
  PackageDescription: 'STRING_VALUE'
};
opensearch.createPackage(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: {})
    • PackageName — (String)

      Unique name for the package.

    • PackageType — (String)

      Type of package.

      Possible values include:
      • "TXT-DICTIONARY"
    • PackageDescription — (String)

      Description of the package.

    • PackageSource — (map)

      The Amazon S3 location from which to import the package.

      • S3BucketName — (String)

        The name of the Amazon S3 bucket containing the package.

      • S3Key — (String)

        Key (file name) of the package.

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:

      • PackageDetails — (map)

        Basic information about an OpenSearch Service package.

        • PackageID — (String)

          The unique identifier of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • PackageDescription — (String)

          User-specified description of the package.

        • PackageStatus — (String)

          Current status of the package.

          Possible values include:
          • "COPYING"
          • "COPY_FAILED"
          • "VALIDATING"
          • "VALIDATION_FAILED"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"
          • "DELETE_FAILED"
        • CreatedAt — (Date)

          The timestamp when the package was created.

        • LastUpdatedAt — (Date)

          Date and time when the package was last updated.

        • AvailablePackageVersion — (String)

          The package version.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

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

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

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Service Reference:

Examples:

Calling the createVpcEndpoint operation

var params = {
  DomainArn: 'STRING_VALUE', /* required */
  VpcOptions: { /* required */
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ClientToken: 'STRING_VALUE'
};
opensearch.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: {})
    • DomainArn — (String)

      The Amazon Resource Name (ARN) of the domain to grant access to.

    • VpcOptions — (map)

      Options to specify the subnets and security groups for the endpoint.

      • SubnetIds — (Array<String>)

        A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

      • SecurityGroupIds — (Array<String>)

        The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

    • ClientToken — (String)

      Unique, case-sensitive identifier to ensure idempotency of 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:

      • VpcEndpoint — (map)

        Information about the newly created VPC endpoint.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

          The Amazon Resource Name (ARN) of the domain associated with the endpoint.

        • VpcOptions — (map)

          Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

          • VPCId — (String)

            The ID for your VPC. Amazon VPC generates this value when you create a VPC.

          • SubnetIds — (Array<String>)

            A list of subnet IDs associated with the VPC endpoints for the domain.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones associated with the VPC subnets.

          • SecurityGroupIds — (Array<String>)

            The list of security group IDs associated with the VPC endpoints for the domain.

        • Status — (String)

          The current status of the endpoint.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "UPDATING"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETE_FAILED"
        • Endpoint — (String)

          The connection endpoint ID for connecting to the domain.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the deleteDomain operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.deleteDomain(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: {})
    • DomainName — (String)

      The name of the domain you want to permanently delete.

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:

      • DomainStatus — (map)

        The status of the domain being deleted.

        • DomainIdrequired — (String)

          Unique identifier for the domain.

        • DomainNamerequired — (String)

          Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

        • Created — (Boolean)

          Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

        • Endpoints — (map<String>)

          The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

          The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

        • EngineVersion — (String)

          Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

        • ClusterConfigrequired — (map)

          Container for the cluster configuration of the domain.

          • InstanceType — (String)

            Instance type of data nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • InstanceCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • DedicatedMasterEnabled — (Boolean)

            Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

          • ZoneAwarenessEnabled — (Boolean)

            Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

          • ZoneAwarenessConfig — (map)

            Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

            • AvailabilityZoneCount — (Integer)

              If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

          • DedicatedMasterType — (String)

            OpenSearch Service instance type of the dedicated master nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • DedicatedMasterCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • WarmEnabled — (Boolean)

            Whether to enable warm storage for the cluster.

          • WarmType — (String)

            The instance type for the cluster's warm nodes.

            Possible values include:
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
          • WarmCount — (Integer)

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Container for cold storage configuration options.

            • Enabledrequired — (Boolean)

              Whether to enable or disable cold storage on the domain.

        • EBSOptions — (map)

          Container for EBS-based storage settings for the domain.

          • EBSEnabled — (Boolean)

            Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

          • VolumeType — (String)

            Specifies the type of EBS volumes attached to data nodes.

            Possible values include:
            • "standard"
            • "gp2"
            • "io1"
            • "gp3"
          • VolumeSize — (Integer)

            Specifies the size (in GiB) of EBS volumes attached to data nodes.

          • Iops — (Integer)

            Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

          • Throughput — (Integer)

            Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

        • AccessPolicies — (String)

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

        • SnapshotOptions — (map)

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

          • AutomatedSnapshotStartHour — (Integer)

            The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

        • VPCOptions — (map)

          The VPC configuration for the domain.

          • VPCId — (String)

            The ID for your VPC. Amazon VPC generates this value when you create a VPC.

          • SubnetIds — (Array<String>)

            A list of subnet IDs associated with the VPC endpoints for the domain.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones associated with the VPC subnets.

          • SecurityGroupIds — (Array<String>)

            The list of security group IDs associated with the VPC endpoints for the domain.

        • CognitoOptions — (map)

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

          • Enabled — (Boolean)

            Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

          • UserPoolId — (String)

            The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

        • EncryptionAtRestOptions — (map)

          Encryption at rest settings for the domain.

          • Enabled — (Boolean)

            True to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

        • NodeToNodeEncryptionOptions — (map)

          Whether node-to-node encryption is enabled or disabled.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Key-value pairs that specify advanced configuration options.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the domain.

          • CloudWatchLogsLogGroupArn — (String)

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled — (Boolean)

            Whether the log should be published.

        • ServiceSoftwareOptions — (map)

          The current status of the domain's service software.

          • CurrentVersion — (String)

            The current service software version present on the domain.

          • NewVersion — (String)

            The new service software version, if one is available.

          • UpdateAvailable — (Boolean)

            True if you're able to update your service software version. False if you can't update your service software version.

          • Cancellable — (Boolean)

            True if you're able to cancel your service software version update. False if you can't cancel your service software update.

          • UpdateStatus — (String)

            The status of your service software update.

            Possible values include:
            • "PENDING_UPDATE"
            • "IN_PROGRESS"
            • "COMPLETED"
            • "NOT_ELIGIBLE"
            • "ELIGIBLE"
          • Description — (String)

            A description of the service software update status.

          • AutomatedUpdateDate — (Date)

            The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

          • OptionalDeployment — (Boolean)

            True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

        • DomainEndpointOptions — (map)

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

          • EnforceHTTPS — (Boolean)

            True to require that all traffic to the domain arrive over HTTPS.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

            Can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

            Possible values include:
            • "Policy-Min-TLS-1-0-2019-07"
            • "Policy-Min-TLS-1-2-2019-07"
          • CustomEndpointEnabled — (Boolean)

            Whether to enable a custom endpoint for the domain.

          • CustomEndpoint — (String)

            The fully qualified URL for the custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

        • AdvancedSecurityOptions — (map)

          Settings for fine-grained access control.

          • Enabled — (Boolean)

            True if fine-grained access control is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Container for information about the SAML configuration for OpenSearch Dashboards.

            • Enabled — (Boolean)

              True if SAML is enabled.

            • Idp — (map)

              Describes the SAML identity provider's information.

              • MetadataContentrequired — (String)

                The metadata of the SAML application, in XML format.

              • EntityIdrequired — (String)

                The unique entity ID of the application in the SAML identity provider.

            • SubjectKey — (String)

              The key used for matching the SAML subject attribute.

            • RolesKey — (String)

              The key used for matching the SAML roles attribute.

            • SessionTimeoutMinutes — (Integer)

              The duration, in minutes, after which a user session becomes inactive.

          • AnonymousAuthDisableDate — (Date)

            Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

          • AnonymousAuthEnabled — (Boolean)

            True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

        • AutoTuneOptions — (map)

          Auto-Tune settings for the domain.

          • State — (String)

            The current state of Auto-Tune on the domain.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
            • "ENABLE_IN_PROGRESS"
            • "DISABLE_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_SCHEDULED"
            • "DISABLED_AND_ROLLBACK_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_COMPLETE"
            • "DISABLED_AND_ROLLBACK_ERROR"
            • "ERROR"
          • ErrorMessage — (String)

            Any errors that occurred while enabling or disabling Auto-Tune.

        • ChangeProgressDetails — (map)

          Information about a configuration change happening on the domain.

          • ChangeId — (String)

            The ID of the configuration change.

          • Message — (String)

            A message corresponding to the status of the configuration change.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the deleteInboundConnection operation

var params = {
  ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.deleteInboundConnection(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: {})
    • ConnectionId — (String)

      The ID of the inbound connection to permanently delete.

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:

      • Connection — (map)

        The deleted inbound connection.

        • LocalDomainInfo — (map)

          Information about the source (local) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • RemoteDomainInfo — (map)

          Information about the destination (remote) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • ConnectionId — (String)

          The unique identifier of the connection.

        • ConnectionStatus — (map)

          The current status of the connection.

          • StatusCode — (String)

            The status code for the connection. Can be one of the following:

            • PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.

            • APPROVED: Inbound connection is pending acceptance by the remote domain owner.

            • PROVISIONING: Inbound connection is being provisioned.

            • ACTIVE: Inbound connection is active and ready to use.

            • REJECTING: Inbound connection rejection is in process.

            • REJECTED: Inbound connection is rejected.

            • DELETING: Inbound connection deletion is in progress.

            • DELETED: Inbound connection is deleted and can no longer be used.

            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Information about the connection.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the deleteOutboundConnection operation

var params = {
  ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.deleteOutboundConnection(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: {})
    • ConnectionId — (String)

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

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:

      • Connection — (map)

        The deleted inbound connection.

        • LocalDomainInfo — (map)

          Information about the source (local) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • RemoteDomainInfo — (map)

          Information about the destination (remote) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • ConnectionId — (String)

          Unique identifier of the connection.

        • ConnectionAlias — (String)

          Name of the connection.

        • ConnectionStatus — (map)

          Status of the connection.

          • StatusCode — (String)

            The status code for the outbound connection. Can be one of the following:

            • VALIDATING - The outbound connection request is being validated.

            • VALIDATION_FAILED - Validation failed for the connection request.

            • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.

            • APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.

            • PROVISIONING - Outbound connection request is in process.

            • ACTIVE - Outbound connection is active and ready to use.

            • REJECTING - Outbound connection rejection by remote domain owner is in progress.

            • REJECTED - Outbound connection request is rejected by remote domain owner.

            • DELETING - Outbound connection deletion is in progress.

            • DELETED - Outbound connection is deleted and can no longer be used.

            Possible values include:
            • "VALIDATING"
            • "VALIDATION_FAILED"
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Verbose information for the outbound connection.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the deletePackage operation

var params = {
  PackageID: 'STRING_VALUE' /* required */
};
opensearch.deletePackage(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: {})
    • PackageID — (String)

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

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:

      • PackageDetails — (map)

        Information about the deleted package.

        • PackageID — (String)

          The unique identifier of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • PackageDescription — (String)

          User-specified description of the package.

        • PackageStatus — (String)

          Current status of the package.

          Possible values include:
          • "COPYING"
          • "COPY_FAILED"
          • "VALIDATING"
          • "VALIDATION_FAILED"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"
          • "DELETE_FAILED"
        • CreatedAt — (Date)

          The timestamp when the package was created.

        • LastUpdatedAt — (Date)

          Date and time when the package was last updated.

        • AvailablePackageVersion — (String)

          The package version.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

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

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

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Service Reference:

Examples:

Calling the deleteVpcEndpoint operation

var params = {
  VpcEndpointId: 'STRING_VALUE' /* required */
};
opensearch.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: {})
    • VpcEndpointId — (String)

      The unique identifier of 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:

      • VpcEndpointSummary — (map)

        Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

          The Amazon Resource Name (ARN) of the domain associated with the endpoint.

        • Status — (String)

          The current status of the endpoint.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "UPDATING"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETE_FAILED"

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the describeDomain operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.describeDomain(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: {})
    • DomainName — (String)

      The name of the domain that you want information about.

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:

      • DomainStatus — (map)

        List that contains the status of each specified OpenSearch Service domain.

        • DomainIdrequired — (String)

          Unique identifier for the domain.

        • DomainNamerequired — (String)

          Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

        • Created — (Boolean)

          Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

        • Endpoints — (map<String>)

          The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

          The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

        • EngineVersion — (String)

          Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

        • ClusterConfigrequired — (map)

          Container for the cluster configuration of the domain.

          • InstanceType — (String)

            Instance type of data nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • InstanceCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • DedicatedMasterEnabled — (Boolean)

            Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

          • ZoneAwarenessEnabled — (Boolean)

            Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

          • ZoneAwarenessConfig — (map)

            Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

            • AvailabilityZoneCount — (Integer)

              If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

          • DedicatedMasterType — (String)

            OpenSearch Service instance type of the dedicated master nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • DedicatedMasterCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • WarmEnabled — (Boolean)

            Whether to enable warm storage for the cluster.

          • WarmType — (String)

            The instance type for the cluster's warm nodes.

            Possible values include:
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
          • WarmCount — (Integer)

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Container for cold storage configuration options.

            • Enabledrequired — (Boolean)

              Whether to enable or disable cold storage on the domain.

        • EBSOptions — (map)

          Container for EBS-based storage settings for the domain.

          • EBSEnabled — (Boolean)

            Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

          • VolumeType — (String)

            Specifies the type of EBS volumes attached to data nodes.

            Possible values include:
            • "standard"
            • "gp2"
            • "io1"
            • "gp3"
          • VolumeSize — (Integer)

            Specifies the size (in GiB) of EBS volumes attached to data nodes.

          • Iops — (Integer)

            Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

          • Throughput — (Integer)

            Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

        • AccessPolicies — (String)

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

        • SnapshotOptions — (map)

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

          • AutomatedSnapshotStartHour — (Integer)

            The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

        • VPCOptions — (map)

          The VPC configuration for the domain.

          • VPCId — (String)

            The ID for your VPC. Amazon VPC generates this value when you create a VPC.

          • SubnetIds — (Array<String>)

            A list of subnet IDs associated with the VPC endpoints for the domain.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones associated with the VPC subnets.

          • SecurityGroupIds — (Array<String>)

            The list of security group IDs associated with the VPC endpoints for the domain.

        • CognitoOptions — (map)

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

          • Enabled — (Boolean)

            Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

          • UserPoolId — (String)

            The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

        • EncryptionAtRestOptions — (map)

          Encryption at rest settings for the domain.

          • Enabled — (Boolean)

            True to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

        • NodeToNodeEncryptionOptions — (map)

          Whether node-to-node encryption is enabled or disabled.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Key-value pairs that specify advanced configuration options.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the domain.

          • CloudWatchLogsLogGroupArn — (String)

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled — (Boolean)

            Whether the log should be published.

        • ServiceSoftwareOptions — (map)

          The current status of the domain's service software.

          • CurrentVersion — (String)

            The current service software version present on the domain.

          • NewVersion — (String)

            The new service software version, if one is available.

          • UpdateAvailable — (Boolean)

            True if you're able to update your service software version. False if you can't update your service software version.

          • Cancellable — (Boolean)

            True if you're able to cancel your service software version update. False if you can't cancel your service software update.

          • UpdateStatus — (String)

            The status of your service software update.

            Possible values include:
            • "PENDING_UPDATE"
            • "IN_PROGRESS"
            • "COMPLETED"
            • "NOT_ELIGIBLE"
            • "ELIGIBLE"
          • Description — (String)

            A description of the service software update status.

          • AutomatedUpdateDate — (Date)

            The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

          • OptionalDeployment — (Boolean)

            True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

        • DomainEndpointOptions — (map)

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

          • EnforceHTTPS — (Boolean)

            True to require that all traffic to the domain arrive over HTTPS.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

            Can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

            Possible values include:
            • "Policy-Min-TLS-1-0-2019-07"
            • "Policy-Min-TLS-1-2-2019-07"
          • CustomEndpointEnabled — (Boolean)

            Whether to enable a custom endpoint for the domain.

          • CustomEndpoint — (String)

            The fully qualified URL for the custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

        • AdvancedSecurityOptions — (map)

          Settings for fine-grained access control.

          • Enabled — (Boolean)

            True if fine-grained access control is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Container for information about the SAML configuration for OpenSearch Dashboards.

            • Enabled — (Boolean)

              True if SAML is enabled.

            • Idp — (map)

              Describes the SAML identity provider's information.

              • MetadataContentrequired — (String)

                The metadata of the SAML application, in XML format.

              • EntityIdrequired — (String)

                The unique entity ID of the application in the SAML identity provider.

            • SubjectKey — (String)

              The key used for matching the SAML subject attribute.

            • RolesKey — (String)

              The key used for matching the SAML roles attribute.

            • SessionTimeoutMinutes — (Integer)

              The duration, in minutes, after which a user session becomes inactive.

          • AnonymousAuthDisableDate — (Date)

            Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

          • AnonymousAuthEnabled — (Boolean)

            True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

        • AutoTuneOptions — (map)

          Auto-Tune settings for the domain.

          • State — (String)

            The current state of Auto-Tune on the domain.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
            • "ENABLE_IN_PROGRESS"
            • "DISABLE_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_SCHEDULED"
            • "DISABLED_AND_ROLLBACK_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_COMPLETE"
            • "DISABLED_AND_ROLLBACK_ERROR"
            • "ERROR"
          • ErrorMessage — (String)

            Any errors that occurred while enabling or disabling Auto-Tune.

        • ChangeProgressDetails — (map)

          Information about a configuration change happening on the domain.

          • ChangeId — (String)

            The ID of the configuration change.

          • Message — (String)

            A message corresponding to the status of the configuration change.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the describeDomainAutoTunes operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.describeDomainAutoTunes(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: {})
    • DomainName — (String)

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

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

    • NextToken — (String)

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

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:

      • AutoTunes — (Array<map>)

        The list of setting adjustments that Auto-Tune has made to the domain.

        • AutoTuneType — (String)

          The type of Auto-Tune action.

          Possible values include:
          • "SCHEDULED_ACTION"
        • AutoTuneDetails — (map)

          Details about an Auto-Tune action.

          • ScheduledAutoTuneDetails — (map)

            Container for details about a scheduled Auto-Tune action.

            • Date — (Date)

              The date and time when the Auto-Tune action is scheduled for the domain.

            • ActionType — (String)

              The type of Auto-Tune action.

              Possible values include:
              • "JVM_HEAP_SIZE_TUNING"
              • "JVM_YOUNG_GEN_TUNING"
            • Action — (String)

              A description of the Auto-Tune action.

            • Severity — (String)

              The severity of the Auto-Tune action. Valid values are LOW, MEDIUM, and HIGH.

              Possible values include:
              • "LOW"
              • "MEDIUM"
              • "HIGH"
      • 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.

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

Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.

Service Reference:

Examples:

Calling the describeDomainChangeProgress operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  ChangeId: 'STRING_VALUE'
};
opensearch.describeDomainChangeProgress(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: {})
    • DomainName — (String)

      The name of the domain to get progress information for.

    • ChangeId — (String)

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

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:

      • ChangeProgressStatus — (map)

        Container for information about the stages of a configuration change happening on a domain.

        • ChangeId — (String)

          The unique change identifier associated with a specific domain configuration change.

        • StartTime — (Date)

          The time at which the configuration change is made on the domain.

        • Status — (String)

          The overall status of the domain configuration change.

          Possible values include:
          • "PENDING"
          • "PROCESSING"
          • "COMPLETED"
          • "FAILED"
        • PendingProperties — (Array<String>)

          The list of properties in the domain configuration change that are still pending.

        • CompletedProperties — (Array<String>)

          The list of properties in the domain configuration change that have completed.

        • TotalNumberOfStages — (Integer)

          The total number of stages required for the configuration change.

        • ChangeProgressStages — (Array<map>)

          The specific stages that the domain is going through to perform the configuration change.

          • Name — (String)

            The name of the stage.

          • Status — (String)

            The status of the stage.

          • Description — (String)

            The description of the stage.

          • LastUpdated — (Date)

            The most recent updated timestamp of the stage.

Returns:

  • (AWS.Request)

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

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

Returns the configuration of an Amazon OpenSearch Service domain.

Service Reference:

Examples:

Calling the describeDomainConfig operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.describeDomainConfig(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: {})
    • DomainName — (String)

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

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:

      • DomainConfig — (map)

        Container for the configuration of the OpenSearch Service domain.

        • EngineVersion — (map)

          The OpenSearch or Elasticsearch version that the domain is running.

          • Optionsrequired — (String)

            The OpenSearch or Elasticsearch version for the specified domain.

          • Statusrequired — (map)

            The status of the version options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • ClusterConfig — (map)

          Container for the cluster configuration of a the domain.

          • Optionsrequired — (map)

            Cluster configuration options for the specified domain.

            • InstanceType — (String)

              Instance type of data nodes in the cluster.

              Possible values include:
              • "m3.medium.search"
              • "m3.large.search"
              • "m3.xlarge.search"
              • "m3.2xlarge.search"
              • "m4.large.search"
              • "m4.xlarge.search"
              • "m4.2xlarge.search"
              • "m4.4xlarge.search"
              • "m4.10xlarge.search"
              • "m5.large.search"
              • "m5.xlarge.search"
              • "m5.2xlarge.search"
              • "m5.4xlarge.search"
              • "m5.12xlarge.search"
              • "m5.24xlarge.search"
              • "r5.large.search"
              • "r5.xlarge.search"
              • "r5.2xlarge.search"
              • "r5.4xlarge.search"
              • "r5.12xlarge.search"
              • "r5.24xlarge.search"
              • "c5.large.search"
              • "c5.xlarge.search"
              • "c5.2xlarge.search"
              • "c5.4xlarge.search"
              • "c5.9xlarge.search"
              • "c5.18xlarge.search"
              • "t3.nano.search"
              • "t3.micro.search"
              • "t3.small.search"
              • "t3.medium.search"
              • "t3.large.search"
              • "t3.xlarge.search"
              • "t3.2xlarge.search"
              • "ultrawarm1.medium.search"
              • "ultrawarm1.large.search"
              • "ultrawarm1.xlarge.search"
              • "t2.micro.search"
              • "t2.small.search"
              • "t2.medium.search"
              • "r3.large.search"
              • "r3.xlarge.search"
              • "r3.2xlarge.search"
              • "r3.4xlarge.search"
              • "r3.8xlarge.search"
              • "i2.xlarge.search"
              • "i2.2xlarge.search"
              • "d2.xlarge.search"
              • "d2.2xlarge.search"
              • "d2.4xlarge.search"
              • "d2.8xlarge.search"
              • "c4.large.search"
              • "c4.xlarge.search"
              • "c4.2xlarge.search"
              • "c4.4xlarge.search"
              • "c4.8xlarge.search"
              • "r4.large.search"
              • "r4.xlarge.search"
              • "r4.2xlarge.search"
              • "r4.4xlarge.search"
              • "r4.8xlarge.search"
              • "r4.16xlarge.search"
              • "i3.large.search"
              • "i3.xlarge.search"
              • "i3.2xlarge.search"
              • "i3.4xlarge.search"
              • "i3.8xlarge.search"
              • "i3.16xlarge.search"
              • "r6g.large.search"
              • "r6g.xlarge.search"
              • "r6g.2xlarge.search"
              • "r6g.4xlarge.search"
              • "r6g.8xlarge.search"
              • "r6g.12xlarge.search"
              • "m6g.large.search"
              • "m6g.xlarge.search"
              • "m6g.2xlarge.search"
              • "m6g.4xlarge.search"
              • "m6g.8xlarge.search"
              • "m6g.12xlarge.search"
              • "c6g.large.search"
              • "c6g.xlarge.search"
              • "c6g.2xlarge.search"
              • "c6g.4xlarge.search"
              • "c6g.8xlarge.search"
              • "c6g.12xlarge.search"
              • "r6gd.large.search"
              • "r6gd.xlarge.search"
              • "r6gd.2xlarge.search"
              • "r6gd.4xlarge.search"
              • "r6gd.8xlarge.search"
              • "r6gd.12xlarge.search"
              • "r6gd.16xlarge.search"
              • "t4g.small.search"
              • "t4g.medium.search"
            • InstanceCount — (Integer)

              Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

            • DedicatedMasterEnabled — (Boolean)

              Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

            • ZoneAwarenessEnabled — (Boolean)

              Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

            • ZoneAwarenessConfig — (map)

              Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

              • AvailabilityZoneCount — (Integer)

                If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

            • DedicatedMasterType — (String)

              OpenSearch Service instance type of the dedicated master nodes in the cluster.

              Possible values include:
              • "m3.medium.search"
              • "m3.large.search"
              • "m3.xlarge.search"
              • "m3.2xlarge.search"
              • "m4.large.search"
              • "m4.xlarge.search"
              • "m4.2xlarge.search"
              • "m4.4xlarge.search"
              • "m4.10xlarge.search"
              • "m5.large.search"
              • "m5.xlarge.search"
              • "m5.2xlarge.search"
              • "m5.4xlarge.search"
              • "m5.12xlarge.search"
              • "m5.24xlarge.search"
              • "r5.large.search"
              • "r5.xlarge.search"
              • "r5.2xlarge.search"
              • "r5.4xlarge.search"
              • "r5.12xlarge.search"
              • "r5.24xlarge.search"
              • "c5.large.search"
              • "c5.xlarge.search"
              • "c5.2xlarge.search"
              • "c5.4xlarge.search"
              • "c5.9xlarge.search"
              • "c5.18xlarge.search"
              • "t3.nano.search"
              • "t3.micro.search"
              • "t3.small.search"
              • "t3.medium.search"
              • "t3.large.search"
              • "t3.xlarge.search"
              • "t3.2xlarge.search"
              • "ultrawarm1.medium.search"
              • "ultrawarm1.large.search"
              • "ultrawarm1.xlarge.search"
              • "t2.micro.search"
              • "t2.small.search"
              • "t2.medium.search"
              • "r3.large.search"
              • "r3.xlarge.search"
              • "r3.2xlarge.search"
              • "r3.4xlarge.search"
              • "r3.8xlarge.search"
              • "i2.xlarge.search"
              • "i2.2xlarge.search"
              • "d2.xlarge.search"
              • "d2.2xlarge.search"
              • "d2.4xlarge.search"
              • "d2.8xlarge.search"
              • "c4.large.search"
              • "c4.xlarge.search"
              • "c4.2xlarge.search"
              • "c4.4xlarge.search"
              • "c4.8xlarge.search"
              • "r4.large.search"
              • "r4.xlarge.search"
              • "r4.2xlarge.search"
              • "r4.4xlarge.search"
              • "r4.8xlarge.search"
              • "r4.16xlarge.search"
              • "i3.large.search"
              • "i3.xlarge.search"
              • "i3.2xlarge.search"
              • "i3.4xlarge.search"
              • "i3.8xlarge.search"
              • "i3.16xlarge.search"
              • "r6g.large.search"
              • "r6g.xlarge.search"
              • "r6g.2xlarge.search"
              • "r6g.4xlarge.search"
              • "r6g.8xlarge.search"
              • "r6g.12xlarge.search"
              • "m6g.large.search"
              • "m6g.xlarge.search"
              • "m6g.2xlarge.search"
              • "m6g.4xlarge.search"
              • "m6g.8xlarge.search"
              • "m6g.12xlarge.search"
              • "c6g.large.search"
              • "c6g.xlarge.search"
              • "c6g.2xlarge.search"
              • "c6g.4xlarge.search"
              • "c6g.8xlarge.search"
              • "c6g.12xlarge.search"
              • "r6gd.large.search"
              • "r6gd.xlarge.search"
              • "r6gd.2xlarge.search"
              • "r6gd.4xlarge.search"
              • "r6gd.8xlarge.search"
              • "r6gd.12xlarge.search"
              • "r6gd.16xlarge.search"
              • "t4g.small.search"
              • "t4g.medium.search"
            • DedicatedMasterCount — (Integer)

              Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

            • WarmEnabled — (Boolean)

              Whether to enable warm storage for the cluster.

            • WarmType — (String)

              The instance type for the cluster's warm nodes.

              Possible values include:
              • "ultrawarm1.medium.search"
              • "ultrawarm1.large.search"
              • "ultrawarm1.xlarge.search"
            • WarmCount — (Integer)

              The number of warm nodes in the cluster.

            • ColdStorageOptions — (map)

              Container for cold storage configuration options.

              • Enabledrequired — (Boolean)

                Whether to enable or disable cold storage on the domain.

          • Statusrequired — (map)

            The status of cluster configuration options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • EBSOptions — (map)

          Container for EBS options configured for an OpenSearch Service domain.

          • Optionsrequired — (map)

            The configured EBS options for the specified domain.

            • EBSEnabled — (Boolean)

              Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

            • VolumeType — (String)

              Specifies the type of EBS volumes attached to data nodes.

              Possible values include:
              • "standard"
              • "gp2"
              • "io1"
              • "gp3"
            • VolumeSize — (Integer)

              Specifies the size (in GiB) of EBS volumes attached to data nodes.

            • Iops — (Integer)

              Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

            • Throughput — (Integer)

              Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

          • Statusrequired — (map)

            The status of the EBS options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AccessPolicies — (map)

          Specifies the access policies for the domain.

          • Optionsrequired — (String)

            The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.

          • Statusrequired — (map)

            The status of the access policy for the domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • SnapshotOptions — (map)

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

          • Optionsrequired — (map)

            The daily snapshot options specified for the domain.

            • AutomatedSnapshotStartHour — (Integer)

              The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

          • Statusrequired — (map)

            The status of a daily automated snapshot.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • VPCOptions — (map)

          The current VPC options for the domain and the status of any updates to their configuration.

          • Optionsrequired — (map)

            The VPC options for the specified domain.

            • VPCId — (String)

              The ID for your VPC. Amazon VPC generates this value when you create a VPC.

            • SubnetIds — (Array<String>)

              A list of subnet IDs associated with the VPC endpoints for the domain.

            • AvailabilityZones — (Array<String>)

              The list of Availability Zones associated with the VPC subnets.

            • SecurityGroupIds — (Array<String>)

              The list of security group IDs associated with the VPC endpoints for the domain.

          • Statusrequired — (map)

            The status of the VPC options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • CognitoOptions — (map)

          Container for Amazon Cognito options for the domain.

          • Optionsrequired — (map)

            Cognito options for the specified domain.

            • Enabled — (Boolean)

              Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

            • UserPoolId — (String)

              The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

            • IdentityPoolId — (String)

              The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

            • RoleArn — (String)

              The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

          • Statusrequired — (map)

            The status of the Cognito options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • EncryptionAtRestOptions — (map)

          Key-value pairs to enable encryption at rest.

          • Optionsrequired — (map)

            Encryption at rest options for the specified domain.

            • Enabled — (Boolean)

              True to enable encryption at rest.

            • KmsKeyId — (String)

              The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

          • Statusrequired — (map)

            The status of the encryption at rest options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • NodeToNodeEncryptionOptions — (map)

          Whether node-to-node encryption is enabled or disabled.

          • Optionsrequired — (map)

            The node-to-node encryption options for the specified domain.

            • Enabled — (Boolean)

              True to enable node-to-node encryption.

          • Statusrequired — (map)

            The status of the node-to-node encryption options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AdvancedOptions — (map)

          Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

          • Optionsrequired — (map<String>)

            The status of advanced options for the specified domain.

          • Statusrequired — (map)

            The status of advanced options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • LogPublishingOptions — (map)

          Key-value pairs to configure slow log publishing.

          • Options — (map<map>)

            The log publishing options configured for the domain.

            • CloudWatchLogsLogGroupArn — (String)

              The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

            • Enabled — (Boolean)

              Whether the log should be published.

          • Status — (map)

            The status of the log publishing options for the domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • DomainEndpointOptions — (map)

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

          • Optionsrequired — (map)

            Options to configure the endpoint for a domain.

            • EnforceHTTPS — (Boolean)

              True to require that all traffic to the domain arrive over HTTPS.

            • TLSSecurityPolicy — (String)

              Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

              Can be one of the following values:

              • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

              • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

              Possible values include:
              • "Policy-Min-TLS-1-0-2019-07"
              • "Policy-Min-TLS-1-2-2019-07"
            • CustomEndpointEnabled — (Boolean)

              Whether to enable a custom endpoint for the domain.

            • CustomEndpoint — (String)

              The fully qualified URL for the custom endpoint.

            • CustomEndpointCertificateArn — (String)

              The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

          • Statusrequired — (map)

            The status of the endpoint options for a domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AdvancedSecurityOptions — (map)

          Container for fine-grained access control settings for the domain.

          • Optionsrequired — (map)

            Container for fine-grained access control settings.

            • Enabled — (Boolean)

              True if fine-grained access control is enabled.

            • InternalUserDatabaseEnabled — (Boolean)

              True if the internal user database is enabled.

            • SAMLOptions — (map)

              Container for information about the SAML configuration for OpenSearch Dashboards.

              • Enabled — (Boolean)

                True if SAML is enabled.

              • Idp — (map)

                Describes the SAML identity provider's information.

                • MetadataContentrequired — (String)

                  The metadata of the SAML application, in XML format.

                • EntityIdrequired — (String)

                  The unique entity ID of the application in the SAML identity provider.

              • SubjectKey — (String)

                The key used for matching the SAML subject attribute.

              • RolesKey — (String)

                The key used for matching the SAML roles attribute.

              • SessionTimeoutMinutes — (Integer)

                The duration, in minutes, after which a user session becomes inactive.

            • AnonymousAuthDisableDate — (Date)

              Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

            • AnonymousAuthEnabled — (Boolean)

              True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

          • Statusrequired — (map)

            Status of the fine-grained access control settings for a domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AutoTuneOptions — (map)

          Container for Auto-Tune settings for the domain.

          • Options — (map)

            Auto-Tune settings for updating a domain.

            • DesiredState — (String)

              Whether Auto-Tune is enabled or disabled.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • RollbackOnDisable — (String)

              When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

              Possible values include:
              • "NO_ROLLBACK"
              • "DEFAULT_ROLLBACK"
            • MaintenanceSchedules — (Array<map>)

              A list of maintenance schedules during which Auto-Tune can deploy changes.

              • StartAt — (Date)

                The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

              • Duration — (map)

                The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

                • Value — (Integer)

                  Integer to specify the value of a maintenance schedule duration.

                • Unit — (String)

                  The unit of measurement for the duration of a maintenance schedule.

                  Possible values include:
                  • "HOURS"
              • CronExpressionForRecurrence — (String)

                A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

          • Status — (map)

            The current status of Auto-Tune for a domain.

            • CreationDaterequired — (Date)

              Date and time when Auto-Tune was enabled for the domain.

            • UpdateDaterequired — (Date)

              Date and time when the Auto-Tune options were last updated for the domain.

            • UpdateVersion — (Integer)

              The latest version of the Auto-Tune options.

            • Staterequired — (String)

              The current state of Auto-Tune on the domain.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
              • "ENABLE_IN_PROGRESS"
              • "DISABLE_IN_PROGRESS"
              • "DISABLED_AND_ROLLBACK_SCHEDULED"
              • "DISABLED_AND_ROLLBACK_IN_PROGRESS"
              • "DISABLED_AND_ROLLBACK_COMPLETE"
              • "DISABLED_AND_ROLLBACK_ERROR"
              • "ERROR"
            • ErrorMessage — (String)

              Any errors that occurred while enabling or disabling Auto-Tune.

            • PendingDeletion — (Boolean)

              Indicates whether the domain is being deleted.

        • ChangeProgressDetails — (map)

          Container for information about the progress of an existing configuration change.

          • ChangeId — (String)

            The ID of the configuration change.

          • Message — (String)

            A message corresponding to the status of the configuration change.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the describeDomains operation

var params = {
  DomainNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
opensearch.describeDomains(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: {})
    • DomainNames — (Array<String>)

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

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:

      • DomainStatusList — (Array<map>)

        The status of the requested domains.

        • DomainIdrequired — (String)

          Unique identifier for the domain.

        • DomainNamerequired — (String)

          Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.

        • Created — (Boolean)

          Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          Domain-specific endpoint used to submit index, search, and data upload requests to the domain.

        • Endpoints — (map<String>)

          The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints.. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

          The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.

        • EngineVersion — (String)

          Version of OpenSearch or Elasticsearch that the domain is running, in the format Elasticsearch_X.Y or OpenSearch_X.Y.

        • ClusterConfigrequired — (map)

          Container for the cluster configuration of the domain.

          • InstanceType — (String)

            Instance type of data nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • InstanceCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • DedicatedMasterEnabled — (Boolean)

            Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

          • ZoneAwarenessEnabled — (Boolean)

            Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

          • ZoneAwarenessConfig — (map)

            Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

            • AvailabilityZoneCount — (Integer)

              If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

          • DedicatedMasterType — (String)

            OpenSearch Service instance type of the dedicated master nodes in the cluster.

            Possible values include:
            • "m3.medium.search"
            • "m3.large.search"
            • "m3.xlarge.search"
            • "m3.2xlarge.search"
            • "m4.large.search"
            • "m4.xlarge.search"
            • "m4.2xlarge.search"
            • "m4.4xlarge.search"
            • "m4.10xlarge.search"
            • "m5.large.search"
            • "m5.xlarge.search"
            • "m5.2xlarge.search"
            • "m5.4xlarge.search"
            • "m5.12xlarge.search"
            • "m5.24xlarge.search"
            • "r5.large.search"
            • "r5.xlarge.search"
            • "r5.2xlarge.search"
            • "r5.4xlarge.search"
            • "r5.12xlarge.search"
            • "r5.24xlarge.search"
            • "c5.large.search"
            • "c5.xlarge.search"
            • "c5.2xlarge.search"
            • "c5.4xlarge.search"
            • "c5.9xlarge.search"
            • "c5.18xlarge.search"
            • "t3.nano.search"
            • "t3.micro.search"
            • "t3.small.search"
            • "t3.medium.search"
            • "t3.large.search"
            • "t3.xlarge.search"
            • "t3.2xlarge.search"
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
            • "t2.micro.search"
            • "t2.small.search"
            • "t2.medium.search"
            • "r3.large.search"
            • "r3.xlarge.search"
            • "r3.2xlarge.search"
            • "r3.4xlarge.search"
            • "r3.8xlarge.search"
            • "i2.xlarge.search"
            • "i2.2xlarge.search"
            • "d2.xlarge.search"
            • "d2.2xlarge.search"
            • "d2.4xlarge.search"
            • "d2.8xlarge.search"
            • "c4.large.search"
            • "c4.xlarge.search"
            • "c4.2xlarge.search"
            • "c4.4xlarge.search"
            • "c4.8xlarge.search"
            • "r4.large.search"
            • "r4.xlarge.search"
            • "r4.2xlarge.search"
            • "r4.4xlarge.search"
            • "r4.8xlarge.search"
            • "r4.16xlarge.search"
            • "i3.large.search"
            • "i3.xlarge.search"
            • "i3.2xlarge.search"
            • "i3.4xlarge.search"
            • "i3.8xlarge.search"
            • "i3.16xlarge.search"
            • "r6g.large.search"
            • "r6g.xlarge.search"
            • "r6g.2xlarge.search"
            • "r6g.4xlarge.search"
            • "r6g.8xlarge.search"
            • "r6g.12xlarge.search"
            • "m6g.large.search"
            • "m6g.xlarge.search"
            • "m6g.2xlarge.search"
            • "m6g.4xlarge.search"
            • "m6g.8xlarge.search"
            • "m6g.12xlarge.search"
            • "c6g.large.search"
            • "c6g.xlarge.search"
            • "c6g.2xlarge.search"
            • "c6g.4xlarge.search"
            • "c6g.8xlarge.search"
            • "c6g.12xlarge.search"
            • "r6gd.large.search"
            • "r6gd.xlarge.search"
            • "r6gd.2xlarge.search"
            • "r6gd.4xlarge.search"
            • "r6gd.8xlarge.search"
            • "r6gd.12xlarge.search"
            • "r6gd.16xlarge.search"
            • "t4g.small.search"
            • "t4g.medium.search"
          • DedicatedMasterCount — (Integer)

            Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

          • WarmEnabled — (Boolean)

            Whether to enable warm storage for the cluster.

          • WarmType — (String)

            The instance type for the cluster's warm nodes.

            Possible values include:
            • "ultrawarm1.medium.search"
            • "ultrawarm1.large.search"
            • "ultrawarm1.xlarge.search"
          • WarmCount — (Integer)

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Container for cold storage configuration options.

            • Enabledrequired — (Boolean)

              Whether to enable or disable cold storage on the domain.

        • EBSOptions — (map)

          Container for EBS-based storage settings for the domain.

          • EBSEnabled — (Boolean)

            Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

          • VolumeType — (String)

            Specifies the type of EBS volumes attached to data nodes.

            Possible values include:
            • "standard"
            • "gp2"
            • "io1"
            • "gp3"
          • VolumeSize — (Integer)

            Specifies the size (in GiB) of EBS volumes attached to data nodes.

          • Iops — (Integer)

            Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

          • Throughput — (Integer)

            Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

        • AccessPolicies — (String)

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

        • SnapshotOptions — (map)

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

          • AutomatedSnapshotStartHour — (Integer)

            The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

        • VPCOptions — (map)

          The VPC configuration for the domain.

          • VPCId — (String)

            The ID for your VPC. Amazon VPC generates this value when you create a VPC.

          • SubnetIds — (Array<String>)

            A list of subnet IDs associated with the VPC endpoints for the domain.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones associated with the VPC subnets.

          • SecurityGroupIds — (Array<String>)

            The list of security group IDs associated with the VPC endpoints for the domain.

        • CognitoOptions — (map)

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

          • Enabled — (Boolean)

            Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

          • UserPoolId — (String)

            The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

        • EncryptionAtRestOptions — (map)

          Encryption at rest settings for the domain.

          • Enabled — (Boolean)

            True to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

        • NodeToNodeEncryptionOptions — (map)

          Whether node-to-node encryption is enabled or disabled.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Key-value pairs that specify advanced configuration options.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the domain.

          • CloudWatchLogsLogGroupArn — (String)

            The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

          • Enabled — (Boolean)

            Whether the log should be published.

        • ServiceSoftwareOptions — (map)

          The current status of the domain's service software.

          • CurrentVersion — (String)

            The current service software version present on the domain.

          • NewVersion — (String)

            The new service software version, if one is available.

          • UpdateAvailable — (Boolean)

            True if you're able to update your service software version. False if you can't update your service software version.

          • Cancellable — (Boolean)

            True if you're able to cancel your service software version update. False if you can't cancel your service software update.

          • UpdateStatus — (String)

            The status of your service software update.

            Possible values include:
            • "PENDING_UPDATE"
            • "IN_PROGRESS"
            • "COMPLETED"
            • "NOT_ELIGIBLE"
            • "ELIGIBLE"
          • Description — (String)

            A description of the service software update status.

          • AutomatedUpdateDate — (Date)

            The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

          • OptionalDeployment — (Boolean)

            True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

        • DomainEndpointOptions — (map)

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

          • EnforceHTTPS — (Boolean)

            True to require that all traffic to the domain arrive over HTTPS.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

            Can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

            Possible values include:
            • "Policy-Min-TLS-1-0-2019-07"
            • "Policy-Min-TLS-1-2-2019-07"
          • CustomEndpointEnabled — (Boolean)

            Whether to enable a custom endpoint for the domain.

          • CustomEndpoint — (String)

            The fully qualified URL for the custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

        • AdvancedSecurityOptions — (map)

          Settings for fine-grained access control.

          • Enabled — (Boolean)

            True if fine-grained access control is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Container for information about the SAML configuration for OpenSearch Dashboards.

            • Enabled — (Boolean)

              True if SAML is enabled.

            • Idp — (map)

              Describes the SAML identity provider's information.

              • MetadataContentrequired — (String)

                The metadata of the SAML application, in XML format.

              • EntityIdrequired — (String)

                The unique entity ID of the application in the SAML identity provider.

            • SubjectKey — (String)

              The key used for matching the SAML subject attribute.

            • RolesKey — (String)

              The key used for matching the SAML roles attribute.

            • SessionTimeoutMinutes — (Integer)

              The duration, in minutes, after which a user session becomes inactive.

          • AnonymousAuthDisableDate — (Date)

            Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

          • AnonymousAuthEnabled — (Boolean)

            True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

        • AutoTuneOptions — (map)

          Auto-Tune settings for the domain.

          • State — (String)

            The current state of Auto-Tune on the domain.

            Possible values include:
            • "ENABLED"
            • "DISABLED"
            • "ENABLE_IN_PROGRESS"
            • "DISABLE_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_SCHEDULED"
            • "DISABLED_AND_ROLLBACK_IN_PROGRESS"
            • "DISABLED_AND_ROLLBACK_COMPLETE"
            • "DISABLED_AND_ROLLBACK_ERROR"
            • "ERROR"
          • ErrorMessage — (String)

            Any errors that occurred while enabling or disabling Auto-Tune.

        • ChangeProgressDetails — (map)

          Information about a configuration change happening on the domain.

          • ChangeId — (String)

            The ID of the configuration change.

          • Message — (String)

            A message corresponding to the status of the configuration change.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the describeInboundConnections operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.describeInboundConnections(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: {})
    • Filters — (Array<map>)

      A list of filters used to match properties for inbound cross-cluster connections.

      • Name — (String)

        The name of the filter.

      • Values — (Array<String>)

        One or more values for the filter.

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

    • NextToken — (String)

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

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:

      • Connections — (Array<map>)

        List of inbound connections.

        • LocalDomainInfo — (map)

          Information about the source (local) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • RemoteDomainInfo — (map)

          Information about the destination (remote) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • ConnectionId — (String)

          The unique identifier of the connection.

        • ConnectionStatus — (map)

          The current status of the connection.

          • StatusCode — (String)

            The status code for the connection. Can be one of the following:

            • PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.

            • APPROVED: Inbound connection is pending acceptance by the remote domain owner.

            • PROVISIONING: Inbound connection is being provisioned.

            • ACTIVE: Inbound connection is active and ready to use.

            • REJECTING: Inbound connection rejection is in process.

            • REJECTED: Inbound connection is rejected.

            • DELETING: Inbound connection deletion is in progress.

            • DELETED: Inbound connection is deleted and can no longer be used.

            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Information about the connection.

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

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

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

Service Reference:

Examples:

Calling the describeInstanceTypeLimits operation

var params = {
  EngineVersion: 'STRING_VALUE', /* required */
  InstanceType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search, /* required */
  DomainName: 'STRING_VALUE'
};
opensearch.describeInstanceTypeLimits(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: {})
    • DomainName — (String)

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

    • InstanceType — (String)

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

      Possible values include:
      • "m3.medium.search"
      • "m3.large.search"
      • "m3.xlarge.search"
      • "m3.2xlarge.search"
      • "m4.large.search"
      • "m4.xlarge.search"
      • "m4.2xlarge.search"
      • "m4.4xlarge.search"
      • "m4.10xlarge.search"
      • "m5.large.search"
      • "m5.xlarge.search"
      • "m5.2xlarge.search"
      • "m5.4xlarge.search"
      • "m5.12xlarge.search"
      • "m5.24xlarge.search"
      • "r5.large.search"
      • "r5.xlarge.search"
      • "r5.2xlarge.search"
      • "r5.4xlarge.search"
      • "r5.12xlarge.search"
      • "r5.24xlarge.search"
      • "c5.large.search"
      • "c5.xlarge.search"
      • "c5.2xlarge.search"
      • "c5.4xlarge.search"
      • "c5.9xlarge.search"
      • "c5.18xlarge.search"
      • "t3.nano.search"
      • "t3.micro.search"
      • "t3.small.search"
      • "t3.medium.search"
      • "t3.large.search"
      • "t3.xlarge.search"
      • "t3.2xlarge.search"
      • "ultrawarm1.medium.search"
      • "ultrawarm1.large.search"
      • "ultrawarm1.xlarge.search"
      • "t2.micro.search"
      • "t2.small.search"
      • "t2.medium.search"
      • "r3.large.search"
      • "r3.xlarge.search"
      • "r3.2xlarge.search"
      • "r3.4xlarge.search"
      • "r3.8xlarge.search"
      • "i2.xlarge.search"
      • "i2.2xlarge.search"
      • "d2.xlarge.search"
      • "d2.2xlarge.search"
      • "d2.4xlarge.search"
      • "d2.8xlarge.search"
      • "c4.large.search"
      • "c4.xlarge.search"
      • "c4.2xlarge.search"
      • "c4.4xlarge.search"
      • "c4.8xlarge.search"
      • "r4.large.search"
      • "r4.xlarge.search"
      • "r4.2xlarge.search"
      • "r4.4xlarge.search"
      • "r4.8xlarge.search"
      • "r4.16xlarge.search"
      • "i3.large.search"
      • "i3.xlarge.search"
      • "i3.2xlarge.search"
      • "i3.4xlarge.search"
      • "i3.8xlarge.search"
      • "i3.16xlarge.search"
      • "r6g.large.search"
      • "r6g.xlarge.search"
      • "r6g.2xlarge.search"
      • "r6g.4xlarge.search"
      • "r6g.8xlarge.search"
      • "r6g.12xlarge.search"
      • "m6g.large.search"
      • "m6g.xlarge.search"
      • "m6g.2xlarge.search"
      • "m6g.4xlarge.search"
      • "m6g.8xlarge.search"
      • "m6g.12xlarge.search"
      • "c6g.large.search"
      • "c6g.xlarge.search"
      • "c6g.2xlarge.search"
      • "c6g.4xlarge.search"
      • "c6g.8xlarge.search"
      • "c6g.12xlarge.search"
      • "r6gd.large.search"
      • "r6gd.xlarge.search"
      • "r6gd.2xlarge.search"
      • "r6gd.4xlarge.search"
      • "r6gd.8xlarge.search"
      • "r6gd.12xlarge.search"
      • "r6gd.16xlarge.search"
      • "t4g.small.search"
      • "t4g.medium.search"
    • EngineVersion — (String)

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

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:

      • LimitsByRole — (map<map>)

        Map that contains all applicable instance type limits.data refers to data nodes.master refers to dedicated master nodes.

        • StorageTypes — (Array<map>)

          Storage-related attributes that are available for a given instance type.

          • StorageTypeName — (String)

            The name of the storage type.

          • StorageSubTypeName — (String)

            The storage sub-type, such as gp3 or io1.

          • StorageTypeLimits — (Array<map>)

            Limits that are applicable for the given storage type.

            • LimitName — (String)

              Name of storage limits that are applicable for the given storage type. If StorageType is ebs, the following options are available:

              • MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.

              • MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.

              • MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

              • MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.

              • MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

              • MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.

            • LimitValues — (Array<String>)

              The limit values.

        • InstanceLimits — (map)

          The limits for a given instance type.

          • InstanceCountLimits — (map)

            Limits on the number of instances that can be created for a given instance type.

            • MinimumInstanceCount — (Integer)

              The maximum allowed number of instances.

            • MaximumInstanceCount — (Integer)

              The minimum allowed number of instances.

        • AdditionalLimits — (Array<map>)

          List of additional limits that are specific to a given instance type for each of its instance roles.

          • LimitName — (String)
            • MaximumNumberOfDataNodesSupported - This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support.

            • MaximumNumberOfDataNodesWithoutMasterNode - This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.

          • LimitValues — (Array<String>)

            The values of the additional instance type limits.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the describeOutboundConnections operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.describeOutboundConnections(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: {})
    • Filters — (Array<map>)

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

      • Name — (String)

        The name of the filter.

      • Values — (Array<String>)

        One or more values for the filter.

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

    • NextToken — (String)

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

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:

      • Connections — (Array<map>)

        List of outbound connections that match the filter criteria.

        • LocalDomainInfo — (map)

          Information about the source (local) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • RemoteDomainInfo — (map)

          Information about the destination (remote) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • ConnectionId — (String)

          Unique identifier of the connection.

        • ConnectionAlias — (String)

          Name of the connection.

        • ConnectionStatus — (map)

          Status of the connection.

          • StatusCode — (String)

            The status code for the outbound connection. Can be one of the following:

            • VALIDATING - The outbound connection request is being validated.

            • VALIDATION_FAILED - Validation failed for the connection request.

            • PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.

            • APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.

            • PROVISIONING - Outbound connection request is in process.

            • ACTIVE - Outbound connection is active and ready to use.

            • REJECTING - Outbound connection rejection by remote domain owner is in progress.

            • REJECTED - Outbound connection request is rejected by remote domain owner.

            • DELETING - Outbound connection deletion is in progress.

            • DELETED - Outbound connection is deleted and can no longer be used.

            Possible values include:
            • "VALIDATING"
            • "VALIDATION_FAILED"
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Verbose information for the outbound connection.

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

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

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

Service Reference:

Examples:

Calling the describePackages operation

var params = {
  Filters: [
    {
      Name: PackageID | PackageName | PackageStatus,
      Value: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.describePackages(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: {})
    • Filters — (Array<map>)

      Only returns packages that match the DescribePackagesFilterList values.

      • Name — (String)

        Any field from PackageDetails.

        Possible values include:
        • "PackageID"
        • "PackageName"
        • "PackageStatus"
      • Value — (Array<String>)

        A list of values for the specified filter field.

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

    • NextToken — (String)

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

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:

      • PackageDetailsList — (Array<map>)

        Basic information about a package.

        • PackageID — (String)

          The unique identifier of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • PackageDescription — (String)

          User-specified description of the package.

        • PackageStatus — (String)

          Current status of the package.

          Possible values include:
          • "COPYING"
          • "COPY_FAILED"
          • "VALIDATING"
          • "VALIDATION_FAILED"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"
          • "DELETE_FAILED"
        • CreatedAt — (Date)

          The timestamp when the package was created.

        • LastUpdatedAt — (Date)

          Date and time when the package was last updated.

        • AvailablePackageVersion — (String)

          The package version.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

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

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

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

Examples:

Calling the describeReservedInstanceOfferings operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ReservedInstanceOfferingId: 'STRING_VALUE'
};
opensearch.describeReservedInstanceOfferings(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: {})
    • ReservedInstanceOfferingId — (String)

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

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

    • NextToken — (String)

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

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.

      • ReservedInstanceOfferings — (Array<map>)

        List of Reserved Instance offerings.

        • ReservedInstanceOfferingId — (String)

          The unique identifier of the Reserved Instance offering.

        • InstanceType — (String)

          The OpenSearch instance type offered by the Reserved Instance offering.

          Possible values include:
          • "m3.medium.search"
          • "m3.large.search"
          • "m3.xlarge.search"
          • "m3.2xlarge.search"
          • "m4.large.search"
          • "m4.xlarge.search"
          • "m4.2xlarge.search"
          • "m4.4xlarge.search"
          • "m4.10xlarge.search"
          • "m5.large.search"
          • "m5.xlarge.search"
          • "m5.2xlarge.search"
          • "m5.4xlarge.search"
          • "m5.12xlarge.search"
          • "m5.24xlarge.search"
          • "r5.large.search"
          • "r5.xlarge.search"
          • "r5.2xlarge.search"
          • "r5.4xlarge.search"
          • "r5.12xlarge.search"
          • "r5.24xlarge.search"
          • "c5.large.search"
          • "c5.xlarge.search"
          • "c5.2xlarge.search"
          • "c5.4xlarge.search"
          • "c5.9xlarge.search"
          • "c5.18xlarge.search"
          • "t3.nano.search"
          • "t3.micro.search"
          • "t3.small.search"
          • "t3.medium.search"
          • "t3.large.search"
          • "t3.xlarge.search"
          • "t3.2xlarge.search"
          • "ultrawarm1.medium.search"
          • "ultrawarm1.large.search"
          • "ultrawarm1.xlarge.search"
          • "t2.micro.search"
          • "t2.small.search"
          • "t2.medium.search"
          • "r3.large.search"
          • "r3.xlarge.search"
          • "r3.2xlarge.search"
          • "r3.4xlarge.search"
          • "r3.8xlarge.search"
          • "i2.xlarge.search"
          • "i2.2xlarge.search"
          • "d2.xlarge.search"
          • "d2.2xlarge.search"
          • "d2.4xlarge.search"
          • "d2.8xlarge.search"
          • "c4.large.search"
          • "c4.xlarge.search"
          • "c4.2xlarge.search"
          • "c4.4xlarge.search"
          • "c4.8xlarge.search"
          • "r4.large.search"
          • "r4.xlarge.search"
          • "r4.2xlarge.search"
          • "r4.4xlarge.search"
          • "r4.8xlarge.search"
          • "r4.16xlarge.search"
          • "i3.large.search"
          • "i3.xlarge.search"
          • "i3.2xlarge.search"
          • "i3.4xlarge.search"
          • "i3.8xlarge.search"
          • "i3.16xlarge.search"
          • "r6g.large.search"
          • "r6g.xlarge.search"
          • "r6g.2xlarge.search"
          • "r6g.4xlarge.search"
          • "r6g.8xlarge.search"
          • "r6g.12xlarge.search"
          • "m6g.large.search"
          • "m6g.xlarge.search"
          • "m6g.2xlarge.search"
          • "m6g.4xlarge.search"
          • "m6g.8xlarge.search"
          • "m6g.12xlarge.search"
          • "c6g.large.search"
          • "c6g.xlarge.search"
          • "c6g.2xlarge.search"
          • "c6g.4xlarge.search"
          • "c6g.8xlarge.search"
          • "c6g.12xlarge.search"
          • "r6gd.large.search"
          • "r6gd.xlarge.search"
          • "r6gd.2xlarge.search"
          • "r6gd.4xlarge.search"
          • "r6gd.8xlarge.search"
          • "r6gd.12xlarge.search"
          • "r6gd.16xlarge.search"
          • "t4g.small.search"
          • "t4g.medium.search"
        • Duration — (Integer)

          The duration, in seconds, for which the offering will reserve the OpenSearch instance.

        • FixedPrice — (Float)

          The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.

        • UsagePrice — (Float)

          The hourly rate at which you're charged for the domain using this Reserved Instance.

        • CurrencyCode — (String)

          The currency code for the Reserved Instance offering.

        • PaymentOption — (String)

          Payment option for the Reserved Instance offering

          Possible values include:
          • "ALL_UPFRONT"
          • "PARTIAL_UPFRONT"
          • "NO_UPFRONT"
        • RecurringCharges — (Array<map>)

          The recurring charge to your account, regardless of whether you creates any domains using the offering.

          • RecurringChargeAmount — (Float)

            The monetary amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the describeReservedInstances operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ReservedInstanceId: 'STRING_VALUE'
};
opensearch.describeReservedInstances(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: {})
    • ReservedInstanceId — (String)

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

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

    • NextToken — (String)

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

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.

      • ReservedInstances — (Array<map>)

        List of Reserved Instances in the current Region.

        • ReservationName — (String)

          The customer-specified identifier to track this reservation.

        • ReservedInstanceId — (String)

          The unique identifier for the reservation.

        • BillingSubscriptionId — (Integer)

          The unique identifier of the billing subscription.

        • ReservedInstanceOfferingId — (String)

          The unique identifier of the Reserved Instance offering.

        • InstanceType — (String)

          The OpenSearch instance type offered by theReserved Instance offering.

          Possible values include:
          • "m3.medium.search"
          • "m3.large.search"
          • "m3.xlarge.search"
          • "m3.2xlarge.search"
          • "m4.large.search"
          • "m4.xlarge.search"
          • "m4.2xlarge.search"
          • "m4.4xlarge.search"
          • "m4.10xlarge.search"
          • "m5.large.search"
          • "m5.xlarge.search"
          • "m5.2xlarge.search"
          • "m5.4xlarge.search"
          • "m5.12xlarge.search"
          • "m5.24xlarge.search"
          • "r5.large.search"
          • "r5.xlarge.search"
          • "r5.2xlarge.search"
          • "r5.4xlarge.search"
          • "r5.12xlarge.search"
          • "r5.24xlarge.search"
          • "c5.large.search"
          • "c5.xlarge.search"
          • "c5.2xlarge.search"
          • "c5.4xlarge.search"
          • "c5.9xlarge.search"
          • "c5.18xlarge.search"
          • "t3.nano.search"
          • "t3.micro.search"
          • "t3.small.search"
          • "t3.medium.search"
          • "t3.large.search"
          • "t3.xlarge.search"
          • "t3.2xlarge.search"
          • "ultrawarm1.medium.search"
          • "ultrawarm1.large.search"
          • "ultrawarm1.xlarge.search"
          • "t2.micro.search"
          • "t2.small.search"
          • "t2.medium.search"
          • "r3.large.search"
          • "r3.xlarge.search"
          • "r3.2xlarge.search"
          • "r3.4xlarge.search"
          • "r3.8xlarge.search"
          • "i2.xlarge.search"
          • "i2.2xlarge.search"
          • "d2.xlarge.search"
          • "d2.2xlarge.search"
          • "d2.4xlarge.search"
          • "d2.8xlarge.search"
          • "c4.large.search"
          • "c4.xlarge.search"
          • "c4.2xlarge.search"
          • "c4.4xlarge.search"
          • "c4.8xlarge.search"
          • "r4.large.search"
          • "r4.xlarge.search"
          • "r4.2xlarge.search"
          • "r4.4xlarge.search"
          • "r4.8xlarge.search"
          • "r4.16xlarge.search"
          • "i3.large.search"
          • "i3.xlarge.search"
          • "i3.2xlarge.search"
          • "i3.4xlarge.search"
          • "i3.8xlarge.search"
          • "i3.16xlarge.search"
          • "r6g.large.search"
          • "r6g.xlarge.search"
          • "r6g.2xlarge.search"
          • "r6g.4xlarge.search"
          • "r6g.8xlarge.search"
          • "r6g.12xlarge.search"
          • "m6g.large.search"
          • "m6g.xlarge.search"
          • "m6g.2xlarge.search"
          • "m6g.4xlarge.search"
          • "m6g.8xlarge.search"
          • "m6g.12xlarge.search"
          • "c6g.large.search"
          • "c6g.xlarge.search"
          • "c6g.2xlarge.search"
          • "c6g.4xlarge.search"
          • "c6g.8xlarge.search"
          • "c6g.12xlarge.search"
          • "r6gd.large.search"
          • "r6gd.xlarge.search"
          • "r6gd.2xlarge.search"
          • "r6gd.4xlarge.search"
          • "r6gd.8xlarge.search"
          • "r6gd.12xlarge.search"
          • "r6gd.16xlarge.search"
          • "t4g.small.search"
          • "t4g.medium.search"
        • StartTime — (Date)

          The date and time when the reservation was purchased.

        • Duration — (Integer)

          The duration, in seconds, for which the OpenSearch instance is reserved.

        • FixedPrice — (Float)

          The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.

        • UsagePrice — (Float)

          The hourly rate at which you're charged for the domain using this Reserved Instance.

        • CurrencyCode — (String)

          The currency code for the offering.

        • InstanceCount — (Integer)

          The number of OpenSearch instances that have been reserved.

        • State — (String)

          The state of the Reserved Instance.

        • PaymentOption — (String)

          The payment option as defined in the Reserved Instance offering.

          Possible values include:
          • "ALL_UPFRONT"
          • "PARTIAL_UPFRONT"
          • "NO_UPFRONT"
        • RecurringCharges — (Array<map>)

          The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.

          • RecurringChargeAmount — (Float)

            The monetary amount of the recurring charge.

          • RecurringChargeFrequency — (String)

            The frequency of the recurring charge.

Returns:

  • (AWS.Request)

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

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

Describes one or more Amazon OpenSearch Service-managed VPC endpoints.

Service Reference:

Examples:

Calling the describeVpcEndpoints operation

var params = {
  VpcEndpointIds: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
opensearch.describeVpcEndpoints(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: {})
    • VpcEndpointIds — (Array<String>)

      The unique identifiers of the endpoints to get information about.

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:

      • VpcEndpoints — (Array<map>)

        Information about each requested VPC endpoint.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

          The Amazon Resource Name (ARN) of the domain associated with the endpoint.

        • VpcOptions — (map)

          Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

          • VPCId — (String)

            The ID for your VPC. Amazon VPC generates this value when you create a VPC.

          • SubnetIds — (Array<String>)

            A list of subnet IDs associated with the VPC endpoints for the domain.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones associated with the VPC subnets.

          • SecurityGroupIds — (Array<String>)

            The list of security group IDs associated with the VPC endpoints for the domain.

        • Status — (String)

          The current status of the endpoint.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "UPDATING"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETE_FAILED"
        • Endpoint — (String)

          The connection endpoint ID for connecting to the domain.

      • VpcEndpointErrors — (Array<map>)

        Any errors associated with the request.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • ErrorCode — (String)

          The code associated with the error.

          Possible values include:
          • "ENDPOINT_NOT_FOUND"
          • "SERVER_ERROR"
        • ErrorMessage — (String)

          A message describing the error.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the dissociatePackage operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  PackageID: 'STRING_VALUE' /* required */
};
opensearch.dissociatePackage(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: {})
    • PackageID — (String)

      Internal ID of the package to dissociate from the domain. Use ListPackagesForDomain to find this value.

    • DomainName — (String)

      Name of the domain to dissociate the package from.

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:

      • DomainPackageDetails — (map)

        Information about a package that has been dissociated from the domain.

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • LastUpdated — (Date)

          Timestamp of the most recent update to the package association status.

        • DomainName — (String)

          Name of the domain that the package is associated with.

        • DomainPackageStatus — (String)

          State of the association.

          Possible values include:
          • "ASSOCIATING"
          • "ASSOCIATION_FAILED"
          • "ACTIVE"
          • "DISSOCIATING"
          • "DISSOCIATION_FAILED"
        • PackageVersion — (String)

          The current version of the package.

        • ReferencePath — (String)

          Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the getCompatibleVersions operation

var params = {
  DomainName: 'STRING_VALUE'
};
opensearch.getCompatibleVersions(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: {})
    • DomainName — (String)

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

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:

      • CompatibleVersions — (Array<map>)

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

        • SourceVersion — (String)

          The current version that the OpenSearch Service domain is running.

        • TargetVersions — (Array<String>)

          The possible versions that you can upgrade the domain to.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the getPackageVersionHistory operation

var params = {
  PackageID: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.getPackageVersionHistory(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: {})
    • PackageID — (String)

      The unique identifier of the package.

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

    • NextToken — (String)

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

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:

      • PackageID — (String)

        The unique identifier of the package.

      • PackageVersionHistoryList — (Array<map>)

        A list of package versions, along with their creation time and commit message.

        • PackageVersion — (String)

          The package version.

        • CommitMessage — (String)

          A message associated with the package version when it was uploaded.

        • CreatedAt — (Date)

          The date and time when the package was created.

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

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

Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.

Service Reference:

Examples:

Calling the getUpgradeHistory operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.getUpgradeHistory(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: {})
    • DomainName — (String)

      The name of an existing domain.

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

    • NextToken — (String)

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

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:

      • UpgradeHistories — (Array<map>)

        A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.

        • UpgradeName — (String)

          A string that describes the upgrade.

        • StartTimestamp — (Date)

          UTC timestamp at which the upgrade API call was made, in the format yyyy-MM-ddTHH:mm:ssZ.

        • UpgradeStatus — (String)

          The current status of the upgrade. The status can take one of the following values:

          • In Progress

          • Succeeded

          • Succeeded with Issues

          • Failed

          Possible values include:
          • "IN_PROGRESS"
          • "SUCCEEDED"
          • "SUCCEEDED_WITH_ISSUES"
          • "FAILED"
        • StepsList — (Array<map>)

          A list of each step performed as part of a specific upgrade or upgrade eligibility check.

          • UpgradeStep — (String)

            One of three steps that an upgrade or upgrade eligibility check goes through:

            • PreUpgradeCheck

            • Snapshot

            • Upgrade

            Possible values include:
            • "PRE_UPGRADE_CHECK"
            • "SNAPSHOT"
            • "UPGRADE"
          • UpgradeStepStatus — (String)

            The current status of the upgrade. The status can take one of the following values:

            • In Progress

            • Succeeded

            • Succeeded with Issues

            • Failed

            Possible values include:
            • "IN_PROGRESS"
            • "SUCCEEDED"
            • "SUCCEEDED_WITH_ISSUES"
            • "FAILED"
          • Issues — (Array<String>)

            A list of strings containing detailed information about the errors encountered in a particular step.

          • ProgressPercent — (Float)

            The floating point value representing the progress percentage of a particular step.

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

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

Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.

Service Reference:

Examples:

Calling the getUpgradeStatus operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.getUpgradeStatus(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: {})
    • DomainName — (String)

      The domain of the domain to get upgrade status information for.

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:

      • UpgradeStep — (String)

        One of three steps that an upgrade or upgrade eligibility check goes through.

        Possible values include:
        • "PRE_UPGRADE_CHECK"
        • "SNAPSHOT"
        • "UPGRADE"
      • StepStatus — (String)

        The status of the current step that an upgrade is on.

        Possible values include:
        • "IN_PROGRESS"
        • "SUCCEEDED"
        • "SUCCEEDED_WITH_ISSUES"
        • "FAILED"
      • UpgradeName — (String)

        A string that describes the update.

Returns:

  • (AWS.Request)

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

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

Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.

Service Reference:

Examples:

Calling the listDomainNames operation

var params = {
  EngineType: OpenSearch | Elasticsearch
};
opensearch.listDomainNames(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: {})
    • EngineType — (String)

      Filters the output by domain engine type.

      Possible values include:
      • "OpenSearch"
      • "Elasticsearch"

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:

      • DomainNames — (Array<map>)

        The names of all OpenSearch Service domains owned by the current user and their respective engine types.

        • DomainName — (String)

          Name of the domain.

        • EngineType — (String)

          The type of search engine that the domain is running.OpenSearch for an OpenSearch engine, or Elasticsearch for a legacy Elasticsearch OSS engine.

          Possible values include:
          • "OpenSearch"
          • "Elasticsearch"

Returns:

  • (AWS.Request)

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

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

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Service Reference:

Examples:

Calling the listDomainsForPackage operation

var params = {
  PackageID: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.listDomainsForPackage(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: {})
    • PackageID — (String)

      The unique identifier of the package for which to list associated domains.

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

    • NextToken — (String)

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

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:

      • DomainPackageDetailsList — (Array<map>)

        Information about all domains associated with a package.

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • LastUpdated — (Date)

          Timestamp of the most recent update to the package association status.

        • DomainName — (String)

          Name of the domain that the package is associated with.

        • DomainPackageStatus — (String)

          State of the association.

          Possible values include:
          • "ASSOCIATING"
          • "ASSOCIATION_FAILED"
          • "ACTIVE"
          • "DISSOCIATING"
          • "DISSOCIATION_FAILED"
        • PackageVersion — (String)

          The current version of the package.

        • ReferencePath — (String)

          Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

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

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

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

Service Reference:

Examples:

Calling the listInstanceTypeDetails operation

var params = {
  EngineVersion: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.listInstanceTypeDetails(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: {})
    • EngineVersion — (String)

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

    • DomainName — (String)

      Name of the domain to list instance type details for.

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

    • NextToken — (String)

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

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:

      • InstanceTypeDetails — (Array<map>)

        Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.

        • InstanceType — (String)

          The instance type.

          Possible values include:
          • "m3.medium.search"
          • "m3.large.search"
          • "m3.xlarge.search"
          • "m3.2xlarge.search"
          • "m4.large.search"
          • "m4.xlarge.search"
          • "m4.2xlarge.search"
          • "m4.4xlarge.search"
          • "m4.10xlarge.search"
          • "m5.large.search"
          • "m5.xlarge.search"
          • "m5.2xlarge.search"
          • "m5.4xlarge.search"
          • "m5.12xlarge.search"
          • "m5.24xlarge.search"
          • "r5.large.search"
          • "r5.xlarge.search"
          • "r5.2xlarge.search"
          • "r5.4xlarge.search"
          • "r5.12xlarge.search"
          • "r5.24xlarge.search"
          • "c5.large.search"
          • "c5.xlarge.search"
          • "c5.2xlarge.search"
          • "c5.4xlarge.search"
          • "c5.9xlarge.search"
          • "c5.18xlarge.search"
          • "t3.nano.search"
          • "t3.micro.search"
          • "t3.small.search"
          • "t3.medium.search"
          • "t3.large.search"
          • "t3.xlarge.search"
          • "t3.2xlarge.search"
          • "ultrawarm1.medium.search"
          • "ultrawarm1.large.search"
          • "ultrawarm1.xlarge.search"
          • "t2.micro.search"
          • "t2.small.search"
          • "t2.medium.search"
          • "r3.large.search"
          • "r3.xlarge.search"
          • "r3.2xlarge.search"
          • "r3.4xlarge.search"
          • "r3.8xlarge.search"
          • "i2.xlarge.search"
          • "i2.2xlarge.search"
          • "d2.xlarge.search"
          • "d2.2xlarge.search"
          • "d2.4xlarge.search"
          • "d2.8xlarge.search"
          • "c4.large.search"
          • "c4.xlarge.search"
          • "c4.2xlarge.search"
          • "c4.4xlarge.search"
          • "c4.8xlarge.search"
          • "r4.large.search"
          • "r4.xlarge.search"
          • "r4.2xlarge.search"
          • "r4.4xlarge.search"
          • "r4.8xlarge.search"
          • "r4.16xlarge.search"
          • "i3.large.search"
          • "i3.xlarge.search"
          • "i3.2xlarge.search"
          • "i3.4xlarge.search"
          • "i3.8xlarge.search"
          • "i3.16xlarge.search"
          • "r6g.large.search"
          • "r6g.xlarge.search"
          • "r6g.2xlarge.search"
          • "r6g.4xlarge.search"
          • "r6g.8xlarge.search"
          • "r6g.12xlarge.search"
          • "m6g.large.search"
          • "m6g.xlarge.search"
          • "m6g.2xlarge.search"
          • "m6g.4xlarge.search"
          • "m6g.8xlarge.search"
          • "m6g.12xlarge.search"
          • "c6g.large.search"
          • "c6g.xlarge.search"
          • "c6g.2xlarge.search"
          • "c6g.4xlarge.search"
          • "c6g.8xlarge.search"
          • "c6g.12xlarge.search"
          • "r6gd.large.search"
          • "r6gd.xlarge.search"
          • "r6gd.2xlarge.search"
          • "r6gd.4xlarge.search"
          • "r6gd.8xlarge.search"
          • "r6gd.12xlarge.search"
          • "r6gd.16xlarge.search"
          • "t4g.small.search"
          • "t4g.medium.search"
        • EncryptionEnabled — (Boolean)

          Whether encryption at rest and node-to-node encryption are supported for the instance type.

        • CognitoEnabled — (Boolean)

          Whether Amazon Cognito access is supported for the instance type.

        • AppLogsEnabled — (Boolean)

          Whether logging is supported for the instance type.

        • AdvancedSecurityEnabled — (Boolean)

          Whether fine-grained access control is supported for the instance type.

        • WarmEnabled — (Boolean)

          Whether UltraWarm is supported for the instance type.

        • InstanceRole — (Array<String>)

          Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.

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

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

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

Service Reference:

Examples:

Calling the listPackagesForDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.listPackagesForDomain(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: {})
    • DomainName — (String)

      The name of the domain for which you want to list associated packages.

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

    • NextToken — (String)

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

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:

      • DomainPackageDetailsList — (Array<map>)

        List of all packages associated with a domain.

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • LastUpdated — (Date)

          Timestamp of the most recent update to the package association status.

        • DomainName — (String)

          Name of the domain that the package is associated with.

        • DomainPackageStatus — (String)

          State of the association.

          Possible values include:
          • "ASSOCIATING"
          • "ASSOCIATION_FAILED"
          • "ACTIVE"
          • "DISSOCIATING"
          • "DISSOCIATION_FAILED"
        • PackageVersion — (String)

          The current version of the package.

        • ReferencePath — (String)

          Denotes the location of the package on the OpenSearch Service cluster nodes. It's the same as synonym_path for dictionary files.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

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

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

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

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ARN: 'STRING_VALUE' /* required */
};
opensearch.listTags(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: {})
    • ARN — (String)

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

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:

      • TagList — (Array<map>)

        List of resource tags associated with the specified domain.

        • Keyrequired — (String)

          The tag key. Tag keys must be unique for the domain to which they are attached.

        • Valuerequired — (String)

          The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the listVersions operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
opensearch.listVersions(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.

    • NextToken — (String)

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

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:

      • Versions — (Array<String>)

        A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.

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

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

Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.

Service Reference:

Examples:

Calling the listVpcEndpointAccess operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
opensearch.listVpcEndpointAccess(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: {})
    • DomainName — (String)

      The name of the OpenSearch Service domain to retrieve access information for.

    • NextToken — (String)

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

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:

      • AuthorizedPrincipalList — (Array<map>)

        A list of IAM principals that can currently access the domain.

        • PrincipalType — (String)

          The type of principal.

          Possible values include:
          • "AWS_ACCOUNT"
          • "AWS_SERVICE"
        • Principal — (String)

          The IAM principal that is allowed access to the domain.

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

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

Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.

Service Reference:

Examples:

Calling the listVpcEndpoints operation

var params = {
  NextToken: 'STRING_VALUE'
};
opensearch.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: {})
    • 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.

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:

      • VpcEndpointSummaryList — (Array<map>)

        Information about each endpoint.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

          The Amazon Resource Name (ARN) of the domain associated with the endpoint.

        • Status — (String)

          The current status of the endpoint.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "UPDATING"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETE_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.

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

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Service Reference:

Examples:

Calling the listVpcEndpointsForDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  NextToken: 'STRING_VALUE'
};
opensearch.listVpcEndpointsForDomain(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: {})
    • DomainName — (String)

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

    • NextToken — (String)

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

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:

      • VpcEndpointSummaryList — (Array<map>)

        Information about each endpoint associated with the domain.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

          The Amazon Resource Name (ARN) of the domain associated with the endpoint.

        • Status — (String)

          The current status of the endpoint.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "UPDATING"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETE_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.

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

Allows you to purchase Amazon OpenSearch Service Reserved Instances.

Examples:

Calling the purchaseReservedInstanceOffering operation

var params = {
  ReservationName: 'STRING_VALUE', /* required */
  ReservedInstanceOfferingId: 'STRING_VALUE', /* required */
  InstanceCount: 'NUMBER_VALUE'
};
opensearch.purchaseReservedInstanceOffering(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: {})
    • ReservedInstanceOfferingId — (String)

      The ID of the Reserved Instance offering to purchase.

    • ReservationName — (String)

      A customer-specified identifier to track this reservation.

    • InstanceCount — (Integer)

      The number of OpenSearch instances to reserve.

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:

      • ReservedInstanceId — (String)

        The ID of the Reserved Instance offering that was purchased.

      • ReservationName — (String)

        The customer-specified identifier used to track this reservation.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the rejectInboundConnection operation

var params = {
  ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.rejectInboundConnection(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: {})
    • ConnectionId — (String)

      The unique identifier of the inbound connection to reject.

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:

      • Connection — (map)

        Contains details about the rejected inbound connection.

        • LocalDomainInfo — (map)

          Information about the source (local) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • RemoteDomainInfo — (map)

          Information about the destination (remote) domain.

          • AWSDomainInformation — (map)

            Information about an Amazon OpenSearch Service domain.

            • OwnerId — (String)

              The Amazon Web Services account ID of the domain owner.

            • DomainNamerequired — (String)

              Name of the domain.

            • Region — (String)

              The Amazon Web Services Region in which the domain is located.

        • ConnectionId — (String)

          The unique identifier of the connection.

        • ConnectionStatus — (map)

          The current status of the connection.

          • StatusCode — (String)

            The status code for the connection. Can be one of the following:

            • PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.

            • APPROVED: Inbound connection is pending acceptance by the remote domain owner.

            • PROVISIONING: Inbound connection is being provisioned.

            • ACTIVE: Inbound connection is active and ready to use.

            • REJECTING: Inbound connection rejection is in process.

            • REJECTED: Inbound connection is rejected.

            • DELETING: Inbound connection deletion is in progress.

            • DELETED: Inbound connection is deleted and can no longer be used.

            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Information about the connection.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the removeTags operation

var params = {
  ARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
opensearch.removeTags(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: {})
    • ARN — (String)

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

    • TagKeys — (Array<String>)

      The list of tag keys to remove from the domain.

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.

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

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Service Reference:

Examples:

Calling the revokeVpcEndpointAccess operation

var params = {
  Account: 'STRING_VALUE', /* required */
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.revokeVpcEndpointAccess(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: {})
    • DomainName — (String)

      The name of the OpenSearch Service domain.

    • Account — (String)

      The account ID to revoke access from.

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.

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

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

Service Reference:

Examples:

Calling the startServiceSoftwareUpdate operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
opensearch.startServiceSoftwareUpdate(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: {})
    • DomainName — (String)

      The name of the domain that you want to update to the latest service software.

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:

      • ServiceSoftwareOptions — (map)

        The current status of the OpenSearch Service software update.

        • CurrentVersion — (String)

          The current service software version present on the domain.

        • NewVersion — (String)

          The new service software version, if one is available.

        • UpdateAvailable — (Boolean)

          True if you're able to update your service software version. False if you can't update your service software version.

        • Cancellable — (Boolean)

          True if you're able to cancel your service software version update. False if you can't cancel your service software update.

        • UpdateStatus — (String)

          The status of your service software update.

          Possible values include:
          • "PENDING_UPDATE"
          • "IN_PROGRESS"
          • "COMPLETED"
          • "NOT_ELIGIBLE"
          • "ELIGIBLE"
        • Description — (String)

          A description of the service software update status.

        • AutomatedUpdateDate — (Date)

          The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.

        • OptionalDeployment — (Boolean)

          True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the updateDomainConfig operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AccessPolicies: 'STRING_VALUE',
  AdvancedOptions: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  AdvancedSecurityOptions: {
    AnonymousAuthEnabled: true || false,
    Enabled: true || false,
    InternalUserDatabaseEnabled: true || false,
    MasterUserOptions: {
      MasterUserARN: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      MasterUserPassword: 'STRING_VALUE'
    },
    SAMLOptions: {
      Enabled: true || false,
      Idp: {
        EntityId: 'STRING_VALUE', /* required */
        MetadataContent: 'STRING_VALUE' /* required */
      },
      MasterBackendRole: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      RolesKey: 'STRING_VALUE',
      SessionTimeoutMinutes: 'NUMBER_VALUE',
      SubjectKey: 'STRING_VALUE'
    }
  },
  AutoTuneOptions: {
    DesiredState: ENABLED | DISABLED,
    MaintenanceSchedules: [
      {
        CronExpressionForRecurrence: 'STRING_VALUE',
        Duration: {
          Unit: HOURS,
          Value: 'NUMBER_VALUE'
        },
        StartAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    RollbackOnDisable: NO_ROLLBACK | DEFAULT_ROLLBACK
  },
  ClusterConfig: {
    ColdStorageOptions: {
      Enabled: true || false /* required */
    },
    DedicatedMasterCount: 'NUMBER_VALUE',
    DedicatedMasterEnabled: true || false,
    DedicatedMasterType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
    InstanceCount: 'NUMBER_VALUE',
    InstanceType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
    WarmCount: 'NUMBER_VALUE',
    WarmEnabled: true || false,
    WarmType: ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search,
    ZoneAwarenessConfig: {
      AvailabilityZoneCount: 'NUMBER_VALUE'
    },
    ZoneAwarenessEnabled: true || false
  },
  CognitoOptions: {
    Enabled: true || false,
    IdentityPoolId: 'STRING_VALUE',
    RoleArn: 'STRING_VALUE',
    UserPoolId: 'STRING_VALUE'
  },
  DomainEndpointOptions: {
    CustomEndpoint: 'STRING_VALUE',
    CustomEndpointCertificateArn: 'STRING_VALUE',
    CustomEndpointEnabled: true || false,
    EnforceHTTPS: true || false,
    TLSSecurityPolicy: Policy-Min-TLS-1-0-2019-07 | Policy-Min-TLS-1-2-2019-07
  },
  DryRun: true || false,
  EBSOptions: {
    EBSEnabled: true || false,
    Iops: 'NUMBER_VALUE',
    Throughput: 'NUMBER_VALUE',
    VolumeSize: 'NUMBER_VALUE',
    VolumeType: standard | gp2 | io1 | gp3
  },
  EncryptionAtRestOptions: {
    Enabled: true || false,
    KmsKeyId: 'STRING_VALUE'
  },
  LogPublishingOptions: {
    '<LogType>': {
      CloudWatchLogsLogGroupArn: 'STRING_VALUE',
      Enabled: true || false
    },
    /* '<LogType>': ... */
  },
  NodeToNodeEncryptionOptions: {
    Enabled: true || false
  },
  SnapshotOptions: {
    AutomatedSnapshotStartHour: 'NUMBER_VALUE'
  },
  VPCOptions: {
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
opensearch.updateDomainConfig(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: {})
    • DomainName — (String)

      The name of the domain that you're updating.

    • ClusterConfig — (map)

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

      • InstanceType — (String)

        Instance type of data nodes in the cluster.

        Possible values include:
        • "m3.medium.search"
        • "m3.large.search"
        • "m3.xlarge.search"
        • "m3.2xlarge.search"
        • "m4.large.search"
        • "m4.xlarge.search"
        • "m4.2xlarge.search"
        • "m4.4xlarge.search"
        • "m4.10xlarge.search"
        • "m5.large.search"
        • "m5.xlarge.search"
        • "m5.2xlarge.search"
        • "m5.4xlarge.search"
        • "m5.12xlarge.search"
        • "m5.24xlarge.search"
        • "r5.large.search"
        • "r5.xlarge.search"
        • "r5.2xlarge.search"
        • "r5.4xlarge.search"
        • "r5.12xlarge.search"
        • "r5.24xlarge.search"
        • "c5.large.search"
        • "c5.xlarge.search"
        • "c5.2xlarge.search"
        • "c5.4xlarge.search"
        • "c5.9xlarge.search"
        • "c5.18xlarge.search"
        • "t3.nano.search"
        • "t3.micro.search"
        • "t3.small.search"
        • "t3.medium.search"
        • "t3.large.search"
        • "t3.xlarge.search"
        • "t3.2xlarge.search"
        • "ultrawarm1.medium.search"
        • "ultrawarm1.large.search"
        • "ultrawarm1.xlarge.search"
        • "t2.micro.search"
        • "t2.small.search"
        • "t2.medium.search"
        • "r3.large.search"
        • "r3.xlarge.search"
        • "r3.2xlarge.search"
        • "r3.4xlarge.search"
        • "r3.8xlarge.search"
        • "i2.xlarge.search"
        • "i2.2xlarge.search"
        • "d2.xlarge.search"
        • "d2.2xlarge.search"
        • "d2.4xlarge.search"
        • "d2.8xlarge.search"
        • "c4.large.search"
        • "c4.xlarge.search"
        • "c4.2xlarge.search"
        • "c4.4xlarge.search"
        • "c4.8xlarge.search"
        • "r4.large.search"
        • "r4.xlarge.search"
        • "r4.2xlarge.search"
        • "r4.4xlarge.search"
        • "r4.8xlarge.search"
        • "r4.16xlarge.search"
        • "i3.large.search"
        • "i3.xlarge.search"
        • "i3.2xlarge.search"
        • "i3.4xlarge.search"
        • "i3.8xlarge.search"
        • "i3.16xlarge.search"
        • "r6g.large.search"
        • "r6g.xlarge.search"
        • "r6g.2xlarge.search"
        • "r6g.4xlarge.search"
        • "r6g.8xlarge.search"
        • "r6g.12xlarge.search"
        • "m6g.large.search"
        • "m6g.xlarge.search"
        • "m6g.2xlarge.search"
        • "m6g.4xlarge.search"
        • "m6g.8xlarge.search"
        • "m6g.12xlarge.search"
        • "c6g.large.search"
        • "c6g.xlarge.search"
        • "c6g.2xlarge.search"
        • "c6g.4xlarge.search"
        • "c6g.8xlarge.search"
        • "c6g.12xlarge.search"
        • "r6gd.large.search"
        • "r6gd.xlarge.search"
        • "r6gd.2xlarge.search"
        • "r6gd.4xlarge.search"
        • "r6gd.8xlarge.search"
        • "r6gd.12xlarge.search"
        • "r6gd.16xlarge.search"
        • "t4g.small.search"
        • "t4g.medium.search"
      • InstanceCount — (Integer)

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • DedicatedMasterEnabled — (Boolean)

        Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

      • ZoneAwarenessEnabled — (Boolean)

        Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

      • ZoneAwarenessConfig — (map)

        Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

        • AvailabilityZoneCount — (Integer)

          If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

      • DedicatedMasterType — (String)

        OpenSearch Service instance type of the dedicated master nodes in the cluster.

        Possible values include:
        • "m3.medium.search"
        • "m3.large.search"
        • "m3.xlarge.search"
        • "m3.2xlarge.search"
        • "m4.large.search"
        • "m4.xlarge.search"
        • "m4.2xlarge.search"
        • "m4.4xlarge.search"
        • "m4.10xlarge.search"
        • "m5.large.search"
        • "m5.xlarge.search"
        • "m5.2xlarge.search"
        • "m5.4xlarge.search"
        • "m5.12xlarge.search"
        • "m5.24xlarge.search"
        • "r5.large.search"
        • "r5.xlarge.search"
        • "r5.2xlarge.search"
        • "r5.4xlarge.search"
        • "r5.12xlarge.search"
        • "r5.24xlarge.search"
        • "c5.large.search"
        • "c5.xlarge.search"
        • "c5.2xlarge.search"
        • "c5.4xlarge.search"
        • "c5.9xlarge.search"
        • "c5.18xlarge.search"
        • "t3.nano.search"
        • "t3.micro.search"
        • "t3.small.search"
        • "t3.medium.search"
        • "t3.large.search"
        • "t3.xlarge.search"
        • "t3.2xlarge.search"
        • "ultrawarm1.medium.search"
        • "ultrawarm1.large.search"
        • "ultrawarm1.xlarge.search"
        • "t2.micro.search"
        • "t2.small.search"
        • "t2.medium.search"
        • "r3.large.search"
        • "r3.xlarge.search"
        • "r3.2xlarge.search"
        • "r3.4xlarge.search"
        • "r3.8xlarge.search"
        • "i2.xlarge.search"
        • "i2.2xlarge.search"
        • "d2.xlarge.search"
        • "d2.2xlarge.search"
        • "d2.4xlarge.search"
        • "d2.8xlarge.search"
        • "c4.large.search"
        • "c4.xlarge.search"
        • "c4.2xlarge.search"
        • "c4.4xlarge.search"
        • "c4.8xlarge.search"
        • "r4.large.search"
        • "r4.xlarge.search"
        • "r4.2xlarge.search"
        • "r4.4xlarge.search"
        • "r4.8xlarge.search"
        • "r4.16xlarge.search"
        • "i3.large.search"
        • "i3.xlarge.search"
        • "i3.2xlarge.search"
        • "i3.4xlarge.search"
        • "i3.8xlarge.search"
        • "i3.16xlarge.search"
        • "r6g.large.search"
        • "r6g.xlarge.search"
        • "r6g.2xlarge.search"
        • "r6g.4xlarge.search"
        • "r6g.8xlarge.search"
        • "r6g.12xlarge.search"
        • "m6g.large.search"
        • "m6g.xlarge.search"
        • "m6g.2xlarge.search"
        • "m6g.4xlarge.search"
        • "m6g.8xlarge.search"
        • "m6g.12xlarge.search"
        • "c6g.large.search"
        • "c6g.xlarge.search"
        • "c6g.2xlarge.search"
        • "c6g.4xlarge.search"
        • "c6g.8xlarge.search"
        • "c6g.12xlarge.search"
        • "r6gd.large.search"
        • "r6gd.xlarge.search"
        • "r6gd.2xlarge.search"
        • "r6gd.4xlarge.search"
        • "r6gd.8xlarge.search"
        • "r6gd.12xlarge.search"
        • "r6gd.16xlarge.search"
        • "t4g.small.search"
        • "t4g.medium.search"
      • DedicatedMasterCount — (Integer)

        Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

      • WarmEnabled — (Boolean)

        Whether to enable warm storage for the cluster.

      • WarmType — (String)

        The instance type for the cluster's warm nodes.

        Possible values include:
        • "ultrawarm1.medium.search"
        • "ultrawarm1.large.search"
        • "ultrawarm1.xlarge.search"
      • WarmCount — (Integer)

        The number of warm nodes in the cluster.

      • ColdStorageOptions — (map)

        Container for cold storage configuration options.

        • Enabledrequired — (Boolean)

          Whether to enable or disable cold storage on the domain.

    • EBSOptions — (map)

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

      • EBSEnabled — (Boolean)

        Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

      • VolumeType — (String)

        Specifies the type of EBS volumes attached to data nodes.

        Possible values include:
        • "standard"
        • "gp2"
        • "io1"
        • "gp3"
      • VolumeSize — (Integer)

        Specifies the size (in GiB) of EBS volumes attached to data nodes.

      • Iops — (Integer)

        Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

      • Throughput — (Integer)

        Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

    • SnapshotOptions — (map)

      Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.

      • AutomatedSnapshotStartHour — (Integer)

        The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

    • VPCOptions — (map)

      Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

      • SubnetIds — (Array<String>)

        A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

      • SecurityGroupIds — (Array<String>)

        The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

    • CognitoOptions — (map)

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

      • Enabled — (Boolean)

        Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

      • UserPoolId — (String)

        The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • IdentityPoolId — (String)

        The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

      • RoleArn — (String)

        The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

    • AdvancedOptions — (map<String>)

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

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

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

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

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

      For more information, see Advanced cluster parameters.

    • AccessPolicies — (String)

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

    • LogPublishingOptions — (map<map>)

      Options to publish OpenSearch lots to Amazon CloudWatch Logs.

      • CloudWatchLogsLogGroupArn — (String)

        The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

      • Enabled — (Boolean)

        Whether the log should be published.

    • EncryptionAtRestOptions — (map)

      Encryption at rest options for the domain.

      • Enabled — (Boolean)

        True to enable encryption at rest.

      • KmsKeyId — (String)

        The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

    • DomainEndpointOptions — (map)

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

      • EnforceHTTPS — (Boolean)

        True to require that all traffic to the domain arrive over HTTPS.

      • TLSSecurityPolicy — (String)

        Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

        Can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

        Possible values include:
        • "Policy-Min-TLS-1-0-2019-07"
        • "Policy-Min-TLS-1-2-2019-07"
      • CustomEndpointEnabled — (Boolean)

        Whether to enable a custom endpoint for the domain.

      • CustomEndpoint — (String)

        The fully qualified URL for the custom endpoint.

      • CustomEndpointCertificateArn — (String)

        The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

    • NodeToNodeEncryptionOptions — (map)

      Node-To-Node Encryption options for the domain.

      • Enabled — (Boolean)

        True to enable node-to-node encryption.

    • AdvancedSecurityOptions — (map)

      Options for fine-grained access control.

      • Enabled — (Boolean)

        True to enable fine-grained access control.

      • InternalUserDatabaseEnabled — (Boolean)

        True to enable the internal user database.

      • MasterUserOptions — (map)

        Container for information about the master user.

        • MasterUserARN — (String)

          Amazon Resource Name (ARN) for the master user. Only specify if InternalUserDatabaseEnabled is false.

        • MasterUserName — (String)

          User name for the master user. Only specify if InternalUserDatabaseEnabled is true.

        • MasterUserPassword — (String)

          Password for the master user. Only specify if InternalUserDatabaseEnabled is true.

      • SAMLOptions — (map)

        Container for information about the SAML configuration for OpenSearch Dashboards.

        • Enabled — (Boolean)

          True to enable SAML authentication for a domain.

        • Idp — (map)

          The SAML Identity Provider's information.

          • MetadataContentrequired — (String)

            The metadata of the SAML application, in XML format.

          • EntityIdrequired — (String)

            The unique entity ID of the application in the SAML identity provider.

        • MasterUserName — (String)

          The SAML master user name, which is stored in the domain's internal user database.

        • MasterBackendRole — (String)

          The backend role that the SAML master user is mapped to.

        • SubjectKey — (String)

          Element of the SAML assertion to use for the user name. Default is NameID.

        • RolesKey — (String)

          Element of the SAML assertion to use for backend roles. Default is roles.

        • SessionTimeoutMinutes — (Integer)

          The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.

      • AnonymousAuthEnabled — (Boolean)

        True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

    • AutoTuneOptions — (map)

      Options for Auto-Tune.

      • DesiredState — (String)

        Whether Auto-Tune is enabled or disabled.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • RollbackOnDisable — (String)

        When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

        Possible values include:
        • "NO_ROLLBACK"
        • "DEFAULT_ROLLBACK"
      • MaintenanceSchedules — (Array<map>)

        A list of maintenance schedules during which Auto-Tune can deploy changes.

        • StartAt — (Date)

          The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

        • Duration — (map)

          The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

          • Value — (Integer)

            Integer to specify the value of a maintenance schedule duration.

          • Unit — (String)

            The unit of measurement for the duration of a maintenance schedule.

            Possible values include:
            • "HOURS"
        • CronExpressionForRecurrence — (String)

          A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

    • DryRun — (Boolean)

      This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation check without actually applying the change.

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:

      • DomainConfig — (map)

        The status of the updated domain.

        • EngineVersion — (map)

          The OpenSearch or Elasticsearch version that the domain is running.

          • Optionsrequired — (String)

            The OpenSearch or Elasticsearch version for the specified domain.

          • Statusrequired — (map)

            The status of the version options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • ClusterConfig — (map)

          Container for the cluster configuration of a the domain.

          • Optionsrequired — (map)

            Cluster configuration options for the specified domain.

            • InstanceType — (String)

              Instance type of data nodes in the cluster.

              Possible values include:
              • "m3.medium.search"
              • "m3.large.search"
              • "m3.xlarge.search"
              • "m3.2xlarge.search"
              • "m4.large.search"
              • "m4.xlarge.search"
              • "m4.2xlarge.search"
              • "m4.4xlarge.search"
              • "m4.10xlarge.search"
              • "m5.large.search"
              • "m5.xlarge.search"
              • "m5.2xlarge.search"
              • "m5.4xlarge.search"
              • "m5.12xlarge.search"
              • "m5.24xlarge.search"
              • "r5.large.search"
              • "r5.xlarge.search"
              • "r5.2xlarge.search"
              • "r5.4xlarge.search"
              • "r5.12xlarge.search"
              • "r5.24xlarge.search"
              • "c5.large.search"
              • "c5.xlarge.search"
              • "c5.2xlarge.search"
              • "c5.4xlarge.search"
              • "c5.9xlarge.search"
              • "c5.18xlarge.search"
              • "t3.nano.search"
              • "t3.micro.search"
              • "t3.small.search"
              • "t3.medium.search"
              • "t3.large.search"
              • "t3.xlarge.search"
              • "t3.2xlarge.search"
              • "ultrawarm1.medium.search"
              • "ultrawarm1.large.search"
              • "ultrawarm1.xlarge.search"
              • "t2.micro.search"
              • "t2.small.search"
              • "t2.medium.search"
              • "r3.large.search"
              • "r3.xlarge.search"
              • "r3.2xlarge.search"
              • "r3.4xlarge.search"
              • "r3.8xlarge.search"
              • "i2.xlarge.search"
              • "i2.2xlarge.search"
              • "d2.xlarge.search"
              • "d2.2xlarge.search"
              • "d2.4xlarge.search"
              • "d2.8xlarge.search"
              • "c4.large.search"
              • "c4.xlarge.search"
              • "c4.2xlarge.search"
              • "c4.4xlarge.search"
              • "c4.8xlarge.search"
              • "r4.large.search"
              • "r4.xlarge.search"
              • "r4.2xlarge.search"
              • "r4.4xlarge.search"
              • "r4.8xlarge.search"
              • "r4.16xlarge.search"
              • "i3.large.search"
              • "i3.xlarge.search"
              • "i3.2xlarge.search"
              • "i3.4xlarge.search"
              • "i3.8xlarge.search"
              • "i3.16xlarge.search"
              • "r6g.large.search"
              • "r6g.xlarge.search"
              • "r6g.2xlarge.search"
              • "r6g.4xlarge.search"
              • "r6g.8xlarge.search"
              • "r6g.12xlarge.search"
              • "m6g.large.search"
              • "m6g.xlarge.search"
              • "m6g.2xlarge.search"
              • "m6g.4xlarge.search"
              • "m6g.8xlarge.search"
              • "m6g.12xlarge.search"
              • "c6g.large.search"
              • "c6g.xlarge.search"
              • "c6g.2xlarge.search"
              • "c6g.4xlarge.search"
              • "c6g.8xlarge.search"
              • "c6g.12xlarge.search"
              • "r6gd.large.search"
              • "r6gd.xlarge.search"
              • "r6gd.2xlarge.search"
              • "r6gd.4xlarge.search"
              • "r6gd.8xlarge.search"
              • "r6gd.12xlarge.search"
              • "r6gd.16xlarge.search"
              • "t4g.small.search"
              • "t4g.medium.search"
            • InstanceCount — (Integer)

              Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

            • DedicatedMasterEnabled — (Boolean)

              Indicates whether dedicated master nodes are enabled for the cluster.True if the cluster will use a dedicated master node.False if the cluster will not.

            • ZoneAwarenessEnabled — (Boolean)

              Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.

            • ZoneAwarenessConfig — (map)

              Container for zone awareness configuration options. Only required if ZoneAwarenessEnabled is true.

              • AvailabilityZoneCount — (Integer)

                If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are 2 and 3. If your domain is provisioned within a VPC, this value be equal to number of subnets.

            • DedicatedMasterType — (String)

              OpenSearch Service instance type of the dedicated master nodes in the cluster.

              Possible values include:
              • "m3.medium.search"
              • "m3.large.search"
              • "m3.xlarge.search"
              • "m3.2xlarge.search"
              • "m4.large.search"
              • "m4.xlarge.search"
              • "m4.2xlarge.search"
              • "m4.4xlarge.search"
              • "m4.10xlarge.search"
              • "m5.large.search"
              • "m5.xlarge.search"
              • "m5.2xlarge.search"
              • "m5.4xlarge.search"
              • "m5.12xlarge.search"
              • "m5.24xlarge.search"
              • "r5.large.search"
              • "r5.xlarge.search"
              • "r5.2xlarge.search"
              • "r5.4xlarge.search"
              • "r5.12xlarge.search"
              • "r5.24xlarge.search"
              • "c5.large.search"
              • "c5.xlarge.search"
              • "c5.2xlarge.search"
              • "c5.4xlarge.search"
              • "c5.9xlarge.search"
              • "c5.18xlarge.search"
              • "t3.nano.search"
              • "t3.micro.search"
              • "t3.small.search"
              • "t3.medium.search"
              • "t3.large.search"
              • "t3.xlarge.search"
              • "t3.2xlarge.search"
              • "ultrawarm1.medium.search"
              • "ultrawarm1.large.search"
              • "ultrawarm1.xlarge.search"
              • "t2.micro.search"
              • "t2.small.search"
              • "t2.medium.search"
              • "r3.large.search"
              • "r3.xlarge.search"
              • "r3.2xlarge.search"
              • "r3.4xlarge.search"
              • "r3.8xlarge.search"
              • "i2.xlarge.search"
              • "i2.2xlarge.search"
              • "d2.xlarge.search"
              • "d2.2xlarge.search"
              • "d2.4xlarge.search"
              • "d2.8xlarge.search"
              • "c4.large.search"
              • "c4.xlarge.search"
              • "c4.2xlarge.search"
              • "c4.4xlarge.search"
              • "c4.8xlarge.search"
              • "r4.large.search"
              • "r4.xlarge.search"
              • "r4.2xlarge.search"
              • "r4.4xlarge.search"
              • "r4.8xlarge.search"
              • "r4.16xlarge.search"
              • "i3.large.search"
              • "i3.xlarge.search"
              • "i3.2xlarge.search"
              • "i3.4xlarge.search"
              • "i3.8xlarge.search"
              • "i3.16xlarge.search"
              • "r6g.large.search"
              • "r6g.xlarge.search"
              • "r6g.2xlarge.search"
              • "r6g.4xlarge.search"
              • "r6g.8xlarge.search"
              • "r6g.12xlarge.search"
              • "m6g.large.search"
              • "m6g.xlarge.search"
              • "m6g.2xlarge.search"
              • "m6g.4xlarge.search"
              • "m6g.8xlarge.search"
              • "m6g.12xlarge.search"
              • "c6g.large.search"
              • "c6g.xlarge.search"
              • "c6g.2xlarge.search"
              • "c6g.4xlarge.search"
              • "c6g.8xlarge.search"
              • "c6g.12xlarge.search"
              • "r6gd.large.search"
              • "r6gd.xlarge.search"
              • "r6gd.2xlarge.search"
              • "r6gd.4xlarge.search"
              • "r6gd.8xlarge.search"
              • "r6gd.12xlarge.search"
              • "r6gd.16xlarge.search"
              • "t4g.small.search"
              • "t4g.medium.search"
            • DedicatedMasterCount — (Integer)

              Number of dedicated master nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.

            • WarmEnabled — (Boolean)

              Whether to enable warm storage for the cluster.

            • WarmType — (String)

              The instance type for the cluster's warm nodes.

              Possible values include:
              • "ultrawarm1.medium.search"
              • "ultrawarm1.large.search"
              • "ultrawarm1.xlarge.search"
            • WarmCount — (Integer)

              The number of warm nodes in the cluster.

            • ColdStorageOptions — (map)

              Container for cold storage configuration options.

              • Enabledrequired — (Boolean)

                Whether to enable or disable cold storage on the domain.

          • Statusrequired — (map)

            The status of cluster configuration options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • EBSOptions — (map)

          Container for EBS options configured for an OpenSearch Service domain.

          • Optionsrequired — (map)

            The configured EBS options for the specified domain.

            • EBSEnabled — (Boolean)

              Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.

            • VolumeType — (String)

              Specifies the type of EBS volumes attached to data nodes.

              Possible values include:
              • "standard"
              • "gp2"
              • "io1"
              • "gp3"
            • VolumeSize — (Integer)

              Specifies the size (in GiB) of EBS volumes attached to data nodes.

            • Iops — (Integer)

              Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the gp3 and provisioned IOPS EBS volume types.

            • Throughput — (Integer)

              Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the gp3 volume type.

          • Statusrequired — (map)

            The status of the EBS options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AccessPolicies — (map)

          Specifies the access policies for the domain.

          • Optionsrequired — (String)

            The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.

          • Statusrequired — (map)

            The status of the access policy for the domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • SnapshotOptions — (map)

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

          • Optionsrequired — (map)

            The daily snapshot options specified for the domain.

            • AutomatedSnapshotStartHour — (Integer)

              The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is 0 hours.

          • Statusrequired — (map)

            The status of a daily automated snapshot.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • VPCOptions — (map)

          The current VPC options for the domain and the status of any updates to their configuration.

          • Optionsrequired — (map)

            The VPC options for the specified domain.

            • VPCId — (String)

              The ID for your VPC. Amazon VPC generates this value when you create a VPC.

            • SubnetIds — (Array<String>)

              A list of subnet IDs associated with the VPC endpoints for the domain.

            • AvailabilityZones — (Array<String>)

              The list of Availability Zones associated with the VPC subnets.

            • SecurityGroupIds — (Array<String>)

              The list of security group IDs associated with the VPC endpoints for the domain.

          • Statusrequired — (map)

            The status of the VPC options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • CognitoOptions — (map)

          Container for Amazon Cognito options for the domain.

          • Optionsrequired — (map)

            Cognito options for the specified domain.

            • Enabled — (Boolean)

              Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.

            • UserPoolId — (String)

              The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

            • IdentityPoolId — (String)

              The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.

            • RoleArn — (String)

              The AmazonOpenSearchServiceCognitoAccess role that allows OpenSearch Service to configure your user pool and identity pool.

          • Statusrequired — (map)

            The status of the Cognito options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • EncryptionAtRestOptions — (map)

          Key-value pairs to enable encryption at rest.

          • Optionsrequired — (map)

            Encryption at rest options for the specified domain.

            • Enabled — (Boolean)

              True to enable encryption at rest.

            • KmsKeyId — (String)

              The KMS key ID. Takes the form 1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a.

          • Statusrequired — (map)

            The status of the encryption at rest options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • NodeToNodeEncryptionOptions — (map)

          Whether node-to-node encryption is enabled or disabled.

          • Optionsrequired — (map)

            The node-to-node encryption options for the specified domain.

            • Enabled — (Boolean)

              True to enable node-to-node encryption.

          • Statusrequired — (map)

            The status of the node-to-node encryption options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AdvancedOptions — (map)

          Key-value pairs to specify advanced configuration options. For more information, see Advanced options.

          • Optionsrequired — (map<String>)

            The status of advanced options for the specified domain.

          • Statusrequired — (map)

            The status of advanced options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • LogPublishingOptions — (map)

          Key-value pairs to configure slow log publishing.

          • Options — (map<map>)

            The log publishing options configured for the domain.

            • CloudWatchLogsLogGroupArn — (String)

              The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.

            • Enabled — (Boolean)

              Whether the log should be published.

          • Status — (map)

            The status of the log publishing options for the domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • DomainEndpointOptions — (map)

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

          • Optionsrequired — (map)

            Options to configure the endpoint for a domain.

            • EnforceHTTPS — (Boolean)

              True to require that all traffic to the domain arrive over HTTPS.

            • TLSSecurityPolicy — (String)

              Specify the TLS security policy to apply to the HTTPS endpoint of the domain.

              Can be one of the following values:

              • Policy-Min-TLS-1-0-2019-07: TLS security policy which supports TLS version 1.0 and higher.

              • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLS version 1.2

              Possible values include:
              • "Policy-Min-TLS-1-0-2019-07"
              • "Policy-Min-TLS-1-2-2019-07"
            • CustomEndpointEnabled — (Boolean)

              Whether to enable a custom endpoint for the domain.

            • CustomEndpoint — (String)

              The fully qualified URL for the custom endpoint.

            • CustomEndpointCertificateArn — (String)

              The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).

          • Statusrequired — (map)

            The status of the endpoint options for a domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AdvancedSecurityOptions — (map)

          Container for fine-grained access control settings for the domain.

          • Optionsrequired — (map)

            Container for fine-grained access control settings.

            • Enabled — (Boolean)

              True if fine-grained access control is enabled.

            • InternalUserDatabaseEnabled — (Boolean)

              True if the internal user database is enabled.

            • SAMLOptions — (map)

              Container for information about the SAML configuration for OpenSearch Dashboards.

              • Enabled — (Boolean)

                True if SAML is enabled.

              • Idp — (map)

                Describes the SAML identity provider's information.

                • MetadataContentrequired — (String)

                  The metadata of the SAML application, in XML format.

                • EntityIdrequired — (String)

                  The unique entity ID of the application in the SAML identity provider.

              • SubjectKey — (String)

                The key used for matching the SAML subject attribute.

              • RolesKey — (String)

                The key used for matching the SAML roles attribute.

              • SessionTimeoutMinutes — (Integer)

                The duration, in minutes, after which a user session becomes inactive.

            • AnonymousAuthDisableDate — (Date)

              Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.

            • AnonymousAuthEnabled — (Boolean)

              True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.

          • Statusrequired — (map)

            Status of the fine-grained access control settings for a domain.

            • CreationDaterequired — (Date)

              The timestamp when the entity was created.

            • UpdateDaterequired — (Date)

              The timestamp of the last time the entity was updated.

            • UpdateVersion — (Integer)

              The latest version of the entity.

            • Staterequired — (String)

              The state of the entity.

              Possible values include:
              • "RequiresIndexDocuments"
              • "Processing"
              • "Active"
            • PendingDeletion — (Boolean)

              Indicates whether the entity is being deleted.

        • AutoTuneOptions — (map)

          Container for Auto-Tune settings for the domain.

          • Options — (map)

            Auto-Tune settings for updating a domain.

            • DesiredState — (String)

              Whether Auto-Tune is enabled or disabled.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
            • RollbackOnDisable — (String)

              When disabling Auto-Tune, specify NO_ROLLBACK to retain all prior Auto-Tune settings or DEFAULT_ROLLBACK to revert to the OpenSearch Service defaults. If you specify DEFAULT_ROLLBACK, you must include a MaintenanceSchedule in the request. Otherwise, OpenSearch Service is unable to perform the rollback.

              Possible values include:
              • "NO_ROLLBACK"
              • "DEFAULT_ROLLBACK"
            • MaintenanceSchedules — (Array<map>)

              A list of maintenance schedules during which Auto-Tune can deploy changes.

              • StartAt — (Date)

                The Epoch timestamp at which the Auto-Tune maintenance schedule starts.

              • Duration — (map)

                The duration of the maintenance schedule. For example, "Duration": {"Value": 2, "Unit": "HOURS"}.

                • Value — (Integer)

                  Integer to specify the value of a maintenance schedule duration.

                • Unit — (String)

                  The unit of measurement for the duration of a maintenance schedule.

                  Possible values include:
                  • "HOURS"
              • CronExpressionForRecurrence — (String)

                A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.

          • Status — (map)

            The current status of Auto-Tune for a domain.

            • CreationDaterequired — (Date)

              Date and time when Auto-Tune was enabled for the domain.

            • UpdateDaterequired — (Date)

              Date and time when the Auto-Tune options were last updated for the domain.

            • UpdateVersion — (Integer)

              The latest version of the Auto-Tune options.

            • Staterequired — (String)

              The current state of Auto-Tune on the domain.

              Possible values include:
              • "ENABLED"
              • "DISABLED"
              • "ENABLE_IN_PROGRESS"
              • "DISABLE_IN_PROGRESS"
              • "DISABLED_AND_ROLLBACK_SCHEDULED"
              • "DISABLED_AND_ROLLBACK_IN_PROGRESS"
              • "DISABLED_AND_ROLLBACK_COMPLETE"
              • "DISABLED_AND_ROLLBACK_ERROR"
              • "ERROR"
            • ErrorMessage — (String)

              Any errors that occurred while enabling or disabling Auto-Tune.

            • PendingDeletion — (Boolean)

              Indicates whether the domain is being deleted.

        • ChangeProgressDetails — (map)

          Container for information about the progress of an existing configuration change.

          • ChangeId — (String)

            The ID of the configuration change.

          • Message — (String)

            A message corresponding to the status of the configuration change.

      • DryRunResults — (map)

        Results of a dry run performed in an update domain request.

        • DeploymentType — (String)

          Specifies the way in which OpenSearch Service will apply an update. Possible values are:

          • Blue/Green - The update requires a blue/green deployment.

          • DynamicUpdate - No blue/green deployment required

          • Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.

          • None - The request doesn't include any configuration changes.

        • Message — (String)

          A message corresponding to the deployment type.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the updatePackage operation

var params = {
  PackageID: 'STRING_VALUE', /* required */
  PackageSource: { /* required */
    S3BucketName: 'STRING_VALUE',
    S3Key: 'STRING_VALUE'
  },
  CommitMessage: 'STRING_VALUE',
  PackageDescription: 'STRING_VALUE'
};
opensearch.updatePackage(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: {})
    • PackageID — (String)

      The unique identifier for the package.

    • PackageSource — (map)

      Amazon S3 bucket and key for the package.

      • S3BucketName — (String)

        The name of the Amazon S3 bucket containing the package.

      • S3Key — (String)

        Key (file name) of the package.

    • PackageDescription — (String)

      A new description of the package.

    • CommitMessage — (String)

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

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:

      • PackageDetails — (map)

        Information about a package.

        • PackageID — (String)

          The unique identifier of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          The type of package.

          Possible values include:
          • "TXT-DICTIONARY"
        • PackageDescription — (String)

          User-specified description of the package.

        • PackageStatus — (String)

          Current status of the package.

          Possible values include:
          • "COPYING"
          • "COPY_FAILED"
          • "VALIDATING"
          • "VALIDATION_FAILED"
          • "AVAILABLE"
          • "DELETING"
          • "DELETED"
          • "DELETE_FAILED"
        • CreatedAt — (Date)

          The timestamp when the package was created.

        • LastUpdatedAt — (Date)

          Date and time when the package was last updated.

        • AvailablePackageVersion — (String)

          The package version.

        • ErrorDetails — (map)

          Additional information if the package is in an error state. Null otherwise.

          • ErrorType — (String)

            The type of error that occurred.

          • ErrorMessage — (String)

            A message describing the error.

Returns:

  • (AWS.Request)

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

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

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Service Reference:

Examples:

Calling the updateVpcEndpoint operation

var params = {
  VpcEndpointId: 'STRING_VALUE', /* required */
  VpcOptions: { /* required */
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
opensearch.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: {})
    • VpcEndpointId — (String)

      The unique identifier of the endpoint.

    • VpcOptions — (map)

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

      • SubnetIds — (Array<String>)

        A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.

      • SecurityGroupIds — (Array<String>)

        The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.

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:

      • VpcEndpoint — (map)

        The endpoint to be updated.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

          The Amazon Resource Name (ARN) of the domain associated with the endpoint.

        • VpcOptions — (map)

          Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.

          • VPCId — (String)

            The ID for your VPC. Amazon VPC generates this value when you create a VPC.

          • SubnetIds — (Array<String>)

            A list of subnet IDs associated with the VPC endpoints for the domain.

          • AvailabilityZones — (Array<String>)

            The list of Availability Zones associated with the VPC subnets.

          • SecurityGroupIds — (Array<String>)

            The list of security group IDs associated with the VPC endpoints for the domain.

        • Status — (String)

          The current status of the endpoint.

          Possible values include:
          • "CREATING"
          • "CREATE_FAILED"
          • "ACTIVE"
          • "UPDATING"
          • "UPDATE_FAILED"
          • "DELETING"
          • "DELETE_FAILED"
        • Endpoint — (String)

          The connection endpoint ID for connecting to the domain.

Returns:

  • (AWS.Request)

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

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

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

Service Reference:

Examples:

Calling the upgradeDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  TargetVersion: 'STRING_VALUE', /* required */
  AdvancedOptions: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  PerformCheckOnly: true || false
};
opensearch.upgradeDomain(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: {})
    • DomainName — (String)

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

    • TargetVersion — (String)

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

    • PerformCheckOnly — (Boolean)

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

    • AdvancedOptions — (map<String>)

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

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:

      • UpgradeId — (String)

        The unique identifier of the domain upgrade.

      • DomainName — (String)

        The name of the domain that was upgraded.

      • TargetVersion — (String)

        OpenSearch or Elasticsearch version that the domain was upgraded to.

      • PerformCheckOnly — (Boolean)

        When true, indicates that an upgrade eligibility check was performed.

      • AdvancedOptions — (map<String>)

        The advanced options configuration for the domain.

      • ChangeProgressDetails — (map)

        Container for information about a configuration change happening on a domain.

        • ChangeId — (String)

          The ID of the configuration change.

        • Message — (String)

          A message corresponding to the status of the configuration change.

Returns:

  • (AWS.Request)

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