We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.ES

Inherits:
AWS.Service show all
Identifier:
es
API Version:
2015-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 Elasticsearch Configuration API to create, configure, and manage Elasticsearch domains.

For sample code that uses the Configuration API, see the Amazon Elasticsearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the Elasticsearch 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 ES

var es = new AWS.ES();
es.acceptInboundCrossClusterSearchConnection(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 ES object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var es = new AWS.ES({apiVersion: '2015-01-01'});

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

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

var es = new AWS.ES();

Version:

  • 2015-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.ES(options = {}) ⇒ Object

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

Examples:

Constructing a ES object

var es = new AWS.ES({apiVersion: '2015-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.ES.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.ES.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

endpoint ⇒ AWS.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

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

Allows the destination domain owner to accept an inbound cross-cluster search connection request.

Service Reference:

Examples:

Calling the acceptInboundCrossClusterSearchConnection operation

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

      The id of the inbound connection that 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:

      • CrossClusterSearchConnection — (map)

        Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.

        • SourceDomainInfo — (map)

          Specifies the DomainInformation for the source Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • DestinationDomainInfo — (map)

          Specifies the DomainInformation for the destination Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • CrossClusterSearchConnectionId — (String)

          Specifies the connection id for the inbound cross-cluster search connection.

        • ConnectionStatus — (map)

          Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for inbound connection. This can be one of the following:

            • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
            • APPROVED: Inbound connection is pending acceptance by destination domain owner.
            • 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 cannot be used further.
            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Specifies 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 Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch 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 */
  ]
};
es.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 for which you want to add the tags.

    • TagList — (Array<map>)

      List of Tag that need to be added for the Elasticsearch domain.

      • Key — required — (String)

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

      • Value — required — (String)

        Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not 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 ES domain.

Service Reference:

Examples:

Calling the associatePackage operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  PackageID: 'STRING_VALUE' /* required */
};
es.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 that you want to associate with a domain. Use DescribePackages to find this value.

    • DomainName — (String)

      Name of the domain that you want 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)

          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)

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

        • DomainName — (String)

          Name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

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

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

          The relative path on Amazon ES nodes, which can be used as synonym_path when the package is 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.

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

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

Service Reference:

Examples:

Calling the authorizeVpcEndpointAccess operation

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

Parameters:

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

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

    • Account — (String)

      The account ID to grant access to.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • AuthorizedPrincipal — (map)

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

        • PrincipalType — (String)

          The type of principal.

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

          The IAM principal that is allowed access to the domain.

Returns:

  • (AWS.Request) —

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

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

Cancels a pending configuration change on an Amazon OpenSearch Service domain.

Service Reference:

Examples:

Calling the cancelDomainConfigChange operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  DryRun: true || false
};
es.cancelDomainConfigChange(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      Name of the OpenSearch Service domain configuration request to cancel.

    • DryRun — (Boolean)

      When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling 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:

      • DryRun — (Boolean)

        Whether or not the request was a dry run. If True, the changes were not actually cancelled.

      • CancelledChangeIds — (Array<String>)

        The unique identifiers of the changes that were cancelled.

      • CancelledChangeProperties — (Array<map>)

        The domain change properties that were cancelled.

        • PropertyName — (String)

          The name of the property whose change was cancelled.

        • CancelledValue — (String)

          The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.

        • ActiveValue — (String)

          The current value of the property, after the change was cancelled.

Returns:

  • (AWS.Request) —

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

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

Cancels a scheduled service software update for an Amazon ES 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 cancelElasticsearchServiceSoftwareUpdate operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
es.cancelElasticsearchServiceSoftwareUpdate(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 Elasticsearch service software update.

        • CurrentVersion — (String)

          The current service software version that is present on the domain.

        • NewVersion — (String)

          The new service software version if one is available.

        • UpdateAvailable — (Boolean)

          True if you are able to update you service software version. False if you are not able to update your service software version.

        • Cancellable — (Boolean)

          True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

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

          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.

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

Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

Service Reference:

Examples:

Calling the createElasticsearchDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AccessPolicies: 'STRING_VALUE',
  AdvancedOptions: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  AdvancedSecurityOptions: {
    AnonymousAuthEnabled: true || false,
    Enabled: true || false,
    InternalUserDatabaseEnabled: true || false,
    MasterUserOptions: {
      MasterUserARN: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      MasterUserPassword: 'STRING_VALUE'
    },
    SAMLOptions: {
      Enabled: true || false,
      Idp: {
        EntityId: 'STRING_VALUE', /* required */
        MetadataContent: 'STRING_VALUE' /* required */
      },
      MasterBackendRole: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      RolesKey: 'STRING_VALUE',
      SessionTimeoutMinutes: 'NUMBER_VALUE',
      SubjectKey: 'STRING_VALUE'
    }
  },
  AutoTuneOptions: {
    DesiredState: ENABLED | DISABLED,
    MaintenanceSchedules: [
      {
        CronExpressionForRecurrence: 'STRING_VALUE',
        Duration: {
          Unit: HOURS,
          Value: 'NUMBER_VALUE'
        },
        StartAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ]
  },
  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 | Policy-Min-TLS-1-2-PFS-2023-10
  },
  EBSOptions: {
    EBSEnabled: true || false,
    Iops: 'NUMBER_VALUE',
    Throughput: 'NUMBER_VALUE',
    VolumeSize: 'NUMBER_VALUE',
    VolumeType: standard | gp2 | io1 | gp3
  },
  ElasticsearchClusterConfig: {
    ColdStorageOptions: {
      Enabled: true || false /* required */
    },
    DedicatedMasterCount: 'NUMBER_VALUE',
    DedicatedMasterEnabled: true || false,
    DedicatedMasterType: m3.medium.elasticsearch | m3.large.elasticsearch | m3.xlarge.elasticsearch | m3.2xlarge.elasticsearch | m4.large.elasticsearch | m4.xlarge.elasticsearch | m4.2xlarge.elasticsearch | m4.4xlarge.elasticsearch | m4.10xlarge.elasticsearch | m5.large.elasticsearch | m5.xlarge.elasticsearch | m5.2xlarge.elasticsearch | m5.4xlarge.elasticsearch | m5.12xlarge.elasticsearch | r5.large.elasticsearch | r5.xlarge.elasticsearch | r5.2xlarge.elasticsearch | r5.4xlarge.elasticsearch | r5.12xlarge.elasticsearch | c5.large.elasticsearch | c5.xlarge.elasticsearch | c5.2xlarge.elasticsearch | c5.4xlarge.elasticsearch | c5.9xlarge.elasticsearch | c5.18xlarge.elasticsearch | ultrawarm1.medium.elasticsearch | ultrawarm1.large.elasticsearch | t2.micro.elasticsearch | t2.small.elasticsearch | t2.medium.elasticsearch | r3.large.elasticsearch | r3.xlarge.elasticsearch | r3.2xlarge.elasticsearch | r3.4xlarge.elasticsearch | r3.8xlarge.elasticsearch | i2.xlarge.elasticsearch | i2.2xlarge.elasticsearch | d2.xlarge.elasticsearch | d2.2xlarge.elasticsearch | d2.4xlarge.elasticsearch | d2.8xlarge.elasticsearch | c4.large.elasticsearch | c4.xlarge.elasticsearch | c4.2xlarge.elasticsearch | c4.4xlarge.elasticsearch | c4.8xlarge.elasticsearch | r4.large.elasticsearch | r4.xlarge.elasticsearch | r4.2xlarge.elasticsearch | r4.4xlarge.elasticsearch | r4.8xlarge.elasticsearch | r4.16xlarge.elasticsearch | i3.large.elasticsearch | i3.xlarge.elasticsearch | i3.2xlarge.elasticsearch | i3.4xlarge.elasticsearch | i3.8xlarge.elasticsearch | i3.16xlarge.elasticsearch,
    InstanceCount: 'NUMBER_VALUE',
    InstanceType: m3.medium.elasticsearch | m3.large.elasticsearch | m3.xlarge.elasticsearch | m3.2xlarge.elasticsearch | m4.large.elasticsearch | m4.xlarge.elasticsearch | m4.2xlarge.elasticsearch | m4.4xlarge.elasticsearch | m4.10xlarge.elasticsearch | m5.large.elasticsearch | m5.xlarge.elasticsearch | m5.2xlarge.elasticsearch | m5.4xlarge.elasticsearch | m5.12xlarge.elasticsearch | r5.large.elasticsearch | r5.xlarge.elasticsearch | r5.2xlarge.elasticsearch | r5.4xlarge.elasticsearch | r5.12xlarge.elasticsearch | c5.large.elasticsearch | c5.xlarge.elasticsearch | c5.2xlarge.elasticsearch | c5.4xlarge.elasticsearch | c5.9xlarge.elasticsearch | c5.18xlarge.elasticsearch | ultrawarm1.medium.elasticsearch | ultrawarm1.large.elasticsearch | t2.micro.elasticsearch | t2.small.elasticsearch | t2.medium.elasticsearch | r3.large.elasticsearch | r3.xlarge.elasticsearch | r3.2xlarge.elasticsearch | r3.4xlarge.elasticsearch | r3.8xlarge.elasticsearch | i2.xlarge.elasticsearch | i2.2xlarge.elasticsearch | d2.xlarge.elasticsearch | d2.2xlarge.elasticsearch | d2.4xlarge.elasticsearch | d2.8xlarge.elasticsearch | c4.large.elasticsearch | c4.xlarge.elasticsearch | c4.2xlarge.elasticsearch | c4.4xlarge.elasticsearch | c4.8xlarge.elasticsearch | r4.large.elasticsearch | r4.xlarge.elasticsearch | r4.2xlarge.elasticsearch | r4.4xlarge.elasticsearch | r4.8xlarge.elasticsearch | r4.16xlarge.elasticsearch | i3.large.elasticsearch | i3.xlarge.elasticsearch | i3.2xlarge.elasticsearch | i3.4xlarge.elasticsearch | i3.8xlarge.elasticsearch | i3.16xlarge.elasticsearch,
    WarmCount: 'NUMBER_VALUE',
    WarmEnabled: true || false,
    WarmType: ultrawarm1.medium.elasticsearch | ultrawarm1.large.elasticsearch,
    ZoneAwarenessConfig: {
      AvailabilityZoneCount: 'NUMBER_VALUE'
    },
    ZoneAwarenessEnabled: true || false
  },
  ElasticsearchVersion: 'STRING_VALUE',
  EncryptionAtRestOptions: {
    Enabled: true || false,
    KmsKeyId: '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 */
    ]
  }
};
es.createElasticsearchDomain(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 Elasticsearch domain that you are 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).

    • ElasticsearchVersion — (String)

      String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.

    • ElasticsearchClusterConfig — (map)

      Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

      • InstanceType — (String)

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

        Possible values include:
        • "m3.medium.elasticsearch"
        • "m3.large.elasticsearch"
        • "m3.xlarge.elasticsearch"
        • "m3.2xlarge.elasticsearch"
        • "m4.large.elasticsearch"
        • "m4.xlarge.elasticsearch"
        • "m4.2xlarge.elasticsearch"
        • "m4.4xlarge.elasticsearch"
        • "m4.10xlarge.elasticsearch"
        • "m5.large.elasticsearch"
        • "m5.xlarge.elasticsearch"
        • "m5.2xlarge.elasticsearch"
        • "m5.4xlarge.elasticsearch"
        • "m5.12xlarge.elasticsearch"
        • "r5.large.elasticsearch"
        • "r5.xlarge.elasticsearch"
        • "r5.2xlarge.elasticsearch"
        • "r5.4xlarge.elasticsearch"
        • "r5.12xlarge.elasticsearch"
        • "c5.large.elasticsearch"
        • "c5.xlarge.elasticsearch"
        • "c5.2xlarge.elasticsearch"
        • "c5.4xlarge.elasticsearch"
        • "c5.9xlarge.elasticsearch"
        • "c5.18xlarge.elasticsearch"
        • "ultrawarm1.medium.elasticsearch"
        • "ultrawarm1.large.elasticsearch"
        • "t2.micro.elasticsearch"
        • "t2.small.elasticsearch"
        • "t2.medium.elasticsearch"
        • "r3.large.elasticsearch"
        • "r3.xlarge.elasticsearch"
        • "r3.2xlarge.elasticsearch"
        • "r3.4xlarge.elasticsearch"
        • "r3.8xlarge.elasticsearch"
        • "i2.xlarge.elasticsearch"
        • "i2.2xlarge.elasticsearch"
        • "d2.xlarge.elasticsearch"
        • "d2.2xlarge.elasticsearch"
        • "d2.4xlarge.elasticsearch"
        • "d2.8xlarge.elasticsearch"
        • "c4.large.elasticsearch"
        • "c4.xlarge.elasticsearch"
        • "c4.2xlarge.elasticsearch"
        • "c4.4xlarge.elasticsearch"
        • "c4.8xlarge.elasticsearch"
        • "r4.large.elasticsearch"
        • "r4.xlarge.elasticsearch"
        • "r4.2xlarge.elasticsearch"
        • "r4.4xlarge.elasticsearch"
        • "r4.8xlarge.elasticsearch"
        • "r4.16xlarge.elasticsearch"
        • "i3.large.elasticsearch"
        • "i3.xlarge.elasticsearch"
        • "i3.2xlarge.elasticsearch"
        • "i3.4xlarge.elasticsearch"
        • "i3.8xlarge.elasticsearch"
        • "i3.16xlarge.elasticsearch"
      • 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 About Dedicated Master Nodes for more information.

      • ZoneAwarenessEnabled — (Boolean)

        A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

      • ZoneAwarenessConfig — (map)

        Specifies 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.elasticsearch"
        • "m3.large.elasticsearch"
        • "m3.xlarge.elasticsearch"
        • "m3.2xlarge.elasticsearch"
        • "m4.large.elasticsearch"
        • "m4.xlarge.elasticsearch"
        • "m4.2xlarge.elasticsearch"
        • "m4.4xlarge.elasticsearch"
        • "m4.10xlarge.elasticsearch"
        • "m5.large.elasticsearch"
        • "m5.xlarge.elasticsearch"
        • "m5.2xlarge.elasticsearch"
        • "m5.4xlarge.elasticsearch"
        • "m5.12xlarge.elasticsearch"
        • "r5.large.elasticsearch"
        • "r5.xlarge.elasticsearch"
        • "r5.2xlarge.elasticsearch"
        • "r5.4xlarge.elasticsearch"
        • "r5.12xlarge.elasticsearch"
        • "c5.large.elasticsearch"
        • "c5.xlarge.elasticsearch"
        • "c5.2xlarge.elasticsearch"
        • "c5.4xlarge.elasticsearch"
        • "c5.9xlarge.elasticsearch"
        • "c5.18xlarge.elasticsearch"
        • "ultrawarm1.medium.elasticsearch"
        • "ultrawarm1.large.elasticsearch"
        • "t2.micro.elasticsearch"
        • "t2.small.elasticsearch"
        • "t2.medium.elasticsearch"
        • "r3.large.elasticsearch"
        • "r3.xlarge.elasticsearch"
        • "r3.2xlarge.elasticsearch"
        • "r3.4xlarge.elasticsearch"
        • "r3.8xlarge.elasticsearch"
        • "i2.xlarge.elasticsearch"
        • "i2.2xlarge.elasticsearch"
        • "d2.xlarge.elasticsearch"
        • "d2.2xlarge.elasticsearch"
        • "d2.4xlarge.elasticsearch"
        • "d2.8xlarge.elasticsearch"
        • "c4.large.elasticsearch"
        • "c4.xlarge.elasticsearch"
        • "c4.2xlarge.elasticsearch"
        • "c4.4xlarge.elasticsearch"
        • "c4.8xlarge.elasticsearch"
        • "r4.large.elasticsearch"
        • "r4.xlarge.elasticsearch"
        • "r4.2xlarge.elasticsearch"
        • "r4.4xlarge.elasticsearch"
        • "r4.8xlarge.elasticsearch"
        • "r4.16xlarge.elasticsearch"
        • "i3.large.elasticsearch"
        • "i3.xlarge.elasticsearch"
        • "i3.2xlarge.elasticsearch"
        • "i3.4xlarge.elasticsearch"
        • "i3.8xlarge.elasticsearch"
        • "i3.16xlarge.elasticsearch"
      • DedicatedMasterCount — (Integer)

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

      • WarmEnabled — (Boolean)

        True to enable warm storage.

      • WarmType — (String)

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

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

        The number of warm nodes in the cluster.

      • ColdStorageOptions — (map)

        Specifies the ColdStorageOptions config for Elasticsearch Domain

        • Enabled — required — (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)

        Specifies whether EBS-based storage is enabled.

      • VolumeType — (String)

        Specifies the volume type for EBS-based storage.

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

        Integer to specify the size of an EBS volume.

      • Iops — (Integer)

        Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

      • Throughput — (Integer)

        Specifies the Throughput for GP3 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)

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

    • VPCOptions — (map)

      Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

      • SubnetIds — (Array<String>)

        Specifies the subnets for VPC endpoint.

      • SecurityGroupIds — (Array<String>)

        Specifies the security groups for VPC endpoint.

    • CognitoOptions — (map)

      Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

      • Enabled — (Boolean)

        Specifies the option to enable Cognito for Kibana authentication.

      • UserPoolId — (String)

        Specifies the Cognito user pool ID for Kibana authentication.

      • IdentityPoolId — (String)

        Specifies the Cognito identity pool ID for Kibana authentication.

      • RoleArn — (String)

        Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

    • EncryptionAtRestOptions — (map)

      Specifies the Encryption At Rest Options.

      • Enabled — (Boolean)

        Specifies the option to enable Encryption At Rest.

      • KmsKeyId — (String)

        Specifies the KMS Key ID for Encryption At Rest options.

    • NodeToNodeEncryptionOptions — (map)

      Specifies the NodeToNodeEncryptionOptions.

      • Enabled — (Boolean)

        Specify 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 Configuration Advanced Options for more information.

    • LogPublishingOptions — (map<map>)

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

      • CloudWatchLogsLogGroupArn — (String)

        ARN of the Cloudwatch log group to which log needs to be published.

      • Enabled — (Boolean)

        Specifies whether given log publishing option is enabled or not.

    • DomainEndpointOptions — (map)

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

      • EnforceHTTPS — (Boolean)

        Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

      • TLSSecurityPolicy — (String)

        Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
        It can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
        • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
        • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

        Specify if custom endpoint should be enabled for the Elasticsearch domain.

      • CustomEndpoint — (String)

        Specify the fully qualified domain for your custom endpoint.

      • CustomEndpointCertificateArn — (String)

        Specify 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 Elasticsearch Service domain's internal database.

        • MasterUserPassword — (String)

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

      • SAMLOptions — (map)

        Specifies the SAML application configuration for the domain.

        • Enabled — (Boolean)

          True if SAML is enabled.

        • Idp — (map)

          Specifies the SAML Identity Provider's information.

          • MetadataContent — required — (String)

            The Metadata of the SAML application in xml format.

          • EntityId — required — (String)

            The unique Entity ID of the application in SAML Identity Provider.

        • MasterUserName — (String)

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

        • MasterBackendRole — (String)

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

        • SubjectKey — (String)

          The key to use for matching the SAML Subject attribute.

        • RolesKey — (String)

          The key to use for matching the SAML Roles attribute.

        • SessionTimeoutMinutes — (Integer)

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

      • AnonymousAuthEnabled — (Boolean)

        True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

    • AutoTuneOptions — (map)

      Specifies Auto-Tune options.

      • DesiredState — (String)

        Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

        Specifies list of maitenance schedules. See the Developer Guide for more information.

        • StartAt — (Date)

          Specifies timestamp at which Auto-Tune maintenance schedule start.

        • Duration — (map)

          Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

          • Value — (Integer)

            Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

          • Unit — (String)

            Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

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

          Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

    • TagList — (Array<map>)

      A list of Tag added during domain creation.

      • Key — required — (String)

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

      • Value — required — (String)

        Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not 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. The data object has the following properties:

      • DomainStatus — (map)

        The status of the newly created Elasticsearch domain.

        • DomainId — required — (String)

          The unique identifier for the specified Elasticsearch domain.

        • DomainName — required — (String)

          The name of an Elasticsearch 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).

        • ARN — required — (String)

          The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of an Elasticsearch 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 Elasticsearch domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the Elasticsearch 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 Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

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

        • ElasticsearchVersion — (String)
        • ElasticsearchClusterConfig — required — (map)

          The type and number of instances in the domain cluster.

          • InstanceType — (String)

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

            Possible values include:
            • "m3.medium.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • 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 About Dedicated Master Nodes for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

          • ZoneAwarenessConfig — (map)

            Specifies 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.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • DedicatedMasterCount — (Integer)

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

          • WarmEnabled — (Boolean)

            True to enable warm storage.

          • WarmType — (String)

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

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

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for Elasticsearch Domain

            • Enabled — required — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

          • EBSEnabled — (Boolean)

            Specifies whether EBS-based storage is enabled.

          • VolumeType — (String)

            Specifies the volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

          • Throughput — (Integer)

            Specifies the Throughput for GP3 EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          Specifies the status of the SnapshotOptions

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

          • VPCId — (String)

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

          • SubnetIds — (Array<String>)

            Specifies the subnets for VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            Specifies the security groups for VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

          • Enabled — (Boolean)

            Specifies the option to enable Cognito for Kibana authentication.

          • UserPoolId — (String)

            Specifies the Cognito user pool ID for Kibana authentication.

          • IdentityPoolId — (String)

            Specifies the Cognito identity pool ID for Kibana authentication.

          • RoleArn — (String)

            Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          Specifies the status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            Specifies the option to enable Encryption At Rest.

          • KmsKeyId — (String)

            Specifies the KMS Key ID for Encryption At Rest options.

        • NodeToNodeEncryptionOptions — (map)

          Specifies the status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            Specify true to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Specifies the status of the AdvancedOptions

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to which log needs to be published.

          • Enabled — (Boolean)

            Specifies whether given log publishing option is enabled or not.

        • ServiceSoftwareOptions — (map)

          The current status of the Elasticsearch domain's service software.

          • CurrentVersion — (String)

            The current service software version that is present on the domain.

          • NewVersion — (String)

            The new service software version if one is available.

          • UpdateAvailable — (Boolean)

            True if you are able to update you service software version. False if you are not able to update your service software version.

          • Cancellable — (Boolean)

            True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

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

            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 Elasticsearch domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
            It can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
            • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
            • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

            Specify if custom endpoint should be enabled for the Elasticsearch domain.

          • CustomEndpoint — (String)

            Specify the fully qualified domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            Specify ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

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

              • MetadataContent — required — (String)

                The Metadata of the SAML application in xml format.

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

          • AnonymousAuthDisableDate — (Date)

            Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

          • AnonymousAuthEnabled — (Boolean)

            True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

        • AutoTuneOptions — (map)

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

          • State — (String)

            Specifies the AutoTuneState for the Elasticsearch 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)

            Specifies the error message while enabling or disabling the Auto-Tune.

        • ChangeProgressDetails — (map)

          Specifies change details of the domain configuration change.

          • ChangeId — (String)

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

          • Message — (String)

            Contains an optional message associated with the domain configuration change.

          • ConfigChangeStatus — (String)

            The current status of the configuration change.

            Possible values include:
            • "Pending"
            • "Initializing"
            • "Validating"
            • "ValidationFailed"
            • "ApplyingChanges"
            • "Completed"
            • "PendingUserInput"
            • "Cancelled"
          • StartTime — (Date)

            The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

          • LastUpdatedTime — (Date)

            The last time that the configuration change was updated.

          • InitiatedBy — (String)

            The IAM principal who initiated the configuration change.

            Possible values include:
            • "CUSTOMER"
            • "SERVICE"
        • DomainProcessingStatus — (String)

          The status of any changes that are currently in progress for the domain.

          Possible values include:
          • "Creating"
          • "Active"
          • "Modifying"
          • "UpgradingEngineVersion"
          • "UpdatingServiceSoftware"
          • "Isolated"
          • "Deleting"
        • ModifyingProperties — (Array<map>)

          Information about the domain properties that are currently being modified.

          • Name — (String)

            The name of the property that is currently being modified.

          • ActiveValue — (String)

            The current value of the domain property that is being modified.

          • PendingValue — (String)

            The value that the property that is currently being modified will eventually have.

          • ValueType — (String)

            The type of value that is currently being modified. Properties can have two types:

            • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
            • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
            Possible values include:
            • "PLAIN_TEXT"
            • "STRINGIFIED_JSON"

Returns:

  • (AWS.Request) —

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

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

Creates a new cross-cluster search connection from a source domain to a destination domain.

Service Reference:

Examples:

Calling the createOutboundCrossClusterSearchConnection operation

var params = {
  ConnectionAlias: 'STRING_VALUE', /* required */
  DestinationDomainInfo: { /* required */
    DomainName: 'STRING_VALUE', /* required */
    OwnerId: 'STRING_VALUE',
    Region: 'STRING_VALUE'
  },
  SourceDomainInfo: { /* required */
    DomainName: 'STRING_VALUE', /* required */
    OwnerId: 'STRING_VALUE',
    Region: 'STRING_VALUE'
  }
};
es.createOutboundCrossClusterSearchConnection(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: {}) —
    • SourceDomainInfo — (map)

      Specifies the DomainInformation for the source Elasticsearch domain.

      • OwnerId — (String)
      • DomainName — required — (String)

        The name of an Elasticsearch 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)
    • DestinationDomainInfo — (map)

      Specifies the DomainInformation for the destination Elasticsearch domain.

      • OwnerId — (String)
      • DomainName — required — (String)

        The name of an Elasticsearch 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)

      Specifies the connection alias that will be used by the customer for this 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:

      • SourceDomainInfo — (map)

        Specifies the DomainInformation for the source Elasticsearch domain.

        • OwnerId — (String)
        • DomainName — required — (String)

          The name of an Elasticsearch 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)
      • DestinationDomainInfo — (map)

        Specifies the DomainInformation for the destination Elasticsearch domain.

        • OwnerId — (String)
        • DomainName — required — (String)

          The name of an Elasticsearch 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)

        Specifies the connection alias provided during the create connection request.

      • ConnectionStatus — (map)

        Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.

        • StatusCode — (String)

          The state code for outbound connection. This 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 destination domain owner.
          • PROVISIONING: Outbound connection request is in process.
          • ACTIVE: Outbound connection is active and ready to use.
          • REJECTED: Outbound connection request is rejected by destination domain owner.
          • DELETING: Outbound connection deletion is in progress.
          • DELETED: Outbound connection is deleted and cannot be used further.
          Possible values include:
          • "PENDING_ACCEPTANCE"
          • "VALIDATING"
          • "VALIDATION_FAILED"
          • "PROVISIONING"
          • "ACTIVE"
          • "REJECTED"
          • "DELETING"
          • "DELETED"
        • Message — (String)

          Specifies verbose information for the outbound connection status.

      • CrossClusterSearchConnectionId — (String)

        Unique id for the created outbound connection, which is used for subsequent operations on 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 ES 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'
};
es.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 customer S3 location PackageSource for importing the package.

      • S3BucketName — (String)

        Name of the 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 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/DELETE_FAILED

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

          Timestamp which tells creation date of the package.

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

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

Creates an Amazon OpenSearch Service-managed VPC endpoint.

Service Reference:

Examples:

Calling the createVpcEndpoint operation

var params = {
  DomainArn: 'STRING_VALUE', /* required */
  VpcOptions: { /* required */
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  },
  ClientToken: 'STRING_VALUE'
};
es.createVpcEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

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

    • VpcOptions — (map)

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

      • SubnetIds — (Array<String>)

        Specifies the subnets for VPC endpoint.

      • SecurityGroupIds — (Array<String>)

        Specifies the security groups for VPC endpoint.

    • ClientToken — (String)

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • VpcEndpoint — (map)

        Information about the newly created VPC endpoint.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

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

        • VpcOptions — (map)

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

          • VPCId — (String)

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

          • SubnetIds — (Array<String>)

            Specifies the subnets for VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            Specifies the security groups for VPC endpoint.

        • Status — (String)

          The current status of the endpoint.

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

          The connection endpoint ID for connecting to the domain.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the deleteElasticsearchDomain operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
es.deleteElasticsearchDomain(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 Elasticsearch domain that 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 Elasticsearch domain being deleted.

        • DomainId — required — (String)

          The unique identifier for the specified Elasticsearch domain.

        • DomainName — required — (String)

          The name of an Elasticsearch 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).

        • ARN — required — (String)

          The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of an Elasticsearch 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 Elasticsearch domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the Elasticsearch 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 Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

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

        • ElasticsearchVersion — (String)
        • ElasticsearchClusterConfig — required — (map)

          The type and number of instances in the domain cluster.

          • InstanceType — (String)

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

            Possible values include:
            • "m3.medium.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • 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 About Dedicated Master Nodes for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

          • ZoneAwarenessConfig — (map)

            Specifies 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.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • DedicatedMasterCount — (Integer)

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

          • WarmEnabled — (Boolean)

            True to enable warm storage.

          • WarmType — (String)

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

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

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for Elasticsearch Domain

            • Enabled — required — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

          • EBSEnabled — (Boolean)

            Specifies whether EBS-based storage is enabled.

          • VolumeType — (String)

            Specifies the volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

          • Throughput — (Integer)

            Specifies the Throughput for GP3 EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          Specifies the status of the SnapshotOptions

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

          • VPCId — (String)

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

          • SubnetIds — (Array<String>)

            Specifies the subnets for VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            Specifies the security groups for VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

          • Enabled — (Boolean)

            Specifies the option to enable Cognito for Kibana authentication.

          • UserPoolId — (String)

            Specifies the Cognito user pool ID for Kibana authentication.

          • IdentityPoolId — (String)

            Specifies the Cognito identity pool ID for Kibana authentication.

          • RoleArn — (String)

            Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          Specifies the status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            Specifies the option to enable Encryption At Rest.

          • KmsKeyId — (String)

            Specifies the KMS Key ID for Encryption At Rest options.

        • NodeToNodeEncryptionOptions — (map)

          Specifies the status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            Specify true to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Specifies the status of the AdvancedOptions

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to which log needs to be published.

          • Enabled — (Boolean)

            Specifies whether given log publishing option is enabled or not.

        • ServiceSoftwareOptions — (map)

          The current status of the Elasticsearch domain's service software.

          • CurrentVersion — (String)

            The current service software version that is present on the domain.

          • NewVersion — (String)

            The new service software version if one is available.

          • UpdateAvailable — (Boolean)

            True if you are able to update you service software version. False if you are not able to update your service software version.

          • Cancellable — (Boolean)

            True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

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

            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 Elasticsearch domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
            It can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
            • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
            • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

            Specify if custom endpoint should be enabled for the Elasticsearch domain.

          • CustomEndpoint — (String)

            Specify the fully qualified domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            Specify ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

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

              • MetadataContent — required — (String)

                The Metadata of the SAML application in xml format.

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

          • AnonymousAuthDisableDate — (Date)

            Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

          • AnonymousAuthEnabled — (Boolean)

            True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

        • AutoTuneOptions — (map)

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

          • State — (String)

            Specifies the AutoTuneState for the Elasticsearch 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)

            Specifies the error message while enabling or disabling the Auto-Tune.

        • ChangeProgressDetails — (map)

          Specifies change details of the domain configuration change.

          • ChangeId — (String)

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

          • Message — (String)

            Contains an optional message associated with the domain configuration change.

          • ConfigChangeStatus — (String)

            The current status of the configuration change.

            Possible values include:
            • "Pending"
            • "Initializing"
            • "Validating"
            • "ValidationFailed"
            • "ApplyingChanges"
            • "Completed"
            • "PendingUserInput"
            • "Cancelled"
          • StartTime — (Date)

            The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

          • LastUpdatedTime — (Date)

            The last time that the configuration change was updated.

          • InitiatedBy — (String)

            The IAM principal who initiated the configuration change.

            Possible values include:
            • "CUSTOMER"
            • "SERVICE"
        • DomainProcessingStatus — (String)

          The status of any changes that are currently in progress for the domain.

          Possible values include:
          • "Creating"
          • "Active"
          • "Modifying"
          • "UpgradingEngineVersion"
          • "UpdatingServiceSoftware"
          • "Isolated"
          • "Deleting"
        • ModifyingProperties — (Array<map>)

          Information about the domain properties that are currently being modified.

          • Name — (String)

            The name of the property that is currently being modified.

          • ActiveValue — (String)

            The current value of the domain property that is being modified.

          • PendingValue — (String)

            The value that the property that is currently being modified will eventually have.

          • ValueType — (String)

            The type of value that is currently being modified. Properties can have two types:

            • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
            • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
            Possible values include:
            • "PLAIN_TEXT"
            • "STRINGIFIED_JSON"

Returns:

  • (AWS.Request) —

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

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

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.

Service Reference:

Examples:

Calling the deleteElasticsearchServiceRole operation

es.deleteElasticsearchServiceRole(function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the deleteInboundCrossClusterSearchConnection operation

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

      The id of the inbound connection that 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:

      • CrossClusterSearchConnection — (map)

        Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.

        • SourceDomainInfo — (map)

          Specifies the DomainInformation for the source Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • DestinationDomainInfo — (map)

          Specifies the DomainInformation for the destination Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • CrossClusterSearchConnectionId — (String)

          Specifies the connection id for the inbound cross-cluster search connection.

        • ConnectionStatus — (map)

          Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for inbound connection. This can be one of the following:

            • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
            • APPROVED: Inbound connection is pending acceptance by destination domain owner.
            • 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 cannot be used further.
            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Specifies verbose information for the inbound connection status.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the deleteOutboundCrossClusterSearchConnection operation

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

      The id of the outbound connection that 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:

      • CrossClusterSearchConnection — (map)

        Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.

        • SourceDomainInfo — (map)

          Specifies the DomainInformation for the source Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • DestinationDomainInfo — (map)

          Specifies the DomainInformation for the destination Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • CrossClusterSearchConnectionId — (String)

          Specifies the connection id for the outbound cross-cluster search connection.

        • ConnectionAlias — (String)

          Specifies the connection alias for the outbound cross-cluster search connection.

        • ConnectionStatus — (map)

          Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for outbound connection. This 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 destination domain owner.
            • PROVISIONING: Outbound connection request is in process.
            • ACTIVE: Outbound connection is active and ready to use.
            • REJECTED: Outbound connection request is rejected by destination domain owner.
            • DELETING: Outbound connection deletion is in progress.
            • DELETED: Outbound connection is deleted and cannot be used further.
            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "VALIDATING"
            • "VALIDATION_FAILED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Specifies 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

Delete the package.

Service Reference:

Examples:

Calling the deletePackage operation

var params = {
  PackageID: 'STRING_VALUE' /* required */
};
es.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)

      Internal ID of the package that 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/DELETE_FAILED

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

          Timestamp which tells creation date of the package.

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

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

Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.

Service Reference:

Examples:

Calling the deleteVpcEndpoint operation

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

Parameters:

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

      The unique identifier of the endpoint to be deleted.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • VpcEndpointSummary — (map)

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

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

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

        • Status — (String)

          The current status of the endpoint.

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

Returns:

  • (AWS.Request) —

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

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

Provides scheduled Auto-Tune action details for the Elasticsearch 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'
};
es.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)

      Specifies 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. It is 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>)

        Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.

        • AutoTuneType — (String)

          Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.

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

          Specifies details of the Auto-Tune action. See the Developer Guide for more information.

          • ScheduledAutoTuneDetails — (map)

            Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.

            • Date — (Date)

              Specifies timestamp for the Auto-Tune action scheduled for the domain.

            • ActionType — (String)

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

              Specifies Auto-Tune action description.

            • Severity — (String)

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

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

        Specifies an identifier to allow retrieval of paginated results.

Returns:

  • (AWS.Request) —

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

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

Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.

Service Reference:

Examples:

Calling the describeDomainChangeProgress operation

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

Parameters:

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

      The domain you want to get the progress information about.

    • ChangeId — (String)

      The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • ChangeProgressStatus — (map)

        Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.

        • ChangeId — (String)

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

        • StartTime — (Date)

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

        • Status — (String)

          The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED

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

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

        • CompletedProperties — (Array<String>)

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

        • TotalNumberOfStages — (Integer)

          The total number of stages required for the configuration change.

        • ChangeProgressStages — (Array<map>)

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

          • Name — (String)

            The name of the specific progress stage.

          • Status — (String)

            The overall status of a specific progress stage.

          • Description — (String)

            The description of the progress stage.

          • LastUpdated — (Date)

            The last updated timestamp of the progress stage.

        • ConfigChangeStatus — (String)

          The current status of the configuration change.

          Possible values include:
          • "Pending"
          • "Initializing"
          • "Validating"
          • "ValidationFailed"
          • "ApplyingChanges"
          • "Completed"
          • "PendingUserInput"
          • "Cancelled"
        • LastUpdatedTime — (Date)

          The last time that the status of the configuration change was updated.

        • InitiatedBy — (String)

          The IAM principal who initiated the configuration change.

          Possible values include:
          • "CUSTOMER"
          • "SERVICE"

Returns:

  • (AWS.Request) —

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

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

Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.

Service Reference:

Examples:

Calling the describeElasticsearchDomain operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
es.describeElasticsearchDomain(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 Elasticsearch 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 Elasticsearch domain.

        • DomainId — required — (String)

          The unique identifier for the specified Elasticsearch domain.

        • DomainName — required — (String)

          The name of an Elasticsearch 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).

        • ARN — required — (String)

          The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of an Elasticsearch 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 Elasticsearch domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the Elasticsearch 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 Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

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

        • ElasticsearchVersion — (String)
        • ElasticsearchClusterConfig — required — (map)

          The type and number of instances in the domain cluster.

          • InstanceType — (String)

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

            Possible values include:
            • "m3.medium.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • 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 About Dedicated Master Nodes for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

          • ZoneAwarenessConfig — (map)

            Specifies 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.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • DedicatedMasterCount — (Integer)

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

          • WarmEnabled — (Boolean)

            True to enable warm storage.

          • WarmType — (String)

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

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

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for Elasticsearch Domain

            • Enabled — required — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

          • EBSEnabled — (Boolean)

            Specifies whether EBS-based storage is enabled.

          • VolumeType — (String)

            Specifies the volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

          • Throughput — (Integer)

            Specifies the Throughput for GP3 EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          Specifies the status of the SnapshotOptions

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

          • VPCId — (String)

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

          • SubnetIds — (Array<String>)

            Specifies the subnets for VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            Specifies the security groups for VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

          • Enabled — (Boolean)

            Specifies the option to enable Cognito for Kibana authentication.

          • UserPoolId — (String)

            Specifies the Cognito user pool ID for Kibana authentication.

          • IdentityPoolId — (String)

            Specifies the Cognito identity pool ID for Kibana authentication.

          • RoleArn — (String)

            Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          Specifies the status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            Specifies the option to enable Encryption At Rest.

          • KmsKeyId — (String)

            Specifies the KMS Key ID for Encryption At Rest options.

        • NodeToNodeEncryptionOptions — (map)

          Specifies the status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            Specify true to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Specifies the status of the AdvancedOptions

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to which log needs to be published.

          • Enabled — (Boolean)

            Specifies whether given log publishing option is enabled or not.

        • ServiceSoftwareOptions — (map)

          The current status of the Elasticsearch domain's service software.

          • CurrentVersion — (String)

            The current service software version that is present on the domain.

          • NewVersion — (String)

            The new service software version if one is available.

          • UpdateAvailable — (Boolean)

            True if you are able to update you service software version. False if you are not able to update your service software version.

          • Cancellable — (Boolean)

            True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

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

            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 Elasticsearch domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
            It can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
            • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
            • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

            Specify if custom endpoint should be enabled for the Elasticsearch domain.

          • CustomEndpoint — (String)

            Specify the fully qualified domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            Specify ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

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

              • MetadataContent — required — (String)

                The Metadata of the SAML application in xml format.

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

          • AnonymousAuthDisableDate — (Date)

            Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

          • AnonymousAuthEnabled — (Boolean)

            True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

        • AutoTuneOptions — (map)

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

          • State — (String)

            Specifies the AutoTuneState for the Elasticsearch 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)

            Specifies the error message while enabling or disabling the Auto-Tune.

        • ChangeProgressDetails — (map)

          Specifies change details of the domain configuration change.

          • ChangeId — (String)

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

          • Message — (String)

            Contains an optional message associated with the domain configuration change.

          • ConfigChangeStatus — (String)

            The current status of the configuration change.

            Possible values include:
            • "Pending"
            • "Initializing"
            • "Validating"
            • "ValidationFailed"
            • "ApplyingChanges"
            • "Completed"
            • "PendingUserInput"
            • "Cancelled"
          • StartTime — (Date)

            The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

          • LastUpdatedTime — (Date)

            The last time that the configuration change was updated.

          • InitiatedBy — (String)

            The IAM principal who initiated the configuration change.

            Possible values include:
            • "CUSTOMER"
            • "SERVICE"
        • DomainProcessingStatus — (String)

          The status of any changes that are currently in progress for the domain.

          Possible values include:
          • "Creating"
          • "Active"
          • "Modifying"
          • "UpgradingEngineVersion"
          • "UpdatingServiceSoftware"
          • "Isolated"
          • "Deleting"
        • ModifyingProperties — (Array<map>)

          Information about the domain properties that are currently being modified.

          • Name — (String)

            The name of the property that is currently being modified.

          • ActiveValue — (String)

            The current value of the domain property that is being modified.

          • PendingValue — (String)

            The value that the property that is currently being modified will eventually have.

          • ValueType — (String)

            The type of value that is currently being modified. Properties can have two types:

            • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
            • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
            Possible values include:
            • "PLAIN_TEXT"
            • "STRINGIFIED_JSON"

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the describeElasticsearchDomainConfig operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
es.describeElasticsearchDomainConfig(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 Elasticsearch domain that 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 DescribeElasticsearchDomainConfig request.

        • ElasticsearchVersion — (map)

          String of format X.Y to specify version for the Elasticsearch domain.

          • Options — required — (String)

            Specifies the Elasticsearch version for the specified Elasticsearch domain.

          • Status — required — (map)

            Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • ElasticsearchClusterConfig — (map)

          Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the cluster configuration for the specified Elasticsearch domain.

            • InstanceType — (String)

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

              Possible values include:
              • "m3.medium.elasticsearch"
              • "m3.large.elasticsearch"
              • "m3.xlarge.elasticsearch"
              • "m3.2xlarge.elasticsearch"
              • "m4.large.elasticsearch"
              • "m4.xlarge.elasticsearch"
              • "m4.2xlarge.elasticsearch"
              • "m4.4xlarge.elasticsearch"
              • "m4.10xlarge.elasticsearch"
              • "m5.large.elasticsearch"
              • "m5.xlarge.elasticsearch"
              • "m5.2xlarge.elasticsearch"
              • "m5.4xlarge.elasticsearch"
              • "m5.12xlarge.elasticsearch"
              • "r5.large.elasticsearch"
              • "r5.xlarge.elasticsearch"
              • "r5.2xlarge.elasticsearch"
              • "r5.4xlarge.elasticsearch"
              • "r5.12xlarge.elasticsearch"
              • "c5.large.elasticsearch"
              • "c5.xlarge.elasticsearch"
              • "c5.2xlarge.elasticsearch"
              • "c5.4xlarge.elasticsearch"
              • "c5.9xlarge.elasticsearch"
              • "c5.18xlarge.elasticsearch"
              • "ultrawarm1.medium.elasticsearch"
              • "ultrawarm1.large.elasticsearch"
              • "t2.micro.elasticsearch"
              • "t2.small.elasticsearch"
              • "t2.medium.elasticsearch"
              • "r3.large.elasticsearch"
              • "r3.xlarge.elasticsearch"
              • "r3.2xlarge.elasticsearch"
              • "r3.4xlarge.elasticsearch"
              • "r3.8xlarge.elasticsearch"
              • "i2.xlarge.elasticsearch"
              • "i2.2xlarge.elasticsearch"
              • "d2.xlarge.elasticsearch"
              • "d2.2xlarge.elasticsearch"
              • "d2.4xlarge.elasticsearch"
              • "d2.8xlarge.elasticsearch"
              • "c4.large.elasticsearch"
              • "c4.xlarge.elasticsearch"
              • "c4.2xlarge.elasticsearch"
              • "c4.4xlarge.elasticsearch"
              • "c4.8xlarge.elasticsearch"
              • "r4.large.elasticsearch"
              • "r4.xlarge.elasticsearch"
              • "r4.2xlarge.elasticsearch"
              • "r4.4xlarge.elasticsearch"
              • "r4.8xlarge.elasticsearch"
              • "r4.16xlarge.elasticsearch"
              • "i3.large.elasticsearch"
              • "i3.xlarge.elasticsearch"
              • "i3.2xlarge.elasticsearch"
              • "i3.4xlarge.elasticsearch"
              • "i3.8xlarge.elasticsearch"
              • "i3.16xlarge.elasticsearch"
            • 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 About Dedicated Master Nodes for more information.

            • ZoneAwarenessEnabled — (Boolean)

              A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

            • ZoneAwarenessConfig — (map)

              Specifies 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.elasticsearch"
              • "m3.large.elasticsearch"
              • "m3.xlarge.elasticsearch"
              • "m3.2xlarge.elasticsearch"
              • "m4.large.elasticsearch"
              • "m4.xlarge.elasticsearch"
              • "m4.2xlarge.elasticsearch"
              • "m4.4xlarge.elasticsearch"
              • "m4.10xlarge.elasticsearch"
              • "m5.large.elasticsearch"
              • "m5.xlarge.elasticsearch"
              • "m5.2xlarge.elasticsearch"
              • "m5.4xlarge.elasticsearch"
              • "m5.12xlarge.elasticsearch"
              • "r5.large.elasticsearch"
              • "r5.xlarge.elasticsearch"
              • "r5.2xlarge.elasticsearch"
              • "r5.4xlarge.elasticsearch"
              • "r5.12xlarge.elasticsearch"
              • "c5.large.elasticsearch"
              • "c5.xlarge.elasticsearch"
              • "c5.2xlarge.elasticsearch"
              • "c5.4xlarge.elasticsearch"
              • "c5.9xlarge.elasticsearch"
              • "c5.18xlarge.elasticsearch"
              • "ultrawarm1.medium.elasticsearch"
              • "ultrawarm1.large.elasticsearch"
              • "t2.micro.elasticsearch"
              • "t2.small.elasticsearch"
              • "t2.medium.elasticsearch"
              • "r3.large.elasticsearch"
              • "r3.xlarge.elasticsearch"
              • "r3.2xlarge.elasticsearch"
              • "r3.4xlarge.elasticsearch"
              • "r3.8xlarge.elasticsearch"
              • "i2.xlarge.elasticsearch"
              • "i2.2xlarge.elasticsearch"
              • "d2.xlarge.elasticsearch"
              • "d2.2xlarge.elasticsearch"
              • "d2.4xlarge.elasticsearch"
              • "d2.8xlarge.elasticsearch"
              • "c4.large.elasticsearch"
              • "c4.xlarge.elasticsearch"
              • "c4.2xlarge.elasticsearch"
              • "c4.4xlarge.elasticsearch"
              • "c4.8xlarge.elasticsearch"
              • "r4.large.elasticsearch"
              • "r4.xlarge.elasticsearch"
              • "r4.2xlarge.elasticsearch"
              • "r4.4xlarge.elasticsearch"
              • "r4.8xlarge.elasticsearch"
              • "r4.16xlarge.elasticsearch"
              • "i3.large.elasticsearch"
              • "i3.xlarge.elasticsearch"
              • "i3.2xlarge.elasticsearch"
              • "i3.4xlarge.elasticsearch"
              • "i3.8xlarge.elasticsearch"
              • "i3.16xlarge.elasticsearch"
            • DedicatedMasterCount — (Integer)

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

            • WarmEnabled — (Boolean)

              True to enable warm storage.

            • WarmType — (String)

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

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

              The number of warm nodes in the cluster.

            • ColdStorageOptions — (map)

              Specifies the ColdStorageOptions config for Elasticsearch Domain

              • Enabled — required — (Boolean)

                Enable cold storage option. Accepted values true or false

          • Status — required — (map)

            Specifies the status of the configuration for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • EBSOptions — (map)

          Specifies the EBSOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the EBS options for the specified Elasticsearch domain.

            • EBSEnabled — (Boolean)

              Specifies whether EBS-based storage is enabled.

            • VolumeType — (String)

              Specifies the volume type for EBS-based storage.

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

              Integer to specify the size of an EBS volume.

            • Iops — (Integer)

              Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

            • Throughput — (Integer)

              Specifies the Throughput for GP3 EBS volume (SSD).

          • Status — required — (map)

            Specifies the status of the EBS options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AccessPolicies — (map)

          IAM access policy as a JSON-formatted string.

          • Options — required — (String)

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

          • Status — required — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • SnapshotOptions — (map)

          Specifies the SnapshotOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the daily snapshot options specified for the Elasticsearch domain.

            • AutomatedSnapshotStartHour — (Integer)

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

          • Status — required — (map)

            Specifies the status of a daily automated snapshot.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

          • Options — required — (map)

            Specifies the VPC options for the specified Elasticsearch domain.

            • VPCId — (String)

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

            • SubnetIds — (Array<String>)

              Specifies the subnets for VPC endpoint.

            • AvailabilityZones — (Array<String>)

              The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

            • SecurityGroupIds — (Array<String>)

              Specifies the security groups for VPC endpoint.

          • Status — required — (map)

            Specifies the status of the VPC options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

          • Options — required — (map)

            Specifies the Cognito options for the specified Elasticsearch domain.

            • Enabled — (Boolean)

              Specifies the option to enable Cognito for Kibana authentication.

            • UserPoolId — (String)

              Specifies the Cognito user pool ID for Kibana authentication.

            • IdentityPoolId — (String)

              Specifies the Cognito identity pool ID for Kibana authentication.

            • RoleArn — (String)

              Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

          • Status — required — (map)

            Specifies the status of the Cognito options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • EncryptionAtRestOptions — (map)

          Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the Encryption At Rest options for the specified Elasticsearch domain.

            • Enabled — (Boolean)

              Specifies the option to enable Encryption At Rest.

            • KmsKeyId — (String)

              Specifies the KMS Key ID for Encryption At Rest options.

          • Status — required — (map)

            Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • NodeToNodeEncryptionOptions — (map)

          Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the node-to-node encryption options for the specified Elasticsearch domain.

            • Enabled — (Boolean)

              Specify true to enable node-to-node encryption.

          • Status — required — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AdvancedOptions — (map)

          Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

          • Options — required — (map<String>)

            Specifies the status of advanced options for the specified Elasticsearch domain.

          • Status — required — (map)

            Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • LogPublishingOptions — (map)

          Log publishing options for the given domain.

          • Options — (map<map>)

            The log publishing options configured for the Elasticsearch domain.

            • CloudWatchLogsLogGroupArn — (String)

              ARN of the Cloudwatch log group to which log needs to be published.

            • Enabled — (Boolean)

              Specifies whether given log publishing option is enabled or not.

          • Status — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • DomainEndpointOptions — (map)

          Specifies the DomainEndpointOptions for the Elasticsearch domain.

          • Options — required — (map)

            Options to configure endpoint for the Elasticsearch domain.

            • EnforceHTTPS — (Boolean)

              Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

            • TLSSecurityPolicy — (String)

              Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
              It can be one of the following values:

              • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
              • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
              • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

              Specify if custom endpoint should be enabled for the Elasticsearch domain.

            • CustomEndpoint — (String)

              Specify the fully qualified domain for your custom endpoint.

            • CustomEndpointCertificateArn — (String)

              Specify ACM certificate ARN for your custom endpoint.

          • Status — required — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AdvancedSecurityOptions — (map)

          Specifies AdvancedSecurityOptions for the domain.

          • Options — required — (map)

            Specifies advanced security options for the specified Elasticsearch 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.

                • MetadataContent — required — (String)

                  The Metadata of the SAML application in xml format.

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

            • AnonymousAuthDisableDate — (Date)

              Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

            • AnonymousAuthEnabled — (Boolean)

              True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

          • Status — required — (map)

            Status of the advanced security options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AutoTuneOptions — (map)

          Specifies AutoTuneOptions for the domain.

          • Options — (map)

            Specifies Auto-Tune options for the specified Elasticsearch domain.

            • DesiredState — (String)

              Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

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

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

              Specifies list of maitenance schedules. See the Developer Guide for more information.

              • StartAt — (Date)

                Specifies timestamp at which Auto-Tune maintenance schedule start.

              • Duration — (map)

                Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

                • Value — (Integer)

                  Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

                • Unit — (String)

                  Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

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

                Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

          • Status — (map)

            Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells Auto-Tune options creation date .

            • UpdateDate — required — (Date)

              Timestamp which tells Auto-Tune options last updated time.

            • UpdateVersion — (Integer)

              Specifies the Auto-Tune options latest version.

            • State — required — (String)

              Specifies the AutoTuneState for the Elasticsearch 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)

              Specifies the error message while enabling or disabling the Auto-Tune options.

            • PendingDeletion — (Boolean)

              Indicates whether the Elasticsearch domain is being deleted.

        • ChangeProgressDetails — (map)

          Specifies change details of the domain configuration change.

          • ChangeId — (String)

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

          • Message — (String)

            Contains an optional message associated with the domain configuration change.

          • ConfigChangeStatus — (String)

            The current status of the configuration change.

            Possible values include:
            • "Pending"
            • "Initializing"
            • "Validating"
            • "ValidationFailed"
            • "ApplyingChanges"
            • "Completed"
            • "PendingUserInput"
            • "Cancelled"
          • StartTime — (Date)

            The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

          • LastUpdatedTime — (Date)

            The last time that the configuration change was updated.

          • InitiatedBy — (String)

            The IAM principal who initiated the configuration change.

            Possible values include:
            • "CUSTOMER"
            • "SERVICE"
        • ModifyingProperties — (Array<map>)

          Information about the domain properties that are currently being modified.

          • Name — (String)

            The name of the property that is currently being modified.

          • ActiveValue — (String)

            The current value of the domain property that is being modified.

          • PendingValue — (String)

            The value that the property that is currently being modified will eventually have.

          • ValueType — (String)

            The type of value that is currently being modified. Properties can have two types:

            • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
            • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
            Possible values include:
            • "PLAIN_TEXT"
            • "STRINGIFIED_JSON"

Returns:

  • (AWS.Request) —

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

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

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

Service Reference:

Examples:

Calling the describeElasticsearchDomains operation

var params = {
  DomainNames: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
es.describeElasticsearchDomains(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 Elasticsearch 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 DescribeElasticsearchDomains request.

        • DomainId — required — (String)

          The unique identifier for the specified Elasticsearch domain.

        • DomainName — required — (String)

          The name of an Elasticsearch 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).

        • ARN — required — (String)

          The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.

        • Created — (Boolean)

          The domain creation status. True if the creation of an Elasticsearch 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 Elasticsearch domain endpoint that you use to submit index and search requests.

        • Endpoints — (map<String>)

          Map containing the Elasticsearch 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 Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.

        • UpgradeProcessing — (Boolean)

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

        • ElasticsearchVersion — (String)
        • ElasticsearchClusterConfig — required — (map)

          The type and number of instances in the domain cluster.

          • InstanceType — (String)

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

            Possible values include:
            • "m3.medium.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • 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 About Dedicated Master Nodes for more information.

          • ZoneAwarenessEnabled — (Boolean)

            A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

          • ZoneAwarenessConfig — (map)

            Specifies 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.elasticsearch"
            • "m3.large.elasticsearch"
            • "m3.xlarge.elasticsearch"
            • "m3.2xlarge.elasticsearch"
            • "m4.large.elasticsearch"
            • "m4.xlarge.elasticsearch"
            • "m4.2xlarge.elasticsearch"
            • "m4.4xlarge.elasticsearch"
            • "m4.10xlarge.elasticsearch"
            • "m5.large.elasticsearch"
            • "m5.xlarge.elasticsearch"
            • "m5.2xlarge.elasticsearch"
            • "m5.4xlarge.elasticsearch"
            • "m5.12xlarge.elasticsearch"
            • "r5.large.elasticsearch"
            • "r5.xlarge.elasticsearch"
            • "r5.2xlarge.elasticsearch"
            • "r5.4xlarge.elasticsearch"
            • "r5.12xlarge.elasticsearch"
            • "c5.large.elasticsearch"
            • "c5.xlarge.elasticsearch"
            • "c5.2xlarge.elasticsearch"
            • "c5.4xlarge.elasticsearch"
            • "c5.9xlarge.elasticsearch"
            • "c5.18xlarge.elasticsearch"
            • "ultrawarm1.medium.elasticsearch"
            • "ultrawarm1.large.elasticsearch"
            • "t2.micro.elasticsearch"
            • "t2.small.elasticsearch"
            • "t2.medium.elasticsearch"
            • "r3.large.elasticsearch"
            • "r3.xlarge.elasticsearch"
            • "r3.2xlarge.elasticsearch"
            • "r3.4xlarge.elasticsearch"
            • "r3.8xlarge.elasticsearch"
            • "i2.xlarge.elasticsearch"
            • "i2.2xlarge.elasticsearch"
            • "d2.xlarge.elasticsearch"
            • "d2.2xlarge.elasticsearch"
            • "d2.4xlarge.elasticsearch"
            • "d2.8xlarge.elasticsearch"
            • "c4.large.elasticsearch"
            • "c4.xlarge.elasticsearch"
            • "c4.2xlarge.elasticsearch"
            • "c4.4xlarge.elasticsearch"
            • "c4.8xlarge.elasticsearch"
            • "r4.large.elasticsearch"
            • "r4.xlarge.elasticsearch"
            • "r4.2xlarge.elasticsearch"
            • "r4.4xlarge.elasticsearch"
            • "r4.8xlarge.elasticsearch"
            • "r4.16xlarge.elasticsearch"
            • "i3.large.elasticsearch"
            • "i3.xlarge.elasticsearch"
            • "i3.2xlarge.elasticsearch"
            • "i3.4xlarge.elasticsearch"
            • "i3.8xlarge.elasticsearch"
            • "i3.16xlarge.elasticsearch"
          • DedicatedMasterCount — (Integer)

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

          • WarmEnabled — (Boolean)

            True to enable warm storage.

          • WarmType — (String)

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

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

            The number of warm nodes in the cluster.

          • ColdStorageOptions — (map)

            Specifies the ColdStorageOptions config for Elasticsearch Domain

            • Enabled — required — (Boolean)

              Enable cold storage option. Accepted values true or false

        • EBSOptions — (map)

          The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.

          • EBSEnabled — (Boolean)

            Specifies whether EBS-based storage is enabled.

          • VolumeType — (String)

            Specifies the volume type for EBS-based storage.

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

            Integer to specify the size of an EBS volume.

          • Iops — (Integer)

            Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

          • Throughput — (Integer)

            Specifies the Throughput for GP3 EBS volume (SSD).

        • AccessPolicies — (String)

          IAM access policy as a JSON-formatted string.

        • SnapshotOptions — (map)

          Specifies the status of the SnapshotOptions

          • AutomatedSnapshotStartHour — (Integer)

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

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

          • VPCId — (String)

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

          • SubnetIds — (Array<String>)

            Specifies the subnets for VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            Specifies the security groups for VPC endpoint.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

          • Enabled — (Boolean)

            Specifies the option to enable Cognito for Kibana authentication.

          • UserPoolId — (String)

            Specifies the Cognito user pool ID for Kibana authentication.

          • IdentityPoolId — (String)

            Specifies the Cognito identity pool ID for Kibana authentication.

          • RoleArn — (String)

            Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

        • EncryptionAtRestOptions — (map)

          Specifies the status of the EncryptionAtRestOptions.

          • Enabled — (Boolean)

            Specifies the option to enable Encryption At Rest.

          • KmsKeyId — (String)

            Specifies the KMS Key ID for Encryption At Rest options.

        • NodeToNodeEncryptionOptions — (map)

          Specifies the status of the NodeToNodeEncryptionOptions.

          • Enabled — (Boolean)

            Specify true to enable node-to-node encryption.

        • AdvancedOptions — (map<String>)

          Specifies the status of the AdvancedOptions

        • LogPublishingOptions — (map<map>)

          Log publishing options for the given domain.

          • CloudWatchLogsLogGroupArn — (String)

            ARN of the Cloudwatch log group to which log needs to be published.

          • Enabled — (Boolean)

            Specifies whether given log publishing option is enabled or not.

        • ServiceSoftwareOptions — (map)

          The current status of the Elasticsearch domain's service software.

          • CurrentVersion — (String)

            The current service software version that is present on the domain.

          • NewVersion — (String)

            The new service software version if one is available.

          • UpdateAvailable — (Boolean)

            True if you are able to update you service software version. False if you are not able to update your service software version.

          • Cancellable — (Boolean)

            True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

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

            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 Elasticsearch domain's endpoint options.

          • EnforceHTTPS — (Boolean)

            Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

          • TLSSecurityPolicy — (String)

            Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
            It can be one of the following values:

            • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
            • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
            • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

            Specify if custom endpoint should be enabled for the Elasticsearch domain.

          • CustomEndpoint — (String)

            Specify the fully qualified domain for your custom endpoint.

          • CustomEndpointCertificateArn — (String)

            Specify ACM certificate ARN for your custom endpoint.

        • AdvancedSecurityOptions — (map)

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

              • MetadataContent — required — (String)

                The Metadata of the SAML application in xml format.

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

          • AnonymousAuthDisableDate — (Date)

            Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

          • AnonymousAuthEnabled — (Boolean)

            True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

        • AutoTuneOptions — (map)

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

          • State — (String)

            Specifies the AutoTuneState for the Elasticsearch 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)

            Specifies the error message while enabling or disabling the Auto-Tune.

        • ChangeProgressDetails — (map)

          Specifies change details of the domain configuration change.

          • ChangeId — (String)

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

          • Message — (String)

            Contains an optional message associated with the domain configuration change.

          • ConfigChangeStatus — (String)

            The current status of the configuration change.

            Possible values include:
            • "Pending"
            • "Initializing"
            • "Validating"
            • "ValidationFailed"
            • "ApplyingChanges"
            • "Completed"
            • "PendingUserInput"
            • "Cancelled"
          • StartTime — (Date)

            The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

          • LastUpdatedTime — (Date)

            The last time that the configuration change was updated.

          • InitiatedBy — (String)

            The IAM principal who initiated the configuration change.

            Possible values include:
            • "CUSTOMER"
            • "SERVICE"
        • DomainProcessingStatus — (String)

          The status of any changes that are currently in progress for the domain.

          Possible values include:
          • "Creating"
          • "Active"
          • "Modifying"
          • "UpgradingEngineVersion"
          • "UpdatingServiceSoftware"
          • "Isolated"
          • "Deleting"
        • ModifyingProperties — (Array<map>)

          Information about the domain properties that are currently being modified.

          • Name — (String)

            The name of the property that is currently being modified.

          • ActiveValue — (String)

            The current value of the domain property that is being modified.

          • PendingValue — (String)

            The value that the property that is currently being modified will eventually have.

          • ValueType — (String)

            The type of value that is currently being modified. Properties can have two types:

            • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
            • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
            Possible values include:
            • "PLAIN_TEXT"
            • "STRINGIFIED_JSON"

Returns:

  • (AWS.Request) —

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

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

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.

Service Reference:

Examples:

Calling the describeElasticsearchInstanceTypeLimits operation

var params = {
  ElasticsearchVersion: 'STRING_VALUE', /* required */
  InstanceType: m3.medium.elasticsearch | m3.large.elasticsearch | m3.xlarge.elasticsearch | m3.2xlarge.elasticsearch | m4.large.elasticsearch | m4.xlarge.elasticsearch | m4.2xlarge.elasticsearch | m4.4xlarge.elasticsearch | m4.10xlarge.elasticsearch | m5.large.elasticsearch | m5.xlarge.elasticsearch | m5.2xlarge.elasticsearch | m5.4xlarge.elasticsearch | m5.12xlarge.elasticsearch | r5.large.elasticsearch | r5.xlarge.elasticsearch | r5.2xlarge.elasticsearch | r5.4xlarge.elasticsearch | r5.12xlarge.elasticsearch | c5.large.elasticsearch | c5.xlarge.elasticsearch | c5.2xlarge.elasticsearch | c5.4xlarge.elasticsearch | c5.9xlarge.elasticsearch | c5.18xlarge.elasticsearch | ultrawarm1.medium.elasticsearch | ultrawarm1.large.elasticsearch | t2.micro.elasticsearch | t2.small.elasticsearch | t2.medium.elasticsearch | r3.large.elasticsearch | r3.xlarge.elasticsearch | r3.2xlarge.elasticsearch | r3.4xlarge.elasticsearch | r3.8xlarge.elasticsearch | i2.xlarge.elasticsearch | i2.2xlarge.elasticsearch | d2.xlarge.elasticsearch | d2.2xlarge.elasticsearch | d2.4xlarge.elasticsearch | d2.8xlarge.elasticsearch | c4.large.elasticsearch | c4.xlarge.elasticsearch | c4.2xlarge.elasticsearch | c4.4xlarge.elasticsearch | c4.8xlarge.elasticsearch | r4.large.elasticsearch | r4.xlarge.elasticsearch | r4.2xlarge.elasticsearch | r4.4xlarge.elasticsearch | r4.8xlarge.elasticsearch | r4.16xlarge.elasticsearch | i3.large.elasticsearch | i3.xlarge.elasticsearch | i3.2xlarge.elasticsearch | i3.4xlarge.elasticsearch | i3.8xlarge.elasticsearch | i3.16xlarge.elasticsearch, /* required */
  DomainName: 'STRING_VALUE'
};
es.describeElasticsearchInstanceTypeLimits(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)

      DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.

    • InstanceType — (String)

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

      Possible values include:
      • "m3.medium.elasticsearch"
      • "m3.large.elasticsearch"
      • "m3.xlarge.elasticsearch"
      • "m3.2xlarge.elasticsearch"
      • "m4.large.elasticsearch"
      • "m4.xlarge.elasticsearch"
      • "m4.2xlarge.elasticsearch"
      • "m4.4xlarge.elasticsearch"
      • "m4.10xlarge.elasticsearch"
      • "m5.large.elasticsearch"
      • "m5.xlarge.elasticsearch"
      • "m5.2xlarge.elasticsearch"
      • "m5.4xlarge.elasticsearch"
      • "m5.12xlarge.elasticsearch"
      • "r5.large.elasticsearch"
      • "r5.xlarge.elasticsearch"
      • "r5.2xlarge.elasticsearch"
      • "r5.4xlarge.elasticsearch"
      • "r5.12xlarge.elasticsearch"
      • "c5.large.elasticsearch"
      • "c5.xlarge.elasticsearch"
      • "c5.2xlarge.elasticsearch"
      • "c5.4xlarge.elasticsearch"
      • "c5.9xlarge.elasticsearch"
      • "c5.18xlarge.elasticsearch"
      • "ultrawarm1.medium.elasticsearch"
      • "ultrawarm1.large.elasticsearch"
      • "t2.micro.elasticsearch"
      • "t2.small.elasticsearch"
      • "t2.medium.elasticsearch"
      • "r3.large.elasticsearch"
      • "r3.xlarge.elasticsearch"
      • "r3.2xlarge.elasticsearch"
      • "r3.4xlarge.elasticsearch"
      • "r3.8xlarge.elasticsearch"
      • "i2.xlarge.elasticsearch"
      • "i2.2xlarge.elasticsearch"
      • "d2.xlarge.elasticsearch"
      • "d2.2xlarge.elasticsearch"
      • "d2.4xlarge.elasticsearch"
      • "d2.8xlarge.elasticsearch"
      • "c4.large.elasticsearch"
      • "c4.xlarge.elasticsearch"
      • "c4.2xlarge.elasticsearch"
      • "c4.4xlarge.elasticsearch"
      • "c4.8xlarge.elasticsearch"
      • "r4.large.elasticsearch"
      • "r4.xlarge.elasticsearch"
      • "r4.2xlarge.elasticsearch"
      • "r4.4xlarge.elasticsearch"
      • "r4.8xlarge.elasticsearch"
      • "r4.16xlarge.elasticsearch"
      • "i3.large.elasticsearch"
      • "i3.xlarge.elasticsearch"
      • "i3.2xlarge.elasticsearch"
      • "i3.4xlarge.elasticsearch"
      • "i3.8xlarge.elasticsearch"
      • "i3.16xlarge.elasticsearch"
    • ElasticsearchVersion — (String)

      Version of Elasticsearch 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>)

        Map of Role of the Instance and Limits that are applicable. Role performed by given Instance in Elasticsearch can be one of the following:

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

        • StorageTypes — (Array<map>)

          StorageType represents the list of storage related types and attributes that are available for given InstanceType.

          • StorageTypeName — (String)

            Type of the storage. List of available storage options:

            1. instance
              2. Inbuilt storage available for the given Instance
            2. ebs
              3. Elastic block storage that would be attached to the given Instance

          • StorageSubTypeName — (String)

            SubType of the given storage type. List of available sub-storage options: For "instance" storageType we wont have any storageSubType, in case of "ebs" storageType we will have following valid storageSubTypes

            1. standard
            2. gp2
            3. gp3
            4. io1
            Refer VolumeType for more information regarding above EBS storage options.

          • StorageTypeLimits — (Array<map>)

            List of limits that are applicable for given storage type.

            • LimitName — (String)

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

              1. MinimumVolumeSize
                2. Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
              2. MaximumVolumeSize
                3. Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable.
              3. MaximumIops
                4. Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
              4. MinimumIops
                5. Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable.
              5. MaximumThroughput
                6. Maximum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
              6. MinimumThroughput
                7. Minimum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.

            • LimitValues — (Array<String>)

              Values for the StorageTypeLimit$LimitName .

        • InstanceLimits — (map)

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

          • InstanceCountLimits — (map)

            InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.

            • MinimumInstanceCount — (Integer)

              Minimum number of Instances that can be instantiated for given InstanceType.

            • MaximumInstanceCount — (Integer)

              Maximum number of Instances that can be instantiated for given InstanceType.

        • AdditionalLimits — (Array<map>)

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

          • LimitName — (String)

            Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc.
            Attributes and their details:

            • MaximumNumberOfDataNodesSupported
              • This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node.
            • MaximumNumberOfDataNodesWithoutMasterNode
              • This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don't need any master nodes to govern them.

          • LimitValues — (Array<String>)

            Value for given AdditionalLimit$LimitName .

Returns:

  • (AWS.Request) —

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

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

Lists all the inbound cross-cluster search connections for a destination domain.

Service Reference:

Examples:

Calling the describeInboundCrossClusterSearchConnections operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
es.describeInboundCrossClusterSearchConnections(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 search connection. Available Filter names for this operation are:

      • cross-cluster-search-connection-id
      • source-domain-info.domain-name
      • source-domain-info.owner-id
      • source-domain-info.region
      • destination-domain-info.domain-name

      • Name — (String)

        Specifies 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. It is 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:

      • CrossClusterSearchConnections — (Array<map>)

        Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.

        • SourceDomainInfo — (map)

          Specifies the DomainInformation for the source Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • DestinationDomainInfo — (map)

          Specifies the DomainInformation for the destination Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • CrossClusterSearchConnectionId — (String)

          Specifies the connection id for the inbound cross-cluster search connection.

        • ConnectionStatus — (map)

          Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for inbound connection. This can be one of the following:

            • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
            • APPROVED: Inbound connection is pending acceptance by destination domain owner.
            • 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 cannot be used further.
            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

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

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

Lists all the outbound cross-cluster search connections for a source domain.

Service Reference:

Examples:

Calling the describeOutboundCrossClusterSearchConnections operation

var params = {
  Filters: [
    {
      Name: 'STRING_VALUE',
      Values: [
        'STRING_VALUE',
        /* more items */
      ]
    },
    /* more items */
  ],
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
es.describeOutboundCrossClusterSearchConnections(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 search connection. Available Filter names for this operation are:

      • cross-cluster-search-connection-id
      • destination-domain-info.domain-name
      • destination-domain-info.owner-id
      • destination-domain-info.region
      • source-domain-info.domain-name

      • Name — (String)

        Specifies 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. It is 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:

      • CrossClusterSearchConnections — (Array<map>)

        Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.

        • SourceDomainInfo — (map)

          Specifies the DomainInformation for the source Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • DestinationDomainInfo — (map)

          Specifies the DomainInformation for the destination Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • CrossClusterSearchConnectionId — (String)

          Specifies the connection id for the outbound cross-cluster search connection.

        • ConnectionAlias — (String)

          Specifies the connection alias for the outbound cross-cluster search connection.

        • ConnectionStatus — (map)

          Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for outbound connection. This 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 destination domain owner.
            • PROVISIONING: Outbound connection request is in process.
            • ACTIVE: Outbound connection is active and ready to use.
            • REJECTED: Outbound connection request is rejected by destination domain owner.
            • DELETING: Outbound connection deletion is in progress.
            • DELETED: Outbound connection is deleted and cannot be used further.
            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "VALIDATING"
            • "VALIDATION_FAILED"
            • "PROVISIONING"
            • "ACTIVE"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Specifies 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 ES. 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'
};
es.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 non-empty 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/DELETE_FAILED

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

          Timestamp which tells creation date of the package.

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

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

Lists available reserved Elasticsearch instance offerings.

Service Reference:

Examples:

Calling the describeReservedElasticsearchInstanceOfferings operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ReservedElasticsearchInstanceOfferingId: 'STRING_VALUE'
};
es.describeReservedElasticsearchInstanceOfferings(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: {}) —
    • ReservedElasticsearchInstanceOfferingId — (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)

      NextToken should be sent in case if earlier API call produced result containing NextToken. It is 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:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ReservedElasticsearchInstanceOfferings — (Array<map>)

        List of reserved Elasticsearch instance offerings

        • ReservedElasticsearchInstanceOfferingId — (String)

          The Elasticsearch reserved instance offering identifier.

        • ElasticsearchInstanceType — (String)

          The Elasticsearch instance type offered by the reserved instance offering.

          Possible values include:
          • "m3.medium.elasticsearch"
          • "m3.large.elasticsearch"
          • "m3.xlarge.elasticsearch"
          • "m3.2xlarge.elasticsearch"
          • "m4.large.elasticsearch"
          • "m4.xlarge.elasticsearch"
          • "m4.2xlarge.elasticsearch"
          • "m4.4xlarge.elasticsearch"
          • "m4.10xlarge.elasticsearch"
          • "m5.large.elasticsearch"
          • "m5.xlarge.elasticsearch"
          • "m5.2xlarge.elasticsearch"
          • "m5.4xlarge.elasticsearch"
          • "m5.12xlarge.elasticsearch"
          • "r5.large.elasticsearch"
          • "r5.xlarge.elasticsearch"
          • "r5.2xlarge.elasticsearch"
          • "r5.4xlarge.elasticsearch"
          • "r5.12xlarge.elasticsearch"
          • "c5.large.elasticsearch"
          • "c5.xlarge.elasticsearch"
          • "c5.2xlarge.elasticsearch"
          • "c5.4xlarge.elasticsearch"
          • "c5.9xlarge.elasticsearch"
          • "c5.18xlarge.elasticsearch"
          • "ultrawarm1.medium.elasticsearch"
          • "ultrawarm1.large.elasticsearch"
          • "t2.micro.elasticsearch"
          • "t2.small.elasticsearch"
          • "t2.medium.elasticsearch"
          • "r3.large.elasticsearch"
          • "r3.xlarge.elasticsearch"
          • "r3.2xlarge.elasticsearch"
          • "r3.4xlarge.elasticsearch"
          • "r3.8xlarge.elasticsearch"
          • "i2.xlarge.elasticsearch"
          • "i2.2xlarge.elasticsearch"
          • "d2.xlarge.elasticsearch"
          • "d2.2xlarge.elasticsearch"
          • "d2.4xlarge.elasticsearch"
          • "d2.8xlarge.elasticsearch"
          • "c4.large.elasticsearch"
          • "c4.xlarge.elasticsearch"
          • "c4.2xlarge.elasticsearch"
          • "c4.4xlarge.elasticsearch"
          • "c4.8xlarge.elasticsearch"
          • "r4.large.elasticsearch"
          • "r4.xlarge.elasticsearch"
          • "r4.2xlarge.elasticsearch"
          • "r4.4xlarge.elasticsearch"
          • "r4.8xlarge.elasticsearch"
          • "r4.16xlarge.elasticsearch"
          • "i3.large.elasticsearch"
          • "i3.xlarge.elasticsearch"
          • "i3.2xlarge.elasticsearch"
          • "i3.4xlarge.elasticsearch"
          • "i3.8xlarge.elasticsearch"
          • "i3.16xlarge.elasticsearch"
        • Duration — (Integer)

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

        • FixedPrice — (Float)

          The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch 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 Elasticsearch instance offering.

        • PaymentOption — (String)

          Payment option for the reserved Elasticsearch 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.

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

Returns information about reserved Elasticsearch instances for this account.

Service Reference:

Examples:

Calling the describeReservedElasticsearchInstances operation

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

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

    • MaxResults — (Integer)

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

    • NextToken — (String)

      NextToken should be sent in case if earlier API call produced result containing NextToken. It is 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:

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

      • ReservedElasticsearchInstances — (Array<map>)

        List of reserved Elasticsearch instances.

        • ReservationName — (String)

          The customer-specified identifier to track this reservation.

        • ReservedElasticsearchInstanceId — (String)

          The unique identifier for the reservation.

        • ReservedElasticsearchInstanceOfferingId — (String)

          The offering identifier.

        • ElasticsearchInstanceType — (String)

          The Elasticsearch instance type offered by the reserved instance offering.

          Possible values include:
          • "m3.medium.elasticsearch"
          • "m3.large.elasticsearch"
          • "m3.xlarge.elasticsearch"
          • "m3.2xlarge.elasticsearch"
          • "m4.large.elasticsearch"
          • "m4.xlarge.elasticsearch"
          • "m4.2xlarge.elasticsearch"
          • "m4.4xlarge.elasticsearch"
          • "m4.10xlarge.elasticsearch"
          • "m5.large.elasticsearch"
          • "m5.xlarge.elasticsearch"
          • "m5.2xlarge.elasticsearch"
          • "m5.4xlarge.elasticsearch"
          • "m5.12xlarge.elasticsearch"
          • "r5.large.elasticsearch"
          • "r5.xlarge.elasticsearch"
          • "r5.2xlarge.elasticsearch"
          • "r5.4xlarge.elasticsearch"
          • "r5.12xlarge.elasticsearch"
          • "c5.large.elasticsearch"
          • "c5.xlarge.elasticsearch"
          • "c5.2xlarge.elasticsearch"
          • "c5.4xlarge.elasticsearch"
          • "c5.9xlarge.elasticsearch"
          • "c5.18xlarge.elasticsearch"
          • "ultrawarm1.medium.elasticsearch"
          • "ultrawarm1.large.elasticsearch"
          • "t2.micro.elasticsearch"
          • "t2.small.elasticsearch"
          • "t2.medium.elasticsearch"
          • "r3.large.elasticsearch"
          • "r3.xlarge.elasticsearch"
          • "r3.2xlarge.elasticsearch"
          • "r3.4xlarge.elasticsearch"
          • "r3.8xlarge.elasticsearch"
          • "i2.xlarge.elasticsearch"
          • "i2.2xlarge.elasticsearch"
          • "d2.xlarge.elasticsearch"
          • "d2.2xlarge.elasticsearch"
          • "d2.4xlarge.elasticsearch"
          • "d2.8xlarge.elasticsearch"
          • "c4.large.elasticsearch"
          • "c4.xlarge.elasticsearch"
          • "c4.2xlarge.elasticsearch"
          • "c4.4xlarge.elasticsearch"
          • "c4.8xlarge.elasticsearch"
          • "r4.large.elasticsearch"
          • "r4.xlarge.elasticsearch"
          • "r4.2xlarge.elasticsearch"
          • "r4.4xlarge.elasticsearch"
          • "r4.8xlarge.elasticsearch"
          • "r4.16xlarge.elasticsearch"
          • "i3.large.elasticsearch"
          • "i3.xlarge.elasticsearch"
          • "i3.2xlarge.elasticsearch"
          • "i3.4xlarge.elasticsearch"
          • "i3.8xlarge.elasticsearch"
          • "i3.16xlarge.elasticsearch"
        • StartTime — (Date)

          The time the reservation started.

        • Duration — (Integer)

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

        • FixedPrice — (Float)

          The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch 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 Elasticsearch instance offering.

        • ElasticsearchInstanceCount — (Integer)

          The number of Elasticsearch instances that have been reserved.

        • State — (String)

          The state of the reserved Elasticsearch instance.

        • PaymentOption — (String)

          The payment option as defined in the reserved Elasticsearch 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.

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

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

Service Reference:

Examples:

Calling the describeVpcEndpoints operation

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

Parameters:

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

      The unique identifiers of the endpoints to get information about.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • VpcEndpoints — (Array<map>)

        Information about each requested VPC endpoint.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

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

        • VpcOptions — (map)

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

          • VPCId — (String)

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

          • SubnetIds — (Array<String>)

            Specifies the subnets for VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            Specifies the security groups for VPC endpoint.

        • Status — (String)

          The current status of the endpoint.

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

          The connection endpoint ID for connecting to the domain.

      • VpcEndpointErrors — (Array<map>)

        Any errors associated with the request.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • ErrorCode — (String)

          The code associated with the error.

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

          A message describing the error.

Returns:

  • (AWS.Request) —

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

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

Dissociates a package from the Amazon ES domain.

Service Reference:

Examples:

Calling the dissociatePackage operation

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

Parameters:

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

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

    • DomainName — (String)

      Name of the domain that you want 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)

          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)

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

        • DomainName — (String)

          Name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

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

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

          The relative path on Amazon ES nodes, which can be used as synonym_path when the package is 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.

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

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

Service Reference:

Examples:

Calling the getCompatibleElasticsearchVersions operation

var params = {
  DomainName: 'STRING_VALUE'
};
es.getCompatibleElasticsearchVersions(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 Elasticsearch 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:

      • CompatibleElasticsearchVersions — (Array<map>)

        A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.

        • SourceVersion — (String)

          The current version of Elasticsearch on which a domain is.

        • TargetVersions — (Array<String>)

          List of supported elastic search versions.

Returns:

  • (AWS.Request) —

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

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

Returns a list of versions of the package, 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'
};
es.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 versions of the package.

    • MaxResults — (Integer)

      Limits results to a maximum number of 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)

          Version of the package.

        • CommitMessage — (String)

          A message associated with the version.

        • CreatedAt — (Date)

          Timestamp which tells creation time of the package version.

      • 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 that were performed on the domain.

Service Reference:

Examples:

Calling the getUpgradeHistory operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
es.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 Elasticsearch 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 accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client 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 GetUpgradeHistoryResponse object.

        • UpgradeName — (String)

          A string that describes the update briefly

        • StartTimestamp — (Date)

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

        • UpgradeStatus — (String)

          The overall status of the update. 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 pard of a specific Upgrade or Upgrade Eligibility Check.

          • UpgradeStep — (String)

            Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

            • PreUpgradeCheck
            • Snapshot
            • Upgrade

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

            The status of a particular step during an 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 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 that was performed on the domain.

Service Reference:

Examples:

Calling the getUpgradeStatus operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
es.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 Elasticsearch 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)

        Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through:

        • PreUpgradeCheck
        • Snapshot
        • Upgrade

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

        One of 4 statuses that a step can go through 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 describes the update briefly

Returns:

  • (AWS.Request) —

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

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

Returns the name of all Elasticsearch domains owned by the current user's account.

Service Reference:

Examples:

Calling the listDomainNames operation

var params = {
  EngineType: OpenSearch | Elasticsearch
};
es.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)

          Specifies 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 ES domains associated with the package.

Service Reference:

Examples:

Calling the listDomainsForPackage operation

var params = {
  PackageID: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
es.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 domains.

    • MaxResults — (Integer)

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

          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)

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

        • DomainName — (String)

          Name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

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

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

          The relative path on Amazon ES nodes, which can be used as synonym_path when the package is 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.

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

List all Elasticsearch instance types that are supported for given ElasticsearchVersion

Service Reference:

Examples:

Calling the listElasticsearchInstanceTypes operation

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

      Version of Elasticsearch for which list of supported elasticsearch instance types are needed.

    • DomainName — (String)

      DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.

    • MaxResults — (Integer)

      Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.

    • NextToken — (String)

      NextToken should be sent in case if earlier API call produced result containing NextToken. It is 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:

      • ElasticsearchInstanceTypes — (Array<String>)

        List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion

      • NextToken — (String)

        In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.

Returns:

  • (AWS.Request) —

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

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

List all supported Elasticsearch versions

Service Reference:

Examples:

Calling the listElasticsearchVersions operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
es.listElasticsearchVersions(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 provided must be greater than 10 else it wont be honored.

    • NextToken — (String)

      Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client 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:

      • ElasticsearchVersions — (Array<String>)

        List of supported elastic search versions.

      • NextToken — (String)

        Paginated APIs accepts NextToken input to returns next page results and provides a NextToken output in the response which can be used by the client 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 ES domain.

Service Reference:

Examples:

Calling the listPackagesForDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
es.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)

          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)

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

        • DomainName — (String)

          Name of the domain you've associated a package with.

        • DomainPackageStatus — (String)

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

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

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

        • ErrorDetails — (map)

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

          • ErrorType — (String)
          • ErrorMessage — (String)
      • 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.

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

Returns all tags for the given Elasticsearch domain.

Service Reference:

Examples:

Calling the listTags operation

var params = {
  ARN: 'STRING_VALUE' /* required */
};
es.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 for the Elasticsearch domain to which the tags are attached that you want to view.

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

        • Key — required — (String)

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

        • Value — required — (String)

          Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not 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.

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

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

Service Reference:

Examples:

Calling the listVpcEndpointAccess operation

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

Parameters:

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

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

    • NextToken — (String)

      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:

      • AuthorizedPrincipalList — (Array<map>)

        List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.

        • PrincipalType — (String)

          The type of principal.

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

          The IAM principal that is allowed access to the domain.

      • NextToken — (String)

        Provides an identifier to allow retrieval of paginated results.

Returns:

  • (AWS.Request) —

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

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

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

Service Reference:

Examples:

Calling the listVpcEndpoints operation

var params = {
  NextToken: 'STRING_VALUE'
};
es.listVpcEndpoints(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      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:

      • VpcEndpointSummaryList — (Array<map>)

        Information about each endpoint.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

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

        • Status — (String)

          The current status of the endpoint.

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

        Provides an identifier to allow retrieval of paginated results.

Returns:

  • (AWS.Request) —

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

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

Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.

Service Reference:

Examples:

Calling the listVpcEndpointsForDomain operation

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

Parameters:

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

      Name of the ElasticSearch domain whose VPC endpoints are to be listed.

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

      • VpcEndpointSummaryList — (Array<map>)

        Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

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

        • Status — (String)

          The current status of the endpoint.

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

        Information about each endpoint associated with the domain.

Returns:

  • (AWS.Request) —

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

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

Allows you to purchase reserved Elasticsearch instances.

Service Reference:

Examples:

Calling the purchaseReservedElasticsearchInstanceOffering operation

var params = {
  ReservationName: 'STRING_VALUE', /* required */
  ReservedElasticsearchInstanceOfferingId: 'STRING_VALUE', /* required */
  InstanceCount: 'NUMBER_VALUE'
};
es.purchaseReservedElasticsearchInstanceOffering(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: {}) —
    • ReservedElasticsearchInstanceOfferingId — (String)

      The ID of the reserved Elasticsearch instance offering to purchase.

    • ReservationName — (String)

      A customer-specified identifier to track this reservation.

    • InstanceCount — (Integer)

      The number of Elasticsearch 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:

      • ReservedElasticsearchInstanceId — (String)

        Details of the reserved Elasticsearch 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.

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

Allows the destination domain owner to reject an inbound cross-cluster search connection request.

Service Reference:

Examples:

Calling the rejectInboundCrossClusterSearchConnection operation

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

      The id of the inbound connection that you want 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:

      • CrossClusterSearchConnection — (map)

        Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.

        • SourceDomainInfo — (map)

          Specifies the DomainInformation for the source Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • DestinationDomainInfo — (map)

          Specifies the DomainInformation for the destination Elasticsearch domain.

          • OwnerId — (String)
          • DomainName — required — (String)

            The name of an Elasticsearch 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)
        • CrossClusterSearchConnectionId — (String)

          Specifies the connection id for the inbound cross-cluster search connection.

        • ConnectionStatus — (map)

          Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.

          • StatusCode — (String)

            The state code for inbound connection. This can be one of the following:

            • PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner.
            • APPROVED: Inbound connection is pending acceptance by destination domain owner.
            • 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 cannot be used further.
            Possible values include:
            • "PENDING_ACCEPTANCE"
            • "APPROVED"
            • "REJECTING"
            • "REJECTED"
            • "DELETING"
            • "DELETED"
          • Message — (String)

            Specifies 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 specified Elasticsearch domain.

Service Reference:

Examples:

Calling the removeTags operation

var params = {
  ARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
es.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)

      Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.

    • TagKeys — (Array<String>)

      Specifies the TagKey list which you want to remove from the Elasticsearch domain.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.

Service Reference:

Examples:

Calling the revokeVpcEndpointAccess operation

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

Parameters:

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

      The name of the OpenSearch Service domain.

    • Account — (String)

      The account ID to revoke access from.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

Returns:

  • (AWS.Request) —

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

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

Schedules a service software update for an Amazon ES domain.

Service Reference:

Examples:

Calling the startElasticsearchServiceSoftwareUpdate operation

var params = {
  DomainName: 'STRING_VALUE' /* required */
};
es.startElasticsearchServiceSoftwareUpdate(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 Elasticsearch service software update.

        • CurrentVersion — (String)

          The current service software version that is present on the domain.

        • NewVersion — (String)

          The new service software version if one is available.

        • UpdateAvailable — (Boolean)

          True if you are able to update you service software version. False if you are not able to update your service software version.

        • Cancellable — (Boolean)

          True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.

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

          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.

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

Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.

Service Reference:

Examples:

Calling the updateElasticsearchDomainConfig operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  AccessPolicies: 'STRING_VALUE',
  AdvancedOptions: {
    '<String>': 'STRING_VALUE',
    /* '<String>': ... */
  },
  AdvancedSecurityOptions: {
    AnonymousAuthEnabled: true || false,
    Enabled: true || false,
    InternalUserDatabaseEnabled: true || false,
    MasterUserOptions: {
      MasterUserARN: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      MasterUserPassword: 'STRING_VALUE'
    },
    SAMLOptions: {
      Enabled: true || false,
      Idp: {
        EntityId: 'STRING_VALUE', /* required */
        MetadataContent: 'STRING_VALUE' /* required */
      },
      MasterBackendRole: 'STRING_VALUE',
      MasterUserName: 'STRING_VALUE',
      RolesKey: 'STRING_VALUE',
      SessionTimeoutMinutes: 'NUMBER_VALUE',
      SubjectKey: 'STRING_VALUE'
    }
  },
  AutoTuneOptions: {
    DesiredState: ENABLED | DISABLED,
    MaintenanceSchedules: [
      {
        CronExpressionForRecurrence: 'STRING_VALUE',
        Duration: {
          Unit: HOURS,
          Value: 'NUMBER_VALUE'
        },
        StartAt: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
      },
      /* more items */
    ],
    RollbackOnDisable: NO_ROLLBACK | DEFAULT_ROLLBACK
  },
  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 | Policy-Min-TLS-1-2-PFS-2023-10
  },
  DryRun: true || false,
  EBSOptions: {
    EBSEnabled: true || false,
    Iops: 'NUMBER_VALUE',
    Throughput: 'NUMBER_VALUE',
    VolumeSize: 'NUMBER_VALUE',
    VolumeType: standard | gp2 | io1 | gp3
  },
  ElasticsearchClusterConfig: {
    ColdStorageOptions: {
      Enabled: true || false /* required */
    },
    DedicatedMasterCount: 'NUMBER_VALUE',
    DedicatedMasterEnabled: true || false,
    DedicatedMasterType: m3.medium.elasticsearch | m3.large.elasticsearch | m3.xlarge.elasticsearch | m3.2xlarge.elasticsearch | m4.large.elasticsearch | m4.xlarge.elasticsearch | m4.2xlarge.elasticsearch | m4.4xlarge.elasticsearch | m4.10xlarge.elasticsearch | m5.large.elasticsearch | m5.xlarge.elasticsearch | m5.2xlarge.elasticsearch | m5.4xlarge.elasticsearch | m5.12xlarge.elasticsearch | r5.large.elasticsearch | r5.xlarge.elasticsearch | r5.2xlarge.elasticsearch | r5.4xlarge.elasticsearch | r5.12xlarge.elasticsearch | c5.large.elasticsearch | c5.xlarge.elasticsearch | c5.2xlarge.elasticsearch | c5.4xlarge.elasticsearch | c5.9xlarge.elasticsearch | c5.18xlarge.elasticsearch | ultrawarm1.medium.elasticsearch | ultrawarm1.large.elasticsearch | t2.micro.elasticsearch | t2.small.elasticsearch | t2.medium.elasticsearch | r3.large.elasticsearch | r3.xlarge.elasticsearch | r3.2xlarge.elasticsearch | r3.4xlarge.elasticsearch | r3.8xlarge.elasticsearch | i2.xlarge.elasticsearch | i2.2xlarge.elasticsearch | d2.xlarge.elasticsearch | d2.2xlarge.elasticsearch | d2.4xlarge.elasticsearch | d2.8xlarge.elasticsearch | c4.large.elasticsearch | c4.xlarge.elasticsearch | c4.2xlarge.elasticsearch | c4.4xlarge.elasticsearch | c4.8xlarge.elasticsearch | r4.large.elasticsearch | r4.xlarge.elasticsearch | r4.2xlarge.elasticsearch | r4.4xlarge.elasticsearch | r4.8xlarge.elasticsearch | r4.16xlarge.elasticsearch | i3.large.elasticsearch | i3.xlarge.elasticsearch | i3.2xlarge.elasticsearch | i3.4xlarge.elasticsearch | i3.8xlarge.elasticsearch | i3.16xlarge.elasticsearch,
    InstanceCount: 'NUMBER_VALUE',
    InstanceType: m3.medium.elasticsearch | m3.large.elasticsearch | m3.xlarge.elasticsearch | m3.2xlarge.elasticsearch | m4.large.elasticsearch | m4.xlarge.elasticsearch | m4.2xlarge.elasticsearch | m4.4xlarge.elasticsearch | m4.10xlarge.elasticsearch | m5.large.elasticsearch | m5.xlarge.elasticsearch | m5.2xlarge.elasticsearch | m5.4xlarge.elasticsearch | m5.12xlarge.elasticsearch | r5.large.elasticsearch | r5.xlarge.elasticsearch | r5.2xlarge.elasticsearch | r5.4xlarge.elasticsearch | r5.12xlarge.elasticsearch | c5.large.elasticsearch | c5.xlarge.elasticsearch | c5.2xlarge.elasticsearch | c5.4xlarge.elasticsearch | c5.9xlarge.elasticsearch | c5.18xlarge.elasticsearch | ultrawarm1.medium.elasticsearch | ultrawarm1.large.elasticsearch | t2.micro.elasticsearch | t2.small.elasticsearch | t2.medium.elasticsearch | r3.large.elasticsearch | r3.xlarge.elasticsearch | r3.2xlarge.elasticsearch | r3.4xlarge.elasticsearch | r3.8xlarge.elasticsearch | i2.xlarge.elasticsearch | i2.2xlarge.elasticsearch | d2.xlarge.elasticsearch | d2.2xlarge.elasticsearch | d2.4xlarge.elasticsearch | d2.8xlarge.elasticsearch | c4.large.elasticsearch | c4.xlarge.elasticsearch | c4.2xlarge.elasticsearch | c4.4xlarge.elasticsearch | c4.8xlarge.elasticsearch | r4.large.elasticsearch | r4.xlarge.elasticsearch | r4.2xlarge.elasticsearch | r4.4xlarge.elasticsearch | r4.8xlarge.elasticsearch | r4.16xlarge.elasticsearch | i3.large.elasticsearch | i3.xlarge.elasticsearch | i3.2xlarge.elasticsearch | i3.4xlarge.elasticsearch | i3.8xlarge.elasticsearch | i3.16xlarge.elasticsearch,
    WarmCount: 'NUMBER_VALUE',
    WarmEnabled: true || false,
    WarmType: ultrawarm1.medium.elasticsearch | ultrawarm1.large.elasticsearch,
    ZoneAwarenessConfig: {
      AvailabilityZoneCount: 'NUMBER_VALUE'
    },
    ZoneAwarenessEnabled: true || false
  },
  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 */
    ]
  }
};
es.updateElasticsearchDomainConfig(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 Elasticsearch domain that you are updating.

    • ElasticsearchClusterConfig — (map)

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

      • InstanceType — (String)

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

        Possible values include:
        • "m3.medium.elasticsearch"
        • "m3.large.elasticsearch"
        • "m3.xlarge.elasticsearch"
        • "m3.2xlarge.elasticsearch"
        • "m4.large.elasticsearch"
        • "m4.xlarge.elasticsearch"
        • "m4.2xlarge.elasticsearch"
        • "m4.4xlarge.elasticsearch"
        • "m4.10xlarge.elasticsearch"
        • "m5.large.elasticsearch"
        • "m5.xlarge.elasticsearch"
        • "m5.2xlarge.elasticsearch"
        • "m5.4xlarge.elasticsearch"
        • "m5.12xlarge.elasticsearch"
        • "r5.large.elasticsearch"
        • "r5.xlarge.elasticsearch"
        • "r5.2xlarge.elasticsearch"
        • "r5.4xlarge.elasticsearch"
        • "r5.12xlarge.elasticsearch"
        • "c5.large.elasticsearch"
        • "c5.xlarge.elasticsearch"
        • "c5.2xlarge.elasticsearch"
        • "c5.4xlarge.elasticsearch"
        • "c5.9xlarge.elasticsearch"
        • "c5.18xlarge.elasticsearch"
        • "ultrawarm1.medium.elasticsearch"
        • "ultrawarm1.large.elasticsearch"
        • "t2.micro.elasticsearch"
        • "t2.small.elasticsearch"
        • "t2.medium.elasticsearch"
        • "r3.large.elasticsearch"
        • "r3.xlarge.elasticsearch"
        • "r3.2xlarge.elasticsearch"
        • "r3.4xlarge.elasticsearch"
        • "r3.8xlarge.elasticsearch"
        • "i2.xlarge.elasticsearch"
        • "i2.2xlarge.elasticsearch"
        • "d2.xlarge.elasticsearch"
        • "d2.2xlarge.elasticsearch"
        • "d2.4xlarge.elasticsearch"
        • "d2.8xlarge.elasticsearch"
        • "c4.large.elasticsearch"
        • "c4.xlarge.elasticsearch"
        • "c4.2xlarge.elasticsearch"
        • "c4.4xlarge.elasticsearch"
        • "c4.8xlarge.elasticsearch"
        • "r4.large.elasticsearch"
        • "r4.xlarge.elasticsearch"
        • "r4.2xlarge.elasticsearch"
        • "r4.4xlarge.elasticsearch"
        • "r4.8xlarge.elasticsearch"
        • "r4.16xlarge.elasticsearch"
        • "i3.large.elasticsearch"
        • "i3.xlarge.elasticsearch"
        • "i3.2xlarge.elasticsearch"
        • "i3.4xlarge.elasticsearch"
        • "i3.8xlarge.elasticsearch"
        • "i3.16xlarge.elasticsearch"
      • 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 About Dedicated Master Nodes for more information.

      • ZoneAwarenessEnabled — (Boolean)

        A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

      • ZoneAwarenessConfig — (map)

        Specifies 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.elasticsearch"
        • "m3.large.elasticsearch"
        • "m3.xlarge.elasticsearch"
        • "m3.2xlarge.elasticsearch"
        • "m4.large.elasticsearch"
        • "m4.xlarge.elasticsearch"
        • "m4.2xlarge.elasticsearch"
        • "m4.4xlarge.elasticsearch"
        • "m4.10xlarge.elasticsearch"
        • "m5.large.elasticsearch"
        • "m5.xlarge.elasticsearch"
        • "m5.2xlarge.elasticsearch"
        • "m5.4xlarge.elasticsearch"
        • "m5.12xlarge.elasticsearch"
        • "r5.large.elasticsearch"
        • "r5.xlarge.elasticsearch"
        • "r5.2xlarge.elasticsearch"
        • "r5.4xlarge.elasticsearch"
        • "r5.12xlarge.elasticsearch"
        • "c5.large.elasticsearch"
        • "c5.xlarge.elasticsearch"
        • "c5.2xlarge.elasticsearch"
        • "c5.4xlarge.elasticsearch"
        • "c5.9xlarge.elasticsearch"
        • "c5.18xlarge.elasticsearch"
        • "ultrawarm1.medium.elasticsearch"
        • "ultrawarm1.large.elasticsearch"
        • "t2.micro.elasticsearch"
        • "t2.small.elasticsearch"
        • "t2.medium.elasticsearch"
        • "r3.large.elasticsearch"
        • "r3.xlarge.elasticsearch"
        • "r3.2xlarge.elasticsearch"
        • "r3.4xlarge.elasticsearch"
        • "r3.8xlarge.elasticsearch"
        • "i2.xlarge.elasticsearch"
        • "i2.2xlarge.elasticsearch"
        • "d2.xlarge.elasticsearch"
        • "d2.2xlarge.elasticsearch"
        • "d2.4xlarge.elasticsearch"
        • "d2.8xlarge.elasticsearch"
        • "c4.large.elasticsearch"
        • "c4.xlarge.elasticsearch"
        • "c4.2xlarge.elasticsearch"
        • "c4.4xlarge.elasticsearch"
        • "c4.8xlarge.elasticsearch"
        • "r4.large.elasticsearch"
        • "r4.xlarge.elasticsearch"
        • "r4.2xlarge.elasticsearch"
        • "r4.4xlarge.elasticsearch"
        • "r4.8xlarge.elasticsearch"
        • "r4.16xlarge.elasticsearch"
        • "i3.large.elasticsearch"
        • "i3.xlarge.elasticsearch"
        • "i3.2xlarge.elasticsearch"
        • "i3.4xlarge.elasticsearch"
        • "i3.8xlarge.elasticsearch"
        • "i3.16xlarge.elasticsearch"
      • DedicatedMasterCount — (Integer)

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

      • WarmEnabled — (Boolean)

        True to enable warm storage.

      • WarmType — (String)

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

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

        The number of warm nodes in the cluster.

      • ColdStorageOptions — (map)

        Specifies the ColdStorageOptions config for Elasticsearch Domain

        • Enabled — required — (Boolean)

          Enable cold storage option. Accepted values true or false

    • EBSOptions — (map)

      Specify the type and size of the EBS volume that you want to use.

      • EBSEnabled — (Boolean)

        Specifies whether EBS-based storage is enabled.

      • VolumeType — (String)

        Specifies the volume type for EBS-based storage.

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

        Integer to specify the size of an EBS volume.

      • Iops — (Integer)

        Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

      • Throughput — (Integer)

        Specifies the Throughput for GP3 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)

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

    • VPCOptions — (map)

      Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains

      • SubnetIds — (Array<String>)

        Specifies the subnets for VPC endpoint.

      • SecurityGroupIds — (Array<String>)

        Specifies the security groups for VPC endpoint.

    • CognitoOptions — (map)

      Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.

      • Enabled — (Boolean)

        Specifies the option to enable Cognito for Kibana authentication.

      • UserPoolId — (String)

        Specifies the Cognito user pool ID for Kibana authentication.

      • IdentityPoolId — (String)

        Specifies the Cognito identity pool ID for Kibana authentication.

      • RoleArn — (String)

        Specifies the role ARN that provides Elasticsearch 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 Configuration 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 Elasticsearch log.

      • CloudWatchLogsLogGroupArn — (String)

        ARN of the Cloudwatch log group to which log needs to be published.

      • Enabled — (Boolean)

        Specifies whether given log publishing option is enabled or not.

    • DomainEndpointOptions — (map)

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

      • EnforceHTTPS — (Boolean)

        Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

      • TLSSecurityPolicy — (String)

        Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
        It can be one of the following values:

        • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
        • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
        • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

        Specify if custom endpoint should be enabled for the Elasticsearch domain.

      • CustomEndpoint — (String)

        Specify the fully qualified domain for your custom endpoint.

      • CustomEndpointCertificateArn — (String)

        Specify 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 Elasticsearch Service domain's internal database.

        • MasterUserPassword — (String)

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

      • SAMLOptions — (map)

        Specifies the SAML application configuration for the domain.

        • Enabled — (Boolean)

          True if SAML is enabled.

        • Idp — (map)

          Specifies the SAML Identity Provider's information.

          • MetadataContent — required — (String)

            The Metadata of the SAML application in xml format.

          • EntityId — required — (String)

            The unique Entity ID of the application in SAML Identity Provider.

        • MasterUserName — (String)

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

        • MasterBackendRole — (String)

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

        • SubjectKey — (String)

          The key to use for matching the SAML Subject attribute.

        • RolesKey — (String)

          The key to use for matching the SAML Roles attribute.

        • SessionTimeoutMinutes — (Integer)

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

      • AnonymousAuthEnabled — (Boolean)

        True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

    • NodeToNodeEncryptionOptions — (map)

      Specifies the NodeToNodeEncryptionOptions.

      • Enabled — (Boolean)

        Specify true to enable node-to-node encryption.

    • EncryptionAtRestOptions — (map)

      Specifies the Encryption At Rest Options.

      • Enabled — (Boolean)

        Specifies the option to enable Encryption At Rest.

      • KmsKeyId — (String)

        Specifies the KMS Key ID for Encryption At Rest options.

    • AutoTuneOptions — (map)

      Specifies Auto-Tune options.

      • DesiredState — (String)

        Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

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

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

        Specifies list of maitenance schedules. See the Developer Guide for more information.

        • StartAt — (Date)

          Specifies timestamp at which Auto-Tune maintenance schedule start.

        • Duration — (map)

          Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

          • Value — (Integer)

            Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

          • Unit — (String)

            Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

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

          Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

    • DryRun — (Boolean)

      This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.

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

        • ElasticsearchVersion — (map)

          String of format X.Y to specify version for the Elasticsearch domain.

          • Options — required — (String)

            Specifies the Elasticsearch version for the specified Elasticsearch domain.

          • Status — required — (map)

            Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • ElasticsearchClusterConfig — (map)

          Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the cluster configuration for the specified Elasticsearch domain.

            • InstanceType — (String)

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

              Possible values include:
              • "m3.medium.elasticsearch"
              • "m3.large.elasticsearch"
              • "m3.xlarge.elasticsearch"
              • "m3.2xlarge.elasticsearch"
              • "m4.large.elasticsearch"
              • "m4.xlarge.elasticsearch"
              • "m4.2xlarge.elasticsearch"
              • "m4.4xlarge.elasticsearch"
              • "m4.10xlarge.elasticsearch"
              • "m5.large.elasticsearch"
              • "m5.xlarge.elasticsearch"
              • "m5.2xlarge.elasticsearch"
              • "m5.4xlarge.elasticsearch"
              • "m5.12xlarge.elasticsearch"
              • "r5.large.elasticsearch"
              • "r5.xlarge.elasticsearch"
              • "r5.2xlarge.elasticsearch"
              • "r5.4xlarge.elasticsearch"
              • "r5.12xlarge.elasticsearch"
              • "c5.large.elasticsearch"
              • "c5.xlarge.elasticsearch"
              • "c5.2xlarge.elasticsearch"
              • "c5.4xlarge.elasticsearch"
              • "c5.9xlarge.elasticsearch"
              • "c5.18xlarge.elasticsearch"
              • "ultrawarm1.medium.elasticsearch"
              • "ultrawarm1.large.elasticsearch"
              • "t2.micro.elasticsearch"
              • "t2.small.elasticsearch"
              • "t2.medium.elasticsearch"
              • "r3.large.elasticsearch"
              • "r3.xlarge.elasticsearch"
              • "r3.2xlarge.elasticsearch"
              • "r3.4xlarge.elasticsearch"
              • "r3.8xlarge.elasticsearch"
              • "i2.xlarge.elasticsearch"
              • "i2.2xlarge.elasticsearch"
              • "d2.xlarge.elasticsearch"
              • "d2.2xlarge.elasticsearch"
              • "d2.4xlarge.elasticsearch"
              • "d2.8xlarge.elasticsearch"
              • "c4.large.elasticsearch"
              • "c4.xlarge.elasticsearch"
              • "c4.2xlarge.elasticsearch"
              • "c4.4xlarge.elasticsearch"
              • "c4.8xlarge.elasticsearch"
              • "r4.large.elasticsearch"
              • "r4.xlarge.elasticsearch"
              • "r4.2xlarge.elasticsearch"
              • "r4.4xlarge.elasticsearch"
              • "r4.8xlarge.elasticsearch"
              • "r4.16xlarge.elasticsearch"
              • "i3.large.elasticsearch"
              • "i3.xlarge.elasticsearch"
              • "i3.2xlarge.elasticsearch"
              • "i3.4xlarge.elasticsearch"
              • "i3.8xlarge.elasticsearch"
              • "i3.16xlarge.elasticsearch"
            • 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 About Dedicated Master Nodes for more information.

            • ZoneAwarenessEnabled — (Boolean)

              A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

            • ZoneAwarenessConfig — (map)

              Specifies 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.elasticsearch"
              • "m3.large.elasticsearch"
              • "m3.xlarge.elasticsearch"
              • "m3.2xlarge.elasticsearch"
              • "m4.large.elasticsearch"
              • "m4.xlarge.elasticsearch"
              • "m4.2xlarge.elasticsearch"
              • "m4.4xlarge.elasticsearch"
              • "m4.10xlarge.elasticsearch"
              • "m5.large.elasticsearch"
              • "m5.xlarge.elasticsearch"
              • "m5.2xlarge.elasticsearch"
              • "m5.4xlarge.elasticsearch"
              • "m5.12xlarge.elasticsearch"
              • "r5.large.elasticsearch"
              • "r5.xlarge.elasticsearch"
              • "r5.2xlarge.elasticsearch"
              • "r5.4xlarge.elasticsearch"
              • "r5.12xlarge.elasticsearch"
              • "c5.large.elasticsearch"
              • "c5.xlarge.elasticsearch"
              • "c5.2xlarge.elasticsearch"
              • "c5.4xlarge.elasticsearch"
              • "c5.9xlarge.elasticsearch"
              • "c5.18xlarge.elasticsearch"
              • "ultrawarm1.medium.elasticsearch"
              • "ultrawarm1.large.elasticsearch"
              • "t2.micro.elasticsearch"
              • "t2.small.elasticsearch"
              • "t2.medium.elasticsearch"
              • "r3.large.elasticsearch"
              • "r3.xlarge.elasticsearch"
              • "r3.2xlarge.elasticsearch"
              • "r3.4xlarge.elasticsearch"
              • "r3.8xlarge.elasticsearch"
              • "i2.xlarge.elasticsearch"
              • "i2.2xlarge.elasticsearch"
              • "d2.xlarge.elasticsearch"
              • "d2.2xlarge.elasticsearch"
              • "d2.4xlarge.elasticsearch"
              • "d2.8xlarge.elasticsearch"
              • "c4.large.elasticsearch"
              • "c4.xlarge.elasticsearch"
              • "c4.2xlarge.elasticsearch"
              • "c4.4xlarge.elasticsearch"
              • "c4.8xlarge.elasticsearch"
              • "r4.large.elasticsearch"
              • "r4.xlarge.elasticsearch"
              • "r4.2xlarge.elasticsearch"
              • "r4.4xlarge.elasticsearch"
              • "r4.8xlarge.elasticsearch"
              • "r4.16xlarge.elasticsearch"
              • "i3.large.elasticsearch"
              • "i3.xlarge.elasticsearch"
              • "i3.2xlarge.elasticsearch"
              • "i3.4xlarge.elasticsearch"
              • "i3.8xlarge.elasticsearch"
              • "i3.16xlarge.elasticsearch"
            • DedicatedMasterCount — (Integer)

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

            • WarmEnabled — (Boolean)

              True to enable warm storage.

            • WarmType — (String)

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

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

              The number of warm nodes in the cluster.

            • ColdStorageOptions — (map)

              Specifies the ColdStorageOptions config for Elasticsearch Domain

              • Enabled — required — (Boolean)

                Enable cold storage option. Accepted values true or false

          • Status — required — (map)

            Specifies the status of the configuration for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • EBSOptions — (map)

          Specifies the EBSOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the EBS options for the specified Elasticsearch domain.

            • EBSEnabled — (Boolean)

              Specifies whether EBS-based storage is enabled.

            • VolumeType — (String)

              Specifies the volume type for EBS-based storage.

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

              Integer to specify the size of an EBS volume.

            • Iops — (Integer)

              Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).

            • Throughput — (Integer)

              Specifies the Throughput for GP3 EBS volume (SSD).

          • Status — required — (map)

            Specifies the status of the EBS options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AccessPolicies — (map)

          IAM access policy as a JSON-formatted string.

          • Options — required — (String)

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

          • Status — required — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • SnapshotOptions — (map)

          Specifies the SnapshotOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the daily snapshot options specified for the Elasticsearch domain.

            • AutomatedSnapshotStartHour — (Integer)

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

          • Status — required — (map)

            Specifies the status of a daily automated snapshot.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • VPCOptions — (map)

          The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.

          • Options — required — (map)

            Specifies the VPC options for the specified Elasticsearch domain.

            • VPCId — (String)

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

            • SubnetIds — (Array<String>)

              Specifies the subnets for VPC endpoint.

            • AvailabilityZones — (Array<String>)

              The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

            • SecurityGroupIds — (Array<String>)

              Specifies the security groups for VPC endpoint.

          • Status — required — (map)

            Specifies the status of the VPC options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • CognitoOptions — (map)

          The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.

          • Options — required — (map)

            Specifies the Cognito options for the specified Elasticsearch domain.

            • Enabled — (Boolean)

              Specifies the option to enable Cognito for Kibana authentication.

            • UserPoolId — (String)

              Specifies the Cognito user pool ID for Kibana authentication.

            • IdentityPoolId — (String)

              Specifies the Cognito identity pool ID for Kibana authentication.

            • RoleArn — (String)

              Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.

          • Status — required — (map)

            Specifies the status of the Cognito options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • EncryptionAtRestOptions — (map)

          Specifies the EncryptionAtRestOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the Encryption At Rest options for the specified Elasticsearch domain.

            • Enabled — (Boolean)

              Specifies the option to enable Encryption At Rest.

            • KmsKeyId — (String)

              Specifies the KMS Key ID for Encryption At Rest options.

          • Status — required — (map)

            Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • NodeToNodeEncryptionOptions — (map)

          Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.

          • Options — required — (map)

            Specifies the node-to-node encryption options for the specified Elasticsearch domain.

            • Enabled — (Boolean)

              Specify true to enable node-to-node encryption.

          • Status — required — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AdvancedOptions — (map)

          Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.

          • Options — required — (map<String>)

            Specifies the status of advanced options for the specified Elasticsearch domain.

          • Status — required — (map)

            Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • LogPublishingOptions — (map)

          Log publishing options for the given domain.

          • Options — (map<map>)

            The log publishing options configured for the Elasticsearch domain.

            • CloudWatchLogsLogGroupArn — (String)

              ARN of the Cloudwatch log group to which log needs to be published.

            • Enabled — (Boolean)

              Specifies whether given log publishing option is enabled or not.

          • Status — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • DomainEndpointOptions — (map)

          Specifies the DomainEndpointOptions for the Elasticsearch domain.

          • Options — required — (map)

            Options to configure endpoint for the Elasticsearch domain.

            • EnforceHTTPS — (Boolean)

              Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.

            • TLSSecurityPolicy — (String)

              Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain.
              It can be one of the following values:

              • Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2
              • Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2
              • Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites

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

              Specify if custom endpoint should be enabled for the Elasticsearch domain.

            • CustomEndpoint — (String)

              Specify the fully qualified domain for your custom endpoint.

            • CustomEndpointCertificateArn — (String)

              Specify ACM certificate ARN for your custom endpoint.

          • Status — required — (map)

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

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AdvancedSecurityOptions — (map)

          Specifies AdvancedSecurityOptions for the domain.

          • Options — required — (map)

            Specifies advanced security options for the specified Elasticsearch 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.

                • MetadataContent — required — (String)

                  The Metadata of the SAML application in xml format.

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

            • AnonymousAuthDisableDate — (Date)

              Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.

            • AnonymousAuthEnabled — (Boolean)

              True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.

          • Status — required — (map)

            Status of the advanced security options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells the creation date for the entity.

            • UpdateDate — required — (Date)

              Timestamp which tells the last updated time for the entity.

            • UpdateVersion — (Integer)

              Specifies the latest version for the entity.

            • State — required — (String)

              Provides the OptionState for the Elasticsearch domain.

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

              Indicates whether the Elasticsearch domain is being deleted.

        • AutoTuneOptions — (map)

          Specifies AutoTuneOptions for the domain.

          • Options — (map)

            Specifies Auto-Tune options for the specified Elasticsearch domain.

            • DesiredState — (String)

              Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.

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

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

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

              Specifies list of maitenance schedules. See the Developer Guide for more information.

              • StartAt — (Date)

                Specifies timestamp at which Auto-Tune maintenance schedule start.

              • Duration — (map)

                Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.

                • Value — (Integer)

                  Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.

                • Unit — (String)

                  Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.

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

                Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.

          • Status — (map)

            Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.

            • CreationDate — required — (Date)

              Timestamp which tells Auto-Tune options creation date .

            • UpdateDate — required — (Date)

              Timestamp which tells Auto-Tune options last updated time.

            • UpdateVersion — (Integer)

              Specifies the Auto-Tune options latest version.

            • State — required — (String)

              Specifies the AutoTuneState for the Elasticsearch 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)

              Specifies the error message while enabling or disabling the Auto-Tune options.

            • PendingDeletion — (Boolean)

              Indicates whether the Elasticsearch domain is being deleted.

        • ChangeProgressDetails — (map)

          Specifies change details of the domain configuration change.

          • ChangeId — (String)

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

          • Message — (String)

            Contains an optional message associated with the domain configuration change.

          • ConfigChangeStatus — (String)

            The current status of the configuration change.

            Possible values include:
            • "Pending"
            • "Initializing"
            • "Validating"
            • "ValidationFailed"
            • "ApplyingChanges"
            • "Completed"
            • "PendingUserInput"
            • "Cancelled"
          • StartTime — (Date)

            The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

          • LastUpdatedTime — (Date)

            The last time that the configuration change was updated.

          • InitiatedBy — (String)

            The IAM principal who initiated the configuration change.

            Possible values include:
            • "CUSTOMER"
            • "SERVICE"
        • ModifyingProperties — (Array<map>)

          Information about the domain properties that are currently being modified.

          • Name — (String)

            The name of the property that is currently being modified.

          • ActiveValue — (String)

            The current value of the domain property that is being modified.

          • PendingValue — (String)

            The value that the property that is currently being modified will eventually have.

          • ValueType — (String)

            The type of value that is currently being modified. Properties can have two types:

            • PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search".
            • STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
            Possible values include:
            • "PLAIN_TEXT"
            • "STRINGIFIED_JSON"
      • DryRunResults — (map)

        Contains result of DryRun.

        • DeploymentType — (String)

          Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are Blue/Green (The update will require a blue/green deployment.) DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.) Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) None (The configuration change matches the current configuration and will not result in any update.)

        • 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 ES 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'
};
es.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)

      Unique identifier for the package.

    • PackageSource — (map)

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

      • S3BucketName — (String)

        Name of the bucket containing the package.

      • S3Key — (String)

        Key (file name) of the package.

    • PackageDescription — (String)

      New description of the package.

    • CommitMessage — (String)

      An info message for the new version which will be 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 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/DELETE_FAILED

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

          Timestamp which tells creation date of the package.

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

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

Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.

Service Reference:

Examples:

Calling the updateVpcEndpoint operation

var params = {
  VpcEndpointId: 'STRING_VALUE', /* required */
  VpcOptions: { /* required */
    SecurityGroupIds: [
      'STRING_VALUE',
      /* more items */
    ],
    SubnetIds: [
      'STRING_VALUE',
      /* more items */
    ]
  }
};
es.updateVpcEndpoint(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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

      Unique identifier of the VPC endpoint to be updated.

    • VpcOptions — (map)

      The security groups and/or subnets to add, remove, or modify.

      • SubnetIds — (Array<String>)

        Specifies the subnets for VPC endpoint.

      • SecurityGroupIds — (Array<String>)

        Specifies the security groups for VPC endpoint.

Callback (callback):

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

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

    Context (this):

    • (AWS.Response) —

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

    Parameters:

    • err (Error) —

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

    • data (Object) —

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

      • VpcEndpoint — (map)

        The endpoint to be updated.

        • VpcEndpointId — (String)

          The unique identifier of the endpoint.

        • VpcEndpointOwner — (String)

          The creator of the endpoint.

        • DomainArn — (String)

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

        • VpcOptions — (map)

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

          • VPCId — (String)

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

          • SubnetIds — (Array<String>)

            Specifies the subnets for VPC endpoint.

          • AvailabilityZones — (Array<String>)

            The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.

          • SecurityGroupIds — (Array<String>)

            Specifies the security groups for VPC endpoint.

        • Status — (String)

          The current status of the endpoint.

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

          The connection endpoint ID for connecting to the domain.

Returns:

  • (AWS.Request) —

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

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

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

Service Reference:

Examples:

Calling the upgradeElasticsearchDomain operation

var params = {
  DomainName: 'STRING_VALUE', /* required */
  TargetVersion: 'STRING_VALUE', /* required */
  PerformCheckOnly: true || false
};
es.upgradeElasticsearchDomain(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 Elasticsearch 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 Elasticsearch that you intend to upgrade the domain to.

    • PerformCheckOnly — (Boolean)

      This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

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:

      • DomainName — (String)

        The name of an Elasticsearch 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 Elasticsearch that you intend to upgrade the domain to.

      • PerformCheckOnly — (Boolean)

        This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

      • ChangeProgressDetails — (map)

        Specifies change details of the domain configuration change.

        • ChangeId — (String)

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

        • Message — (String)

          Contains an optional message associated with the domain configuration change.

        • ConfigChangeStatus — (String)

          The current status of the configuration change.

          Possible values include:
          • "Pending"
          • "Initializing"
          • "Validating"
          • "ValidationFailed"
          • "ApplyingChanges"
          • "Completed"
          • "PendingUserInput"
          • "Cancelled"
        • StartTime — (Date)

          The time that the configuration change was initiated, in Universal Coordinated Time (UTC).

        • LastUpdatedTime — (Date)

          The last time that the configuration change was updated.

        • InitiatedBy — (String)

          The IAM principal who initiated the configuration change.

          Possible values include:
          • "CUSTOMER"
          • "SERVICE"

Returns:

  • (AWS.Request) —

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