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 configuration API to create, configure, and manage Amazon 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 Regions and 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 remote domain owner to accept an inbound cross-cluster connection request.

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 you want 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)

        The InboundConnection of the accepted inbound connection.

        • LocalDomainInfo — (map)

          The AWSDomainInformation for the local OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • RemoteDomainInfo — (map)

          The AWSDomainInformation for the remote OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • ConnectionId — (String)

          The connection ID for the inbound cross-cluster connection.

        • ConnectionStatus — (map)

          The InboundConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for the inbound 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 provisioning is in progress.
            • 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)

            Verbose information for the inbound connection status.

Returns:

  • (AWS.Request)

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

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

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

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)

      Specify the ARN of the domain you want to add tags to.

    • TagList — (Array<map>)

      List of Tag to add to the domain.

      • Keyrequired — (String)

        The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.

      • Valuerequired — (String)

        The TagValue, 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.

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)

      The 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)

        DomainPackageDetails

        • PackageID — (String)

          The internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          The timestamp of the most recent update to the package association status.

        • DomainName — (String)

          The name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

          State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

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

          The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)

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 UpdateStatus is in the PENDING_UPDATE state.

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)

      The name of the domain that you want to stop the latest 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)

        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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

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

          The description of the UpdateStatus.

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

Returns:

  • (AWS.Request)

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

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

Creates a new Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains in the Amazon OpenSearch Service Developer Guide.

Service Reference:

Examples:

Calling the createDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AccessPolicies: 'STRING_VALUE',
  AdvancedOptions: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  AdvancedSecurityOptions: {
    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',
    VolumeSize: 'NUMBER_VALUE',
    VolumeType: standard | gp2 | io1
  },
  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)

      The name of the Amazon OpenSearch Service domain you're creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • EngineVersion — (String)

      String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the Amazon 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)

      Configuration options for a domain. Specifies the instance type and number of instances in the domain.

      • InstanceType — (String)

        The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

        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)

        The number of instances in the specified domain cluster.

      • DedicatedMasterEnabled — (Boolean)

        A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

      • ZoneAwarenessEnabled — (Boolean)

        A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

      • ZoneAwarenessConfig — (map)

        The zone awareness configuration for a domain when zone awareness is enabled.

        • AvailabilityZoneCount — (Integer)

          An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

      • DedicatedMasterType — (String)

        The instance type for a dedicated master node.

        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)

        Total number of dedicated master nodes, active and on standby, for the cluster.

      • WarmEnabled — (Boolean)

        True to enable UltraWarm storage.

      • WarmType — (String)

        The instance type for the OpenSearch cluster's warm nodes.

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

        The number of UltraWarm nodes in the cluster.

      • ColdStorageOptions — (map)

        Specifies the ColdStorageOptions config for a Domain

        • Enabledrequired — (Boolean)

          Enable cold storage option. Accepted values true or false

    • EBSOptions — (map)

      Options to enable, disable, and specify the type and size of EBS storage volumes.

      • EBSEnabled — (Boolean)

        Whether EBS-based storage is enabled.

      • VolumeType — (String)

        The volume type for EBS-based storage.

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

        Integer to specify the size of an EBS volume.

      • Iops — (Integer)

        The IOPD for a Provisioned IOPS EBS volume (SSD).

    • AccessPolicies — (String)

      IAM access policy as a JSON-formatted string.

    • SnapshotOptions — (map)

      Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

      • AutomatedSnapshotStartHour — (Integer)

        The time, in UTC format, when the 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>)

        The subnets for the VPC endpoint.

      • SecurityGroupIds — (Array<String>)

        The security groups for the VPC endpoint.

    • CognitoOptions — (map)

      Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

      • Enabled — (Boolean)

        The option to enable Cognito for OpenSearch Dashboards authentication.

      • UserPoolId — (String)

        The Cognito user pool ID for OpenSearch Dashboards authentication.

      • IdentityPoolId — (String)

        The Cognito identity pool ID for OpenSearch Dashboards authentication.

      • RoleArn — (String)

        The role ARN that provides OpenSearch permissions for accessing Cognito resources.

    • EncryptionAtRestOptions — (map)

      Options for encryption of data at rest.

      • Enabled — (Boolean)

        The option to enable encryption at rest.

      • KmsKeyId — (String)

        The KMS key ID for encryption at rest options.

    • NodeToNodeEncryptionOptions — (map)

      Node-to-node encryption options.

      • Enabled — (Boolean)

        True to enable node-to-node encryption.

    • AdvancedOptions — (map<String>)

      Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.

    • LogPublishingOptions — (map<map>)

      Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

      • CloudWatchLogsLogGroupArn — (String)

        ARN of the Cloudwatch log group to publish logs to.

      • Enabled — (Boolean)

        Whether the given log publishing option is enabled or not.

    • DomainEndpointOptions — (map)

      Options to specify configurations that will be applied to the domain endpoint.

      • EnforceHTTPS — (Boolean)

        Whether only HTTPS endpoint should be enabled for the domain.

      • 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 TLSv1.0 and higher.
        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

      • CustomEndpointCertificateArn — (String)

        The ACM certificate ARN for your custom endpoint.

    • AdvancedSecurityOptions — (map)

      Specifies advanced security options.

      • Enabled — (Boolean)

        True if advanced security is enabled.

      • InternalUserDatabaseEnabled — (Boolean)

        True if the internal user database is enabled.

      • MasterUserOptions — (map)

        Credentials for the master user: username and password, ARN, or both.

        • MasterUserARN — (String)

          ARN for the master user (if IAM is enabled).

        • MasterUserName — (String)

          The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.

        • MasterUserPassword — (String)

          The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.

      • SAMLOptions — (map)

        The SAML application configuration for the domain.

        • Enabled — (Boolean)

          True if SAML is enabled.

        • 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 SAML identity provider.

        • MasterUserName — (String)

          The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.

        • MasterBackendRole — (String)

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

        • SubjectKey — (String)

          Element of the SAML assertion to use for username. 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.

    • TagList — (Array<map>)

      A list of Tag added during domain creation.

      • Keyrequired — (String)

        The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.

      • Valuerequired — (String)

        The TagValue, 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)

      Specifies Auto-Tune options.

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)

          The unique identifier for the specified domain.

        • DomainNamerequired — (String)

          The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          The domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

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

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

        • EngineVersion — (String)
        • ClusterConfigrequired — (map)

          The type and number of instances in the domain.

          • InstanceType — (String)

            The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

            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)

            The number of instances in the specified domain cluster.

          • DedicatedMasterEnabled — (Boolean)

            A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

          • ZoneAwarenessConfig — (map)

            The zone awareness configuration for a domain when zone awareness is enabled.

            • AvailabilityZoneCount — (Integer)

              An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

          • DedicatedMasterType — (String)

            The instance type for a dedicated master node.

            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)

            Total number of dedicated master nodes, active and on standby, for the cluster.

          • WarmEnabled — (Boolean)

            True to enable UltraWarm storage.

          • WarmType — (String)

            The instance type for the OpenSearch cluster's warm nodes.

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

            The number of UltraWarm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for a Domain

            • Enabledrequired — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain.

          • EBSEnabled — (Boolean)

            Whether EBS-based storage is enabled.

          • VolumeType — (String)

            The volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            The IOPD for a Provisioned IOPS EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          The status of the SnapshotOptions.

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

          • VPCId — (String)

            The VPC ID for the domain. Exists only if the domain was created with VPCOptions.

          • SubnetIds — (Array<String>)

            The subnets for the VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            The security groups for the VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

          • Enabled — (Boolean)

            The option to enable Cognito for OpenSearch Dashboards authentication.

          • UserPoolId — (String)

            The Cognito user pool ID for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Cognito identity pool ID for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The role ARN that provides OpenSearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          The status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            The option to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID for encryption at rest options.

        • NodeToNodeEncryptionOptions — (map)

          The status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          The status of the AdvancedOptions.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to publish logs to.

          • Enabled — (Boolean)

            Whether the given log publishing option is enabled or not.

        • 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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

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

            The description of the UpdateStatus.

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

        • DomainEndpointOptions — (map)

          The current status of the domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Whether only HTTPS endpoint should be enabled for the domain.

          • 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 TLSv1.0 and higher.
            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

          The current status of the domain's advanced security options.

          • Enabled — (Boolean)

            True if advanced security is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Describes the SAML application configured for a domain.

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

        • AutoTuneOptions — (map)

          The current status of the domain's Auto-Tune options.

          • State — (String)

            The AutoTuneState for 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)

            The error message while enabling or disabling Auto-Tune.

Returns:

  • (AWS.Request)

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

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

Creates a new cross-cluster connection from a local OpenSearch domain to a remote OpenSearch domain.

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)

      The AWSDomainInformation for the local OpenSearch domain.

      • AWSDomainInformation — (map)
        • OwnerId — (String)
        • DomainNamerequired — (String)

          The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • Region — (String)
    • RemoteDomainInfo — (map)

      The AWSDomainInformation for the remote OpenSearch domain.

      • AWSDomainInformation — (map)
        • OwnerId — (String)
        • DomainNamerequired — (String)

          The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • Region — (String)
    • ConnectionAlias — (String)

      The connection alias used used by the customer for this cross-cluster 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)

        The AWSDomainInformation for the local OpenSearch domain.

        • AWSDomainInformation — (map)
          • OwnerId — (String)
          • DomainNamerequired — (String)

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region — (String)
      • RemoteDomainInfo — (map)

        The AWSDomainInformation for the remote OpenSearch domain.

        • AWSDomainInformation — (map)
          • OwnerId — (String)
          • DomainNamerequired — (String)

            The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

          • Region — (String)
      • ConnectionAlias — (String)

        The connection alias provided during the create connection request.

      • ConnectionStatus — (map)

        The OutboundConnectionStatus for the newly created connection.

        • StatusCode — (String)

          The state 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 status.

      • ConnectionId — (String)

        The unique ID 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

Create a package for use with Amazon OpenSearch Service domains.

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 identifier for the package.

    • PackageType — (String)

      Type of package. Currently supports only TXT-DICTIONARY.

      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)

        Information about the package.

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          User-specified description of the package.

        • PackageStatus — (String)

          Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

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

          The timestamp of when the package was created.

        • LastUpdatedAt — (Date)
        • AvailablePackageVersion — (String)
        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)

Returns:

  • (AWS.Request)

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

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

Permanently deletes the specified domain and all of its data. Once a domain is deleted, it cannot be recovered.

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)

          The unique identifier for the specified domain.

        • DomainNamerequired — (String)

          The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          The domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

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

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

        • EngineVersion — (String)
        • ClusterConfigrequired — (map)

          The type and number of instances in the domain.

          • InstanceType — (String)

            The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

            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)

            The number of instances in the specified domain cluster.

          • DedicatedMasterEnabled — (Boolean)

            A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

          • ZoneAwarenessConfig — (map)

            The zone awareness configuration for a domain when zone awareness is enabled.

            • AvailabilityZoneCount — (Integer)

              An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

          • DedicatedMasterType — (String)

            The instance type for a dedicated master node.

            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)

            Total number of dedicated master nodes, active and on standby, for the cluster.

          • WarmEnabled — (Boolean)

            True to enable UltraWarm storage.

          • WarmType — (String)

            The instance type for the OpenSearch cluster's warm nodes.

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

            The number of UltraWarm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for a Domain

            • Enabledrequired — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain.

          • EBSEnabled — (Boolean)

            Whether EBS-based storage is enabled.

          • VolumeType — (String)

            The volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            The IOPD for a Provisioned IOPS EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          The status of the SnapshotOptions.

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

          • VPCId — (String)

            The VPC ID for the domain. Exists only if the domain was created with VPCOptions.

          • SubnetIds — (Array<String>)

            The subnets for the VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            The security groups for the VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

          • Enabled — (Boolean)

            The option to enable Cognito for OpenSearch Dashboards authentication.

          • UserPoolId — (String)

            The Cognito user pool ID for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Cognito identity pool ID for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The role ARN that provides OpenSearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          The status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            The option to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID for encryption at rest options.

        • NodeToNodeEncryptionOptions — (map)

          The status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          The status of the AdvancedOptions.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to publish logs to.

          • Enabled — (Boolean)

            Whether the given log publishing option is enabled or not.

        • 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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

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

            The description of the UpdateStatus.

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

        • DomainEndpointOptions — (map)

          The current status of the domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Whether only HTTPS endpoint should be enabled for the domain.

          • 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 TLSv1.0 and higher.
            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

          The current status of the domain's advanced security options.

          • Enabled — (Boolean)

            True if advanced security is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Describes the SAML application configured for a domain.

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

        • AutoTuneOptions — (map)

          The current status of the domain's Auto-Tune options.

          • State — (String)

            The AutoTuneState for 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)

            The error message while enabling or disabling Auto-Tune.

Returns:

  • (AWS.Request)

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

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

Allows the remote domain owner to delete an existing inbound cross-cluster connection.

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 InboundConnection of the deleted inbound connection.

        • LocalDomainInfo — (map)

          The AWSDomainInformation for the local OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • RemoteDomainInfo — (map)

          The AWSDomainInformation for the remote OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • ConnectionId — (String)

          The connection ID for the inbound cross-cluster connection.

        • ConnectionStatus — (map)

          The InboundConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for the inbound 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 provisioning is in progress.
            • 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)

            Verbose information for the inbound connection status.

Returns:

  • (AWS.Request)

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

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

Allows the local domain owner to delete an existing outbound cross-cluster connection.

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 OutboundConnection of the deleted outbound connection.

        • LocalDomainInfo — (map)

          The DomainInformation for the local OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • RemoteDomainInfo — (map)

          The DomainInformation for the remote OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • ConnectionId — (String)

          The connection ID for the outbound cross-cluster connection.

        • ConnectionAlias — (String)

          The connection alias for the outbound cross-cluster connection.

        • ConnectionStatus — (map)

          The OutboundConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state 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 status.

Returns:

  • (AWS.Request)

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

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

Deletes the package.

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)

        PackageDetails

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          User-specified description of the package.

        • PackageStatus — (String)

          Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

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

          The timestamp of when the package was created.

        • LastUpdatedAt — (Date)
        • AvailablePackageVersion — (String)
        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)

Returns:

  • (AWS.Request)

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

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

Returns domain configuration information about the specified domain, including the domain ID, domain 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 for which you want information.

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 current status of the domain.

        • DomainIdrequired — (String)

          The unique identifier for the specified domain.

        • DomainNamerequired — (String)

          The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          The domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

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

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

        • EngineVersion — (String)
        • ClusterConfigrequired — (map)

          The type and number of instances in the domain.

          • InstanceType — (String)

            The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

            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)

            The number of instances in the specified domain cluster.

          • DedicatedMasterEnabled — (Boolean)

            A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

          • ZoneAwarenessConfig — (map)

            The zone awareness configuration for a domain when zone awareness is enabled.

            • AvailabilityZoneCount — (Integer)

              An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

          • DedicatedMasterType — (String)

            The instance type for a dedicated master node.

            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)

            Total number of dedicated master nodes, active and on standby, for the cluster.

          • WarmEnabled — (Boolean)

            True to enable UltraWarm storage.

          • WarmType — (String)

            The instance type for the OpenSearch cluster's warm nodes.

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

            The number of UltraWarm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for a Domain

            • Enabledrequired — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain.

          • EBSEnabled — (Boolean)

            Whether EBS-based storage is enabled.

          • VolumeType — (String)

            The volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            The IOPD for a Provisioned IOPS EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          The status of the SnapshotOptions.

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

          • VPCId — (String)

            The VPC ID for the domain. Exists only if the domain was created with VPCOptions.

          • SubnetIds — (Array<String>)

            The subnets for the VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            The security groups for the VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

          • Enabled — (Boolean)

            The option to enable Cognito for OpenSearch Dashboards authentication.

          • UserPoolId — (String)

            The Cognito user pool ID for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Cognito identity pool ID for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The role ARN that provides OpenSearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          The status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            The option to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID for encryption at rest options.

        • NodeToNodeEncryptionOptions — (map)

          The status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          The status of the AdvancedOptions.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to publish logs to.

          • Enabled — (Boolean)

            Whether the given log publishing option is enabled or not.

        • 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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

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

            The description of the UpdateStatus.

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

        • DomainEndpointOptions — (map)

          The current status of the domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Whether only HTTPS endpoint should be enabled for the domain.

          • 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 TLSv1.0 and higher.
            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

          The current status of the domain's advanced security options.

          • Enabled — (Boolean)

            True if advanced security is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Describes the SAML application configured for a domain.

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

        • AutoTuneOptions — (map)

          The current status of the domain's Auto-Tune options.

          • State — (String)

            The AutoTuneState for 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)

            The error message while enabling or disabling Auto-Tune.

Returns:

  • (AWS.Request)

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

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

Provides scheduled Auto-Tune action details for the domain, such as Auto-Tune action type, description, severity, and scheduled date.

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)

      The domain name for which you want Auto-Tune action details.

    • MaxResults — (Integer)

      Set this value to limit the number of results returned. If not specified, defaults to 100.

    • NextToken — (String)

      NextToken is sent in case the earlier API call results contain the NextToken. Used for pagination.

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. See Auto-Tune for Amazon OpenSearch Service for more information.

        • AutoTuneType — (String)

          Specifies the Auto-Tune type. Valid value is SCHEDULED_ACTION.

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

          Specifies details about the Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

          • ScheduledAutoTuneDetails — (map)

            Specifies details about the scheduled Auto-Tune action. See Auto-Tune for Amazon OpenSearch Service for more information.

            • Date — (Date)

              The timestamp of the Auto-Tune action scheduled for the domain.

            • ActionType — (String)

              The Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.

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

              The Auto-Tune action description.

            • Severity — (String)

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

              Possible values include:
              • "LOW"
              • "MEDIUM"
              • "HIGH"
      • NextToken — (String)

        An identifier to allow retrieval of paginated results.

Returns:

  • (AWS.Request)

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

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

Provides cluster configuration information about the specified domain, such as the state, creation date, update version, and update date for cluster options.

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)

      The domain you want 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:

      • DomainConfig — (map)

        The configuration information of the domain requested in the DescribeDomainConfig request.

        • EngineVersion — (map)

          String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

          • Optionsrequired — (String)

            The OpenSearch version for the specified OpenSearch domain.

          • Statusrequired — (map)

            The status of the OpenSearch version options for the specified OpenSearch domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • ClusterConfig — (map)

          The ClusterConfig for the domain.

          • Optionsrequired — (map)

            The cluster configuration for the specified domain.

            • InstanceType — (String)

              The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

              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)

              The number of instances in the specified domain cluster.

            • DedicatedMasterEnabled — (Boolean)

              A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

            • ZoneAwarenessEnabled — (Boolean)

              A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

            • ZoneAwarenessConfig — (map)

              The zone awareness configuration for a domain when zone awareness is enabled.

              • AvailabilityZoneCount — (Integer)

                An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

            • DedicatedMasterType — (String)

              The instance type for a dedicated master node.

              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)

              Total number of dedicated master nodes, active and on standby, for the cluster.

            • WarmEnabled — (Boolean)

              True to enable UltraWarm storage.

            • WarmType — (String)

              The instance type for the OpenSearch cluster's warm nodes.

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

              The number of UltraWarm nodes in the cluster.

            • ColdStorageOptions — (map)

              Specifies the ColdStorageOptions config for a Domain

              • Enabledrequired — (Boolean)

                Enable cold storage option. Accepted values true or false

          • Statusrequired — (map)

            The cluster configuration status for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • EBSOptions — (map)

          The EBSOptions for the domain.

          • Optionsrequired — (map)

            The EBS options for the specified domain.

            • EBSEnabled — (Boolean)

              Whether EBS-based storage is enabled.

            • VolumeType — (String)

              The volume type for EBS-based storage.

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

              Integer to specify the size of an EBS volume.

            • Iops — (Integer)

              The IOPD for a Provisioned IOPS EBS volume (SSD).

          • Statusrequired — (map)

            The status of the EBS options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AccessPolicies — (map)

          IAM access policy as a JSON-formatted string.

          • Optionsrequired — (String)

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

          • Statusrequired — (map)

            The status of the access policy for the domain. See OptionStatus for the status information that's included.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • SnapshotOptions — (map)

          The SnapshotOptions for the domain.

          • Optionsrequired — (map)

            The daily snapshot options specified for the domain.

            • AutomatedSnapshotStartHour — (Integer)

              The time, in UTC format, when the 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 of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

          • Optionsrequired — (map)

            The VPC options for the specified domain.

            • VPCId — (String)

              The VPC ID for the domain. Exists only if the domain was created with VPCOptions.

            • SubnetIds — (Array<String>)

              The subnets for the VPC endpoint.

            • AvailabilityZones — (Array<String>)

              The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

            • SecurityGroupIds — (Array<String>)

              The security groups for the VPC endpoint.

          • Statusrequired — (map)

            The status of the VPC options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

          • Optionsrequired — (map)

            Cognito options for the specified domain.

            • Enabled — (Boolean)

              The option to enable Cognito for OpenSearch Dashboards authentication.

            • UserPoolId — (String)

              The Cognito user pool ID for OpenSearch Dashboards authentication.

            • IdentityPoolId — (String)

              The Cognito identity pool ID for OpenSearch Dashboards authentication.

            • RoleArn — (String)

              The role ARN that provides OpenSearch permissions for accessing Cognito resources.

          • Statusrequired — (map)

            The status of the Cognito options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • EncryptionAtRestOptions — (map)

          The EncryptionAtRestOptions for the domain.

          • Optionsrequired — (map)

            The Encryption At Rest options for the specified domain.

            • Enabled — (Boolean)

              The option to enable encryption at rest.

            • KmsKeyId — (String)

              The KMS key ID for encryption at rest options.

          • Statusrequired — (map)

            The status of the Encryption At Rest options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • NodeToNodeEncryptionOptions — (map)

          The NodeToNodeEncryptionOptions for the domain.

          • 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 of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AdvancedOptions — (map)

          The AdvancedOptions for the domain. See Advanced options for more information.

          • Optionsrequired — (map<String>)

            The status of advanced options for the specified domain.

          • Statusrequired — (map)

            The OptionStatus for advanced options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • LogPublishingOptions — (map)

          Log publishing options for the given domain.

          • Options — (map<map>)

            The log publishing options configured for the domain.

            • CloudWatchLogsLogGroupArn — (String)

              ARN of the Cloudwatch log group to publish logs to.

            • Enabled — (Boolean)

              Whether the given log publishing option is enabled or not.

          • Status — (map)

            The status of the log publishing options for the domain. See OptionStatus for the status information that's included.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • DomainEndpointOptions — (map)

          The DomainEndpointOptions for the domain.

          • Optionsrequired — (map)

            Options to configure the endpoint for the domain.

            • EnforceHTTPS — (Boolean)

              Whether only HTTPS endpoint should be enabled for the domain.

            • 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 TLSv1.0 and higher.
              • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

            • CustomEndpointCertificateArn — (String)

              The ACM certificate ARN for your custom endpoint.

          • Statusrequired — (map)

            The status of the endpoint options for the domain. See OptionStatus for the status information that's included.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AdvancedSecurityOptions — (map)

          Specifies AdvancedSecurityOptions for the domain.

          • Optionsrequired — (map)

            Advanced security options for the specified domain.

            • Enabled — (Boolean)

              True if advanced security is enabled.

            • InternalUserDatabaseEnabled — (Boolean)

              True if the internal user database is enabled.

            • SAMLOptions — (map)

              Describes the SAML application configured for a domain.

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

          • Statusrequired — (map)

            Status of the advanced security options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AutoTuneOptions — (map)

          Specifies AutoTuneOptions for the domain.

          • Options — (map)

            Specifies Auto-Tune options for the domain.

            • DesiredState — (String)

              The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

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

              The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

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

              A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

          • Status — (map)

            The status of the Auto-Tune options for the domain.

            • CreationDaterequired — (Date)

              The timestamp of the Auto-Tune options creation date.

            • UpdateDaterequired — (Date)

              The timestamp of when the Auto-Tune options were last updated.

            • UpdateVersion — (Integer)

              The latest version of the Auto-Tune options.

            • Staterequired — (String)

              The AutoTuneState for 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)

              The error message while enabling or disabling Auto-Tune.

            • PendingDeletion — (Boolean)

              Indicates whether the domain is being deleted.

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 domains, including the domain ID, domain endpoint, and domain ARN.

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>)

      The domains for which you want information.

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 domains requested in the DescribeDomains request.

        • DomainIdrequired — (String)

          The unique identifier for the specified domain.

        • DomainNamerequired — (String)

          The name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of a domain. See IAM identifiers in the AWS Identity and Access Management User Guide for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of a domain is complete. False if domain creation is still in progress.

        • Deleted — (Boolean)

          The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.

        • Endpoint — (String)

          The domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.

        • Processing — (Boolean)

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

        • UpgradeProcessing — (Boolean)

          The status of a domain version upgrade. True if Amazon OpenSearch Service is undergoing a version upgrade. False if the configuration is active.

        • EngineVersion — (String)
        • ClusterConfigrequired — (map)

          The type and number of instances in the domain.

          • InstanceType — (String)

            The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

            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)

            The number of instances in the specified domain cluster.

          • DedicatedMasterEnabled — (Boolean)

            A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

          • ZoneAwarenessConfig — (map)

            The zone awareness configuration for a domain when zone awareness is enabled.

            • AvailabilityZoneCount — (Integer)

              An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

          • DedicatedMasterType — (String)

            The instance type for a dedicated master node.

            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)

            Total number of dedicated master nodes, active and on standby, for the cluster.

          • WarmEnabled — (Boolean)

            True to enable UltraWarm storage.

          • WarmType — (String)

            The instance type for the OpenSearch cluster's warm nodes.

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

            The number of UltraWarm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for a Domain

            • Enabledrequired — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain.

          • EBSEnabled — (Boolean)

            Whether EBS-based storage is enabled.

          • VolumeType — (String)

            The volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            The IOPD for a Provisioned IOPS EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          The status of the SnapshotOptions.

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

          • VPCId — (String)

            The VPC ID for the domain. Exists only if the domain was created with VPCOptions.

          • SubnetIds — (Array<String>)

            The subnets for the VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            The security groups for the VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

          • Enabled — (Boolean)

            The option to enable Cognito for OpenSearch Dashboards authentication.

          • UserPoolId — (String)

            The Cognito user pool ID for OpenSearch Dashboards authentication.

          • IdentityPoolId — (String)

            The Cognito identity pool ID for OpenSearch Dashboards authentication.

          • RoleArn — (String)

            The role ARN that provides OpenSearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          The status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            The option to enable encryption at rest.

          • KmsKeyId — (String)

            The KMS key ID for encryption at rest options.

        • NodeToNodeEncryptionOptions — (map)

          The status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            True to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          The status of the AdvancedOptions.

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to publish logs to.

          • Enabled — (Boolean)

            Whether the given log publishing option is enabled or not.

        • 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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

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

            The description of the UpdateStatus.

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

        • DomainEndpointOptions — (map)

          The current status of the domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Whether only HTTPS endpoint should be enabled for the domain.

          • 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 TLSv1.0 and higher.
            • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            The ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

          The current status of the domain's advanced security options.

          • Enabled — (Boolean)

            True if advanced security is enabled.

          • InternalUserDatabaseEnabled — (Boolean)

            True if the internal user database is enabled.

          • SAMLOptions — (map)

            Describes the SAML application configured for a domain.

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

        • AutoTuneOptions — (map)

          The current status of the domain's Auto-Tune options.

          • State — (String)

            The AutoTuneState for 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)

            The error message while enabling or disabling Auto-Tune.

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 connections for a remote domain.

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. Available Filter values are:

      • connection-id
      • local-domain-info.domain-name
      • local-domain-info.owner-id
      • local-domain-info.region
      • remote-domain-info.domain-name

      • Name — (String)

        The name of the filter.

      • Values — (Array<String>)

        Contains one or more values for the filter.

    • MaxResults — (Integer)

      Set this value to limit the number of results returned. If not specified, defaults to 100.

    • NextToken — (String)

      If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

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>)

        A list of InboundConnection matching the specified filter criteria.

        • LocalDomainInfo — (map)

          The AWSDomainInformation for the local OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • RemoteDomainInfo — (map)

          The AWSDomainInformation for the remote OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • ConnectionId — (String)

          The connection ID for the inbound cross-cluster connection.

        • ConnectionStatus — (map)

          The InboundConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for the inbound 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 provisioning is in progress.
            • 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)

            Verbose information for the inbound connection status.

      • NextToken — (String)

        If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Returns:

  • (AWS.Request)

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

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

Describe the limits for a given instance type and OpenSearch or Elasticsearch version. When modifying an existing domain, specify the DomainName to see which limits you can modify.

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 you want to modify. Only include this value if you're querying OpenSearch Limits for an existing domain.

    • InstanceType — (String)

      The instance type for an OpenSearch cluster for which OpenSearch Limits are needed.

      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 for which Limits are needed.

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>)

        The role of a given instance and all applicable limits. The role performed by a given OpenSearch instance can be one of the following:

        • data: If the given InstanceType is used as a data node
        • master: If the given InstanceType is used as a master node
        • ultra_warm: If the given InstanceType is used as a warm node

        • StorageTypes — (Array<map>)

          Storage-related types and attributes that are available for a given InstanceType.

          • StorageTypeName — (String)

            Type of storage. List of available storage options:

            1. instance
            2. Built-in storage available for the instance
            3. ebs
            4. Elastic block storage attached to the instance

          • StorageSubTypeName — (String)

            Sub-type of the given storage type. List of available sub-storage options: "instance" storageType has no storageSubType. "ebs" storageType has the following valid storageSubTypes:

            1. standard
            2. gp2
            3. io1
            See VolumeType for more information regarding each EBS storage option.

          • 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 storage options are applicable:

              1. MinimumVolumeSize
              2. Minimum amount of volume size that is applicable for the given storage type. Can be empty if not applicable.
              3. MaximumVolumeSize
              4. Maximum amount of volume size that is applicable for the given storage type. Can be empty if not applicable.
              5. MaximumIops
              6. Maximum amount of Iops that is applicable for given the storage type. Can be empty if not applicable.
              7. MinimumIops
              8. Minimum amount of Iops that is applicable for given the storage type. Can be empty if not applicable.

            • LimitValues — (Array<String>)

              Values for the StorageTypeLimit$LimitName .

        • InstanceLimits — (map)

          InstanceLimits represents the list of instance-related attributes that are available for a given InstanceType.

          • InstanceCountLimits — (map)

            InstanceCountLimits represents the limits on the number of instances that can be created in Amazon OpenSearch Service for a given InstanceType.

            • MinimumInstanceCount — (Integer)

              Minimum number of instances that can be instantiated for a given InstanceType.

            • MaximumInstanceCount — (Integer)

              Maximum number of instances that can be instantiated for a given InstanceType.

        • AdditionalLimits — (Array<map>)

          List of additional limits that are specific to a given InstanceType and for each of its InstanceRole .

          • LimitName — (String)

            Additional limit is specific to a given InstanceType and for each of its InstanceRole etc.
            Attributes and their details:

            • MaximumNumberOfDataNodesSupported
            • This attribute is present on the master node only to specify how much data nodes up to which given ESPartitionInstanceType can support as master node.
            • MaximumNumberOfDataNodesWithoutMasterNode
            • This attribute is present on data node only to specify how much data nodes of given ESPartitionInstanceType up to which you don't need any master nodes to govern them.

          • LimitValues — (Array<String>)

            Value for a given AdditionalLimit$LimitName .

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

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>)

      A list of filters used to match properties for outbound cross-cluster connections. Available Filter names for this operation are:

      • connection-id
      • remote-domain-info.domain-name
      • remote-domain-info.owner-id
      • remote-domain-info.region
      • local-domain-info.domain-name

      • Name — (String)

        The name of the filter.

      • Values — (Array<String>)

        Contains one or more values for the filter.

    • MaxResults — (Integer)

      Set this value to limit the number of results returned. If not specified, defaults to 100.

    • NextToken — (String)

      NextToken is sent in case the earlier API call results contain the NextToken parameter. Used for pagination.

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>)

        A list of OutboundConnection matching the specified filter criteria.

        • LocalDomainInfo — (map)

          The DomainInformation for the local OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • RemoteDomainInfo — (map)

          The DomainInformation for the remote OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • ConnectionId — (String)

          The connection ID for the outbound cross-cluster connection.

        • ConnectionAlias — (String)

          The connection alias for the outbound cross-cluster connection.

        • ConnectionStatus — (map)

          The OutboundConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state 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 status.

      • NextToken — (String)

        If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.

Returns:

  • (AWS.Request)

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

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

Describes all packages available to Amazon OpenSearch Service domains. Includes options for filtering, limiting the number of results, and pagination.

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

    • MaxResults — (Integer)

      Limits results to a maximum number of packages.

    • NextToken — (String)

      Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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>)

        List of PackageDetails objects.

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          User-specified description of the package.

        • PackageStatus — (String)

          Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

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

          The timestamp of when the package was created.

        • LastUpdatedAt — (Date)
        • AvailablePackageVersion — (String)
        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Lists available reserved OpenSearch instance offerings.

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 offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

    • MaxResults — (Integer)

      Set this value to limit the number of results returned. If not specified, defaults to 100.

    • NextToken — (String)

      Provides an identifier to allow retrieval of paginated results.

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)

        Provides an identifier to allow retrieval of paginated results.

      • ReservedInstanceOfferings — (Array<map>)

        List of reserved OpenSearch instance offerings

        • ReservedInstanceOfferingId — (String)

          The OpenSearch reserved instance offering identifier.

        • 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 OpenSearch instance offering.

        • UsagePrice — (Float)

          The rate you are charged for each hour the domain that is using the offering is running.

        • CurrencyCode — (String)

          The currency code for the reserved OpenSearch instance offering.

        • PaymentOption — (String)

          Payment option for the reserved OpenSearch instance offering

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

          The charge to your account regardless of whether you are creating any domains using the 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.

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

Returns information about reserved OpenSearch instances for this account.

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)

      Set this value to limit the number of results returned. If not specified, defaults to 100.

    • NextToken — (String)

      Provides an identifier to allow retrieval of paginated results.

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)

        Provides an identifier to allow retrieval of paginated results.

      • ReservedInstances — (Array<map>)

        List of reserved OpenSearch instances.

        • ReservationName — (String)

          The customer-specified identifier to track this reservation.

        • ReservedInstanceId — (String)

          The unique identifier for the reservation.

        • BillingSubscriptionId — (Integer)
        • ReservedInstanceOfferingId — (String)

          The offering identifier.

        • 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"
        • StartTime — (Date)

          The time the reservation started.

        • 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 OpenSearch instance offering.

        • UsagePrice — (Float)

          The rate you are charged for each hour for the domain that is using this reserved instance.

        • CurrencyCode — (String)

          The currency code for the reserved OpenSearch instance offering.

        • InstanceCount — (Integer)

          The number of OpenSearch instances that have been reserved.

        • State — (String)

          The state of the reserved OpenSearch instance.

        • PaymentOption — (String)

          The payment option as defined in the reserved OpenSearch instance offering.

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

          The charge to your account regardless of whether you are creating any domains using the 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.

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

Dissociates a package from the Amazon OpenSearch Service domain.

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)

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

    • DomainName — (String)

      The 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)

        DomainPackageDetails

        • PackageID — (String)

          The internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          The timestamp of the most recent update to the package association status.

        • DomainName — (String)

          The name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

          State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

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

          The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)

Returns:

  • (AWS.Request)

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

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

Returns a list of upgrade-compatible versions of OpenSearch/Elasticsearch. You can optionally pass a DomainName to get all upgrade-compatible versions of OpenSearch/Elasticsearch for that specific domain.

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 domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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 compatible OpenSearch versions returned as part of the GetCompatibleVersions operation.

        • SourceVersion — (String)

          The current version of OpenSearch a domain is on.

        • TargetVersions — (Array<String>)

          List of supported OpenSearch versions.

Returns:

  • (AWS.Request)

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

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

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

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)

      Returns an audit history of package versions.

    • MaxResults — (Integer)

      Limits results to a maximum number of package versions.

    • NextToken — (String)

      Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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)
      • PackageVersionHistoryList — (Array<map>)

        List of PackageVersionHistory objects.

        • PackageVersion — (String)

          The package version.

        • CommitMessage — (String)

          A message associated with the package version.

        • CreatedAt — (Date)

          The timestamp of when the package was created.

      • NextToken — (String)

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 the 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 domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • MaxResults — (Integer)

      Set this value to limit the number of results returned.

    • NextToken — (String)

      Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

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 UpgradeHistory objects corresponding to each upgrade or upgrade eligibility check performed on a domain returned as part of the GetUpgradeHistoryResponse object.

        • UpgradeName — (String)

          A string that briefly describes the upgrade.

        • StartTimestamp — (Date)

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

        • 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 UpgradeStepItem s representing information about each step performed as part of a specific upgrade or upgrade eligibility check.

          • UpgradeStep — (String)

            One of three steps 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)

        Pagination token that needs to be supplied to the next call to get the next page of results.

Returns:

  • (AWS.Request)

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

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

Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the 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 name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

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 an upgrade or upgrade eligibility check goes through:

        • PreUpgradeCheck
        • Snapshot
        • Upgrade

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

        One of four statuses an upgrade have, returned as part of the GetUpgradeStatusResponse object. 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"
      • UpgradeName — (String)

        A string that briefly 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 domains owned by the current user's account.

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)

      Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.

      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>)

        List of domain names and respective engine types.

        • DomainName — (String)

          The DomainName.

        • EngineType — (String)

          Specifies the EngineType of the domain.

          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 the package.

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 package for which to list associated domains.

    • MaxResults — (Integer)

      Limits the results to a maximum number of domains.

    • NextToken — (String)

      Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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 DomainPackageDetails objects.

        • PackageID — (String)

          The internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          The timestamp of the most recent update to the package association status.

        • DomainName — (String)

          The name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

          State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

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

          The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)
      • NextToken — (String)

Returns:

  • (AWS.Request)

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

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

Calls the ListInstanceTypeDetails API operation.

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

      The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • MaxResults — (Integer)

      Set this value to limit the number of results returned.

    • NextToken — (String)

      Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

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>)
        • InstanceType — (String) 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)
        • CognitoEnabled — (Boolean)
        • AppLogsEnabled — (Boolean)
        • AdvancedSecurityEnabled — (Boolean)
        • WarmEnabled — (Boolean)
        • InstanceRole — (Array<String>)
      • NextToken — (String)

        Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Returns:

  • (AWS.Request)

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

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

Lists all packages associated with the Amazon OpenSearch Service domain.

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)

      Limits results to a maximum number of packages.

    • NextToken — (String)

      Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for 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 DomainPackageDetails objects.

        • PackageID — (String)

          The internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          The timestamp of the most recent update to the package association status.

        • DomainName — (String)

          The name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

          State of the association. Values are ASSOCIATING, ASSOCIATION_FAILED, ACTIVE, DISSOCIATING, and DISSOCIATION_FAILED.

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

          The relative path on Amazon OpenSearch Service nodes, which can be used as synonym_path when the package is a synonym file.

        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)
      • NextToken — (String)

        Pagination token to supply to the next call to get the next page of results.

Returns:

  • (AWS.Request)

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

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

Returns all tags for the given domain.

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)

      Specify the ARN of the domain that the tags you want to view are attached 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:

      • TagList — (Array<map>)

        List of Tag for the requested domain.

        • Keyrequired — (String)

          The TagKey, the name of the tag. Tag keys must be unique for the domain to which they are attached.

        • Valuerequired — (String)

          The TagValue, 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

List all supported versions of OpenSearch and Elasticsearch.

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)

      Set this value to limit the number of results returned. Value must be greater than 10 or it won't be honored.

    • NextToken — (String)

      Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

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>)

        List of supported OpenSearch versions.

      • NextToken — (String)

        Paginated APIs accept the NextToken input to return the next page of results and provide a NextToken output in the response, which you can use to retrieve more results.

Returns:

  • (AWS.Request)

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

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

Allows you to purchase reserved OpenSearch 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 OpenSearch 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)

        Details of the reserved OpenSearch instance which 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 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 ID 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)

        The InboundConnection of the rejected inbound connection.

        • LocalDomainInfo — (map)

          The AWSDomainInformation for the local OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • RemoteDomainInfo — (map)

          The AWSDomainInformation for the remote OpenSearch domain.

          • AWSDomainInformation — (map)
            • OwnerId — (String)
            • DomainNamerequired — (String)

              The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

            • Region — (String)
        • ConnectionId — (String)

          The connection ID for the inbound cross-cluster connection.

        • ConnectionStatus — (map)

          The InboundConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for the inbound 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 provisioning is in progress.
            • 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)

            Verbose information for the inbound connection status.

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 the given domain.

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 ARN of the domain from which you want to delete the specified tags.

    • TagKeys — (Array<String>)

      The TagKey list you want 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.

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

Schedules a service software update for an Amazon OpenSearch Service domain.

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. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.

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

          The description of the UpdateStatus.

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

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 domain, such as setting the instance type and the number of instances.

Service Reference:

Examples:

Calling the updateDomainConfig operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AccessPolicies: 'STRING_VALUE',
  AdvancedOptions: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  AdvancedSecurityOptions: {
    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',
    VolumeSize: 'NUMBER_VALUE',
    VolumeType: standard | gp2 | io1
  },
  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 you're updating.

    • ClusterConfig — (map)

      The type and number of instances to instantiate for the domain cluster.

      • InstanceType — (String)

        The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

        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)

        The number of instances in the specified domain cluster.

      • DedicatedMasterEnabled — (Boolean)

        A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

      • ZoneAwarenessEnabled — (Boolean)

        A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

      • ZoneAwarenessConfig — (map)

        The zone awareness configuration for a domain when zone awareness is enabled.

        • AvailabilityZoneCount — (Integer)

          An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

      • DedicatedMasterType — (String)

        The instance type for a dedicated master node.

        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)

        Total number of dedicated master nodes, active and on standby, for the cluster.

      • WarmEnabled — (Boolean)

        True to enable UltraWarm storage.

      • WarmType — (String)

        The instance type for the OpenSearch cluster's warm nodes.

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

        The number of UltraWarm nodes in the cluster.

      • ColdStorageOptions — (map)

        Specifies the ColdStorageOptions config for a Domain

        • Enabledrequired — (Boolean)

          Enable cold storage option. Accepted values true or false

    • EBSOptions — (map)

      Specify the type and size of the EBS volume to use.

      • EBSEnabled — (Boolean)

        Whether EBS-based storage is enabled.

      • VolumeType — (String)

        The volume type for EBS-based storage.

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

        Integer to specify the size of an EBS volume.

      • Iops — (Integer)

        The IOPD for a Provisioned IOPS EBS volume (SSD).

    • 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 the 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 the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC .

      • SubnetIds — (Array<String>)

        The subnets for the VPC endpoint.

      • SecurityGroupIds — (Array<String>)

        The security groups for the VPC endpoint.

    • CognitoOptions — (map)

      Options to specify the Cognito user and identity pools for OpenSearch Dashboards authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

      • Enabled — (Boolean)

        The option to enable Cognito for OpenSearch Dashboards authentication.

      • UserPoolId — (String)

        The Cognito user pool ID for OpenSearch Dashboards authentication.

      • IdentityPoolId — (String)

        The Cognito identity pool ID for OpenSearch Dashboards authentication.

      • RoleArn — (String)

        The role ARN that provides OpenSearch permissions for accessing Cognito resources.

    • AdvancedOptions — (map<String>)

      Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced options for more information.

    • AccessPolicies — (String)

      IAM access policy as a JSON-formatted string.

    • LogPublishingOptions — (map<map>)

      Map of LogType and LogPublishingOption, each containing options to publish a given type of OpenSearch log.

      • CloudWatchLogsLogGroupArn — (String)

        ARN of the Cloudwatch log group to publish logs to.

      • Enabled — (Boolean)

        Whether the given log publishing option is enabled or not.

    • EncryptionAtRestOptions — (map)

      Specifies encryption of data at rest options.

      • Enabled — (Boolean)

        The option to enable encryption at rest.

      • KmsKeyId — (String)

        The KMS key ID for encryption at rest options.

    • DomainEndpointOptions — (map)

      Options to specify configuration that will be applied to the domain endpoint.

      • EnforceHTTPS — (Boolean)

        Whether only HTTPS endpoint should be enabled for the domain.

      • 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 TLSv1.0 and higher.
        • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

      • CustomEndpointCertificateArn — (String)

        The ACM certificate ARN for your custom endpoint.

    • NodeToNodeEncryptionOptions — (map)

      Specifies node-to-node encryption options.

      • Enabled — (Boolean)

        True to enable node-to-node encryption.

    • AdvancedSecurityOptions — (map)

      Specifies advanced security options.

      • Enabled — (Boolean)

        True if advanced security is enabled.

      • InternalUserDatabaseEnabled — (Boolean)

        True if the internal user database is enabled.

      • MasterUserOptions — (map)

        Credentials for the master user: username and password, ARN, or both.

        • MasterUserARN — (String)

          ARN for the master user (if IAM is enabled).

        • MasterUserName — (String)

          The master user's username, which is stored in the Amazon OpenSearch Service domain's internal database.

        • MasterUserPassword — (String)

          The master user's password, which is stored in the Amazon OpenSearch Service domain's internal database.

      • SAMLOptions — (map)

        The SAML application configuration for the domain.

        • Enabled — (Boolean)

          True if SAML is enabled.

        • 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 SAML identity provider.

        • MasterUserName — (String)

          The SAML master username, which is stored in the Amazon OpenSearch Service domain's internal database.

        • MasterBackendRole — (String)

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

        • SubjectKey — (String)

          Element of the SAML assertion to use for username. 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.

    • AutoTuneOptions — (map)

      Specifies Auto-Tune options.

      • DesiredState — (String)

        The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

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

        The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

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

        A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

    • DryRun — (Boolean)

      This flag, when set to True, specifies whether the UpdateDomain request should return the results of validation checks (DryRunResults) 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)

          String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch or Elasticsearch domain.

          • Optionsrequired — (String)

            The OpenSearch version for the specified OpenSearch domain.

          • Statusrequired — (map)

            The status of the OpenSearch version options for the specified OpenSearch domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • ClusterConfig — (map)

          The ClusterConfig for the domain.

          • Optionsrequired — (map)

            The cluster configuration for the specified domain.

            • InstanceType — (String)

              The instance type for an OpenSearch cluster. UltraWarm instance types are not supported for data instances.

              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)

              The number of instances in the specified domain cluster.

            • DedicatedMasterEnabled — (Boolean)

              A boolean value to indicate whether a dedicated master node is enabled. See Dedicated master nodes in Amazon OpenSearch Service for more information.

            • ZoneAwarenessEnabled — (Boolean)

              A boolean value to indicate whether zone awareness is enabled. See Configuring a multi-AZ domain in Amazon OpenSearch Service for more information.

            • ZoneAwarenessConfig — (map)

              The zone awareness configuration for a domain when zone awareness is enabled.

              • AvailabilityZoneCount — (Integer)

                An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled.

            • DedicatedMasterType — (String)

              The instance type for a dedicated master node.

              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)

              Total number of dedicated master nodes, active and on standby, for the cluster.

            • WarmEnabled — (Boolean)

              True to enable UltraWarm storage.

            • WarmType — (String)

              The instance type for the OpenSearch cluster's warm nodes.

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

              The number of UltraWarm nodes in the cluster.

            • ColdStorageOptions — (map)

              Specifies the ColdStorageOptions config for a Domain

              • Enabledrequired — (Boolean)

                Enable cold storage option. Accepted values true or false

          • Statusrequired — (map)

            The cluster configuration status for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • EBSOptions — (map)

          The EBSOptions for the domain.

          • Optionsrequired — (map)

            The EBS options for the specified domain.

            • EBSEnabled — (Boolean)

              Whether EBS-based storage is enabled.

            • VolumeType — (String)

              The volume type for EBS-based storage.

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

              Integer to specify the size of an EBS volume.

            • Iops — (Integer)

              The IOPD for a Provisioned IOPS EBS volume (SSD).

          • Statusrequired — (map)

            The status of the EBS options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AccessPolicies — (map)

          IAM access policy as a JSON-formatted string.

          • Optionsrequired — (String)

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

          • Statusrequired — (map)

            The status of the access policy for the domain. See OptionStatus for the status information that's included.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • SnapshotOptions — (map)

          The SnapshotOptions for the domain.

          • Optionsrequired — (map)

            The daily snapshot options specified for the domain.

            • AutomatedSnapshotStartHour — (Integer)

              The time, in UTC format, when the 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 of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

          • Optionsrequired — (map)

            The VPC options for the specified domain.

            • VPCId — (String)

              The VPC ID for the domain. Exists only if the domain was created with VPCOptions.

            • SubnetIds — (Array<String>)

              The subnets for the VPC endpoint.

            • AvailabilityZones — (Array<String>)

              The Availability Zones for the domain. Exists only if the domain was created with VPCOptions.

            • SecurityGroupIds — (Array<String>)

              The security groups for the VPC endpoint.

          • Statusrequired — (map)

            The status of the VPC options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.

          • Optionsrequired — (map)

            Cognito options for the specified domain.

            • Enabled — (Boolean)

              The option to enable Cognito for OpenSearch Dashboards authentication.

            • UserPoolId — (String)

              The Cognito user pool ID for OpenSearch Dashboards authentication.

            • IdentityPoolId — (String)

              The Cognito identity pool ID for OpenSearch Dashboards authentication.

            • RoleArn — (String)

              The role ARN that provides OpenSearch permissions for accessing Cognito resources.

          • Statusrequired — (map)

            The status of the Cognito options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • EncryptionAtRestOptions — (map)

          The EncryptionAtRestOptions for the domain.

          • Optionsrequired — (map)

            The Encryption At Rest options for the specified domain.

            • Enabled — (Boolean)

              The option to enable encryption at rest.

            • KmsKeyId — (String)

              The KMS key ID for encryption at rest options.

          • Statusrequired — (map)

            The status of the Encryption At Rest options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • NodeToNodeEncryptionOptions — (map)

          The NodeToNodeEncryptionOptions for the domain.

          • 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 of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AdvancedOptions — (map)

          The AdvancedOptions for the domain. See Advanced options for more information.

          • Optionsrequired — (map<String>)

            The status of advanced options for the specified domain.

          • Statusrequired — (map)

            The OptionStatus for advanced options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • LogPublishingOptions — (map)

          Log publishing options for the given domain.

          • Options — (map<map>)

            The log publishing options configured for the domain.

            • CloudWatchLogsLogGroupArn — (String)

              ARN of the Cloudwatch log group to publish logs to.

            • Enabled — (Boolean)

              Whether the given log publishing option is enabled or not.

          • Status — (map)

            The status of the log publishing options for the domain. See OptionStatus for the status information that's included.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • DomainEndpointOptions — (map)

          The DomainEndpointOptions for the domain.

          • Optionsrequired — (map)

            Options to configure the endpoint for the domain.

            • EnforceHTTPS — (Boolean)

              Whether only HTTPS endpoint should be enabled for the domain.

            • 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 TLSv1.0 and higher.
              • Policy-Min-TLS-1-2-2019-07: TLS security policy which supports only TLSv1.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 domain for your custom endpoint.

            • CustomEndpointCertificateArn — (String)

              The ACM certificate ARN for your custom endpoint.

          • Statusrequired — (map)

            The status of the endpoint options for the domain. See OptionStatus for the status information that's included.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AdvancedSecurityOptions — (map)

          Specifies AdvancedSecurityOptions for the domain.

          • Optionsrequired — (map)

            Advanced security options for the specified domain.

            • Enabled — (Boolean)

              True if advanced security is enabled.

            • InternalUserDatabaseEnabled — (Boolean)

              True if the internal user database is enabled.

            • SAMLOptions — (map)

              Describes the SAML application configured for a domain.

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

          • Statusrequired — (map)

            Status of the advanced security options for the specified domain.

            • CreationDaterequired — (Date)

              The timestamp of 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)

              Provides the OptionState for the domain.

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

              Indicates whether the domain is being deleted.

        • AutoTuneOptions — (map)

          Specifies AutoTuneOptions for the domain.

          • Options — (map)

            Specifies Auto-Tune options for the domain.

            • DesiredState — (String)

              The Auto-Tune desired state. Valid values are ENABLED and DISABLED.

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

              The rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK and DEFAULT_ROLLBACK.

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

              A list of maintenance schedules. See Auto-Tune for Amazon OpenSearch Service for more information.

          • Status — (map)

            The status of the Auto-Tune options for the domain.

            • CreationDaterequired — (Date)

              The timestamp of the Auto-Tune options creation date.

            • UpdateDaterequired — (Date)

              The timestamp of when the Auto-Tune options were last updated.

            • UpdateVersion — (Integer)

              The latest version of the Auto-Tune options.

            • Staterequired — (String)

              The AutoTuneState for 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)

              The error message while enabling or disabling Auto-Tune.

            • PendingDeletion — (Boolean)

              Indicates whether the domain is being deleted.

      • DryRunResults — (map)

        Contains result of DryRun.

        • DeploymentType — (String)

          Specifies the way in which Amazon OpenSearch Service applies the update. Possible responses are Blue/Green (the update requires a blue/green deployment), DynamicUpdate (no blue/green required), Undetermined (the domain is undergoing an update and can't predict the deployment type; try again after the update is complete), and None (the request doesn't include any configuration changes).

        • Message — (String)

          Contains an optional message associated with the DryRunResults.

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.

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)

      The Amazon S3 location for importing the package specified as S3BucketName and S3Key

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

      A commit message for the new version 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 the package.

        • PackageID — (String)

          Internal ID of the package.

        • PackageName — (String)

          User-specified name of the package.

        • PackageType — (String)

          Currently supports only TXT-DICTIONARY.

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

          User-specified description of the package.

        • PackageStatus — (String)

          Current state of the package. Values are COPYING, COPY_FAILED, AVAILABLE, DELETING, and DELETE_FAILED.

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

          The timestamp of when the package was created.

        • LastUpdatedAt — (Date)
        • AvailablePackageVersion — (String)
        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)

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 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)

      The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

    • TargetVersion — (String)

      The version of OpenSearch you intend to upgrade the domain to.

    • PerformCheckOnly — (Boolean)

      When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

    • AdvancedOptions — (map<String>)

      Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

      • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
      • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

      For more information, see Advanced cluster parameters.

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

        The name of an domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

      • TargetVersion — (String)

        The version of OpenSearch that you intend to upgrade the domain to.

      • PerformCheckOnly — (Boolean)

        When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.

      • AdvancedOptions — (map<String>)

        Exposes select native OpenSearch configuration values from opensearch.yml. Currently, the following advanced options are available:

        • Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Advanced cluster parameters for more information.
        • Option to specify the percentage of heap space allocated to field data. By default, this setting is unbounded.

        For more information, see Advanced cluster parameters.

Returns:

  • (AWS.Request)

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