Class: AWS.OpenSearch
- Inherits:
-
AWS.Service
- Object
- AWS.Service
- AWS.OpenSearch
- Identifier:
- opensearch
- API Version:
- 2021-01-01
- Defined in:
- (unknown)
Overview
Constructs a service interface object. Each API operation is exposed as a function on service.
Service Description
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service requests is Region specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported Regions and endpoints, see Amazon Web Services service endpoints.
Sending a Request Using OpenSearch
var opensearch = new AWS.OpenSearch();
opensearch.acceptInboundConnection(params, function (err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Locking the API Version
In order to ensure that the OpenSearch object uses this specific API, you can
construct the object by passing the apiVersion
option to the constructor:
var opensearch = new AWS.OpenSearch({apiVersion: '2021-01-01'});
You can also set the API version globally in AWS.config.apiVersions
using
the opensearch service identifier:
AWS.config.apiVersions = {
opensearch: '2021-01-01',
// other service API versions
};
var opensearch = new AWS.OpenSearch();
Version:
-
2021-01-01
Constructor Summary collapse
-
new AWS.OpenSearch(options = {}) ⇒ Object
constructor
Constructs a service object.
Property Summary collapse
-
endpoint ⇒ AWS.Endpoint
readwrite
An Endpoint object representing the endpoint URL for service requests.
Properties inherited from AWS.Service
Method Summary collapse
-
acceptInboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.
-
addDataSource(params = {}, callback) ⇒ AWS.Request
Creates a new direct-query data source to the specified domain.
-
addTags(params = {}, callback) ⇒ AWS.Request
Attaches tags to an existing Amazon OpenSearch Service domain.
-
associatePackage(params = {}, callback) ⇒ AWS.Request
Associates a package with an Amazon OpenSearch Service domain.
-
authorizeVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
.
-
cancelDomainConfigChange(params = {}, callback) ⇒ AWS.Request
Cancels a pending configuration change on an Amazon OpenSearch Service domain.
.
-
cancelServiceSoftwareUpdate(params = {}, callback) ⇒ AWS.Request
Cancels a scheduled service software update for an Amazon OpenSearch Service domain.
-
createDomain(params = {}, callback) ⇒ AWS.Request
Creates an Amazon OpenSearch Service domain.
-
createOutboundConnection(params = {}, callback) ⇒ AWS.Request
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.
-
createPackage(params = {}, callback) ⇒ AWS.Request
Creates a package for use with Amazon OpenSearch Service domains.
-
createVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Creates an Amazon OpenSearch Service-managed VPC endpoint.
.
-
deleteDataSource(params = {}, callback) ⇒ AWS.Request
Deletes a direct-query data source.
-
deleteDomain(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon OpenSearch Service domain and all of its data.
-
deleteInboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.
-
deleteOutboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.
-
deletePackage(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon OpenSearch Service package.
-
deleteVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
.
-
describeDomain(params = {}, callback) ⇒ AWS.Request
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
.
-
describeDomainAutoTunes(params = {}, callback) ⇒ AWS.Request
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.
-
describeDomainChangeProgress(params = {}, callback) ⇒ AWS.Request
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.
-
describeDomainConfig(params = {}, callback) ⇒ AWS.Request
Returns the configuration of an Amazon OpenSearch Service domain.
.
-
describeDomainHealth(params = {}, callback) ⇒ AWS.Request
Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
.
-
describeDomainNodes(params = {}, callback) ⇒ AWS.Request
Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
.
-
describeDomains(params = {}, callback) ⇒ AWS.Request
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
.
-
describeDryRunProgress(params = {}, callback) ⇒ AWS.Request
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.
-
describeInboundConnections(params = {}, callback) ⇒ AWS.Request
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.
-
describeInstanceTypeLimits(params = {}, callback) ⇒ AWS.Request
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
.
-
describeOutboundConnections(params = {}, callback) ⇒ AWS.Request
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.
-
describePackages(params = {}, callback) ⇒ AWS.Request
Describes all packages available to OpenSearch Service.
-
describeReservedInstanceOfferings(params = {}, callback) ⇒ AWS.Request
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.
-
describeReservedInstances(params = {}, callback) ⇒ AWS.Request
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region.
-
describeVpcEndpoints(params = {}, callback) ⇒ AWS.Request
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
.
-
dissociatePackage(params = {}, callback) ⇒ AWS.Request
Removes a package from the specified Amazon OpenSearch Service domain.
-
getCompatibleVersions(params = {}, callback) ⇒ AWS.Request
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
.
-
getDataSource(params = {}, callback) ⇒ AWS.Request
Retrieves information about a direct query data source.
.
-
getDomainMaintenanceStatus(params = {}, callback) ⇒ AWS.Request
The status of the maintenance action.
.
-
getPackageVersionHistory(params = {}, callback) ⇒ AWS.Request
Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).
-
getUpgradeHistory(params = {}, callback) ⇒ AWS.Request
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
.
-
getUpgradeStatus(params = {}, callback) ⇒ AWS.Request
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
.
-
listDataSources(params = {}, callback) ⇒ AWS.Request
Lists direct-query data sources for a specific domain.
-
listDomainMaintenances(params = {}, callback) ⇒ AWS.Request
A list of maintenance actions for the domain.
.
-
listDomainNames(params = {}, callback) ⇒ AWS.Request
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
.
-
listDomainsForPackage(params = {}, callback) ⇒ AWS.Request
Lists all Amazon OpenSearch Service domains associated with a given package.
-
listInstanceTypeDetails(params = {}, callback) ⇒ AWS.Request
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
.
-
listPackagesForDomain(params = {}, callback) ⇒ AWS.Request
Lists all packages associated with an Amazon OpenSearch Service domain.
-
listScheduledActions(params = {}, callback) ⇒ AWS.Request
Retrieves a list of configuration changes that are scheduled for a domain.
-
listTags(params = {}, callback) ⇒ AWS.Request
Returns all resource tags for an Amazon OpenSearch Service domain.
-
listVersions(params = {}, callback) ⇒ AWS.Request
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
.
-
listVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request
Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
.
-
listVpcEndpoints(params = {}, callback) ⇒ AWS.Request
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
.
-
listVpcEndpointsForDomain(params = {}, callback) ⇒ AWS.Request
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
.
-
purchaseReservedInstanceOffering(params = {}, callback) ⇒ AWS.Request
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
.
-
rejectInboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
.
-
removeTags(params = {}, callback) ⇒ AWS.Request
Removes the specified set of tags from an Amazon OpenSearch Service domain.
-
revokeVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
.
-
startDomainMaintenance(params = {}, callback) ⇒ AWS.Request
Starts the node maintenance process on the data node.
-
startServiceSoftwareUpdate(params = {}, callback) ⇒ AWS.Request
Schedules a service software update for an Amazon OpenSearch Service domain.
-
updateDataSource(params = {}, callback) ⇒ AWS.Request
Updates a direct-query data source.
-
updateDomainConfig(params = {}, callback) ⇒ AWS.Request
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
.
-
updatePackage(params = {}, callback) ⇒ AWS.Request
Updates a package for use with Amazon OpenSearch Service domains.
-
updateScheduledAction(params = {}, callback) ⇒ AWS.Request
Reschedules a planned domain configuration change for a later time.
-
updateVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
.
-
upgradeDomain(params = {}, callback) ⇒ AWS.Request
Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
.
Methods inherited from AWS.Service
makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService
Constructor Details
new AWS.OpenSearch(options = {}) ⇒ Object
Constructs a service object. This object has one method for each API operation.
Examples:
Constructing a OpenSearch object
var opensearch = new AWS.OpenSearch({apiVersion: '2021-01-01'});
Options Hash (options):
-
params
(map)
—
An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.
-
endpoint
(String|AWS.Endpoint)
—
The endpoint URI to send requests to. The default endpoint is built from the configured
region
. The endpoint should be a string like'https://{service}.{region}.amazonaws.com'
or an Endpoint object. -
accessKeyId
(String)
—
your AWS access key ID.
-
secretAccessKey
(String)
—
your AWS secret access key.
-
sessionToken
(AWS.Credentials)
—
the optional AWS session token to sign requests with.
-
credentials
(AWS.Credentials)
—
the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.
-
credentialProvider
(AWS.CredentialProviderChain)
—
the provider chain used to resolve credentials if no static
credentials
property is set. -
region
(String)
—
the region to send service requests to. See AWS.OpenSearch.region for more information.
-
maxRetries
(Integer)
—
the maximum amount of retries to attempt with a request. See AWS.OpenSearch.maxRetries for more information.
-
maxRedirects
(Integer)
—
the maximum amount of redirects to follow with a request. See AWS.OpenSearch.maxRedirects for more information.
-
sslEnabled
(Boolean)
—
whether to enable SSL for requests.
-
paramValidation
(Boolean|map)
—
whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
true
. - max [Boolean] — Validates that a value meets the max constraint.
- pattern [Boolean] — Validates that a string value matches a regular expression.
- enum [Boolean] — Validates that a string value matches one of the allowable enum values.
- min [Boolean] — Validates that a value meets the min
constraint. This is enabled by default when paramValidation is set
to
-
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 totrue
. -
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
Method Details
acceptInboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see Cross-cluster search for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the acceptInboundConnection operation
var params = {
ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.acceptInboundConnection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ConnectionId
— (String
)The ID of the inbound connection to accept.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Connection
— (map
)Information about the accepted inbound connection.
LocalDomainInfo
— (map
)Information about the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Information about the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionId
— (String
)The unique identifier of the connection.
ConnectionStatus
— (map
)The current status of the connection.
StatusCode
— (String
)The status code for the connection. Can be one of the following:
-
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
-
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
-
PROVISIONING: Inbound connection is being provisioned.
-
ACTIVE: Inbound connection is active and ready to use.
-
REJECTING: Inbound connection rejection is in process.
-
REJECTED: Inbound connection is rejected.
-
DELETING: Inbound connection deletion is in progress.
-
DELETED: Inbound connection is deleted and can no longer be used.
"PENDING_ACCEPTANCE"
"APPROVED"
"PROVISIONING"
"ACTIVE"
"REJECTING"
"REJECTED"
"DELETING"
"DELETED"
-
Message
— (String
)Information about the connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
-
(AWS.Response)
—
Returns:
addDataSource(params = {}, callback) ⇒ AWS.Request
Creates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with Amazon S3.
Service Reference:
Examples:
Calling the addDataSource operation
var params = {
DataSourceType: { /* required */
S3GlueDataCatalog: {
RoleArn: 'STRING_VALUE'
}
},
DomainName: 'STRING_VALUE', /* required */
Name: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE'
};
opensearch.addDataSource(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain to add the data source to.
Name
— (String
)A name for the data source.
DataSourceType
— (map
)The type of data source.
S3GlueDataCatalog
— (map
)An Amazon S3 data source.
RoleArn
— (String
)>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
Description
— (String
)A description of the data source.
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. Thedata
object has the following properties:Message
— (String
)A message associated with creation of the data source.
-
(AWS.Response)
—
Returns:
addTags(params = {}, callback) ⇒ AWS.Request
Attaches tags to an existing Amazon OpenSearch Service domain. Tags are a set of case-sensitive key-value pairs. A domain can have up to 10 tags. For more information, see Tagging Amazon OpenSearch Service domains.
Service Reference:
Examples:
Calling the addTags operation
var params = {
ARN: 'STRING_VALUE', /* required */
TagList: [ /* required */
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE' /* required */
},
/* more items */
]
};
opensearch.addTags(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ARN
— (String
)Amazon Resource Name (ARN) for the OpenSearch Service domain to which you want to attach resource tags.
TagList
— (Array<map>
)List of resource tags.
Key
— required — (String
)The tag key. Tag keys must be unique for the domain to which they are attached.
Value
— required — (String
)The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of
project : Trinity
andcost-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.
-
(AWS.Response)
—
Returns:
associatePackage(params = {}, callback) ⇒ AWS.Request
Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the associatePackage operation
var params = {
DomainName: 'STRING_VALUE', /* required */
PackageID: 'STRING_VALUE' /* required */
};
opensearch.associatePackage(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
PackageID
— (String
)Internal ID of the package to associate with a domain. Use
DescribePackages
to find this value.DomainName
— (String
)Name of the domain to associate the package with.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainPackageDetails
— (map
)Information about a package that is associated with a domain.
PackageID
— (String
)Internal ID of the package.
PackageName
— (String
)User-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
LastUpdated
— (Date
)Timestamp of the most recent update to the package association status.
DomainName
— (String
)Name of the domain that the package is associated with.
DomainPackageStatus
— (String
)State of the association.
Possible values include:"ASSOCIATING"
"ASSOCIATION_FAILED"
"ACTIVE"
"DISSOCIATING"
"DISSOCIATION_FAILED"
PackageVersion
— (String
)The current version of the package.
ReferencePath
— (String
)The relative path of the package on the OpenSearch Service cluster nodes. This is
synonym_path
when the package is for synonym files.ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
authorizeVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request
Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
Service Reference:
Examples:
Calling the authorizeVpcEndpointAccess operation
var params = {
Account: 'STRING_VALUE', /* required */
DomainName: 'STRING_VALUE' /* required */
};
opensearch.authorizeVpcEndpointAccess(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the OpenSearch Service domain to provide access to.
Account
— (String
)The Amazon Web Services account ID to grant access to.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:AuthorizedPrincipal
— (map
)Information about the Amazon Web Services account or service that was provided access to the domain.
PrincipalType
— (String
)The type of principal.
Possible values include:"AWS_ACCOUNT"
"AWS_SERVICE"
Principal
— (String
)The IAM principal that is allowed access to the domain.
-
(AWS.Response)
—
Returns:
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
};
opensearch.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
)The name of an OpenSearch Service domain. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
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. Thedata
object has the following properties: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.
DryRun
— (Boolean
)Whether or not the request was a dry run. If
True
, the changes were not actually cancelled.
-
(AWS.Response)
—
Returns:
cancelServiceSoftwareUpdate(params = {}, callback) ⇒ AWS.Request
Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate
and when the domain's UpdateStatus
is PENDING_UPDATE
. For more information, see Service software updates in Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the cancelServiceSoftwareUpdate operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.cancelServiceSoftwareUpdate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)Name of the OpenSearch Service domain that you want to cancel the service software update on.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ServiceSoftwareOptions
— (map
)Container for the state of your domain relative to the latest service software.
CurrentVersion
— (String
)The current service software version present on the domain.
NewVersion
— (String
)The new service software version, if one is available.
UpdateAvailable
— (Boolean
)True if you're able to update your service software version. False if you can't update your service software version.
Cancellable
— (Boolean
)True if you're able to cancel your service software version update. False if you can't cancel your service software update.
UpdateStatus
— (String
)The status of your service software update.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Description
— (String
)A description of the service software update status.
AutomatedUpdateDate
— (Date
)The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment
— (Boolean
)True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
-
(AWS.Response)
—
Returns:
createDomain(params = {}, callback) ⇒ AWS.Request
Creates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains.
Service Reference:
Examples:
Calling the createDomain operation
var params = {
DomainName: 'STRING_VALUE', /* required */
AIMLOptions: {
NaturalLanguageQueryGenerationOptions: {
DesiredState: ENABLED | DISABLED
}
},
AccessPolicies: 'STRING_VALUE',
AdvancedOptions: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
},
AdvancedSecurityOptions: {
AnonymousAuthEnabled: true || false,
Enabled: true || false,
InternalUserDatabaseEnabled: true || false,
JWTOptions: {
Enabled: true || false,
PublicKey: 'STRING_VALUE',
RolesKey: 'STRING_VALUE',
SubjectKey: 'STRING_VALUE'
},
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 */
],
UseOffPeakWindow: true || false
},
ClusterConfig: {
ColdStorageOptions: {
Enabled: true || false /* required */
},
DedicatedMasterCount: 'NUMBER_VALUE',
DedicatedMasterEnabled: true || false,
DedicatedMasterType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | or1.medium.search | or1.large.search | or1.xlarge.search | or1.2xlarge.search | or1.4xlarge.search | or1.8xlarge.search | or1.12xlarge.search | or1.16xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
InstanceCount: 'NUMBER_VALUE',
InstanceType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | or1.medium.search | or1.large.search | or1.xlarge.search | or1.2xlarge.search | or1.4xlarge.search | or1.8xlarge.search | or1.12xlarge.search | or1.16xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
MultiAZWithStandbyEnabled: true || false,
WarmCount: 'NUMBER_VALUE',
WarmEnabled: true || false,
WarmType: ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search,
ZoneAwarenessConfig: {
AvailabilityZoneCount: 'NUMBER_VALUE'
},
ZoneAwarenessEnabled: true || false
},
CognitoOptions: {
Enabled: true || false,
IdentityPoolId: 'STRING_VALUE',
RoleArn: 'STRING_VALUE',
UserPoolId: 'STRING_VALUE'
},
DomainEndpointOptions: {
CustomEndpoint: 'STRING_VALUE',
CustomEndpointCertificateArn: 'STRING_VALUE',
CustomEndpointEnabled: true || false,
EnforceHTTPS: true || false,
TLSSecurityPolicy: Policy-Min-TLS-1-0-2019-07 | Policy-Min-TLS-1-2-2019-07 | 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
},
EncryptionAtRestOptions: {
Enabled: true || false,
KmsKeyId: 'STRING_VALUE'
},
EngineVersion: 'STRING_VALUE',
IPAddressType: ipv4 | dualstack,
LogPublishingOptions: {
'<LogType>': {
CloudWatchLogsLogGroupArn: 'STRING_VALUE',
Enabled: true || false
},
/* '<LogType>': ... */
},
NodeToNodeEncryptionOptions: {
Enabled: true || false
},
OffPeakWindowOptions: {
Enabled: true || false,
OffPeakWindow: {
WindowStartTime: {
Hours: 'NUMBER_VALUE', /* required */
Minutes: 'NUMBER_VALUE' /* required */
}
}
},
SnapshotOptions: {
AutomatedSnapshotStartHour: 'NUMBER_VALUE'
},
SoftwareUpdateOptions: {
AutoSoftwareUpdateEnabled: true || false
},
TagList: [
{
Key: 'STRING_VALUE', /* required */
Value: 'STRING_VALUE' /* required */
},
/* more items */
],
VPCOptions: {
SecurityGroupIds: [
'STRING_VALUE',
/* more items */
],
SubnetIds: [
'STRING_VALUE',
/* more items */
]
}
};
opensearch.createDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)Name of the OpenSearch Service domain to create. Domain names are unique across the domains owned by an account within an Amazon Web Services Region.
EngineVersion
— (String
)String of format Elasticsearch_X.Y or OpenSearch_X.Y to specify the engine version for the OpenSearch Service domain. For example,
OpenSearch_1.0
orElasticsearch_7.9
. For more information, see Creating and managing Amazon OpenSearch Service domains.ClusterConfig
— (map
)Container for the cluster configuration of a domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
EBSOptions
— (map
)Container for the parameters required to enable EBS-based storage for an OpenSearch Service domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
AccessPolicies
— (String
)Identity and Access Management (IAM) policy document specifying the access policies for the new domain.
IPAddressType
— (String
)Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
Possible values include:"ipv4"
"dualstack"
SnapshotOptions
— (map
)DEPRECATED. Container for the parameters required to configure automated snapshots of domain indexes.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
VPCOptions
— (map
)Container for the values required to configure VPC access domains. If you don't specify these values, OpenSearch Service creates the domain with a public endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
CognitoOptions
— (map
)Key-value pairs to configure Amazon Cognito authentication. For more information, see Configuring Amazon Cognito authentication for OpenSearch Dashboards.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
EncryptionAtRestOptions
— (map
)Key-value pairs to enable encryption at rest.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
NodeToNodeEncryptionOptions
— (map
)Enables node-to-node encryption.
Enabled
— (Boolean
)True to enable node-to-node encryption.
AdvancedOptions
— (map<String>
)Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
-
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. -
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. -
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauses
error. -
"override_main_response_version": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether the domain reports its version as 7.10 to allow Elasticsearch OSS clients and plugins to continue working with it. Default is false when creating a domain and true when upgrading a domain.
For more information, see Advanced cluster parameters.
-
LogPublishingOptions
— (map<map>
)Key-value pairs to configure log publishing.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
AdvancedSecurityOptions
— (map
)Options for fine-grained access control.
Enabled
— (Boolean
)True to enable fine-grained access control.
InternalUserDatabaseEnabled
— (Boolean
)True to enable the internal user database.
MasterUserOptions
— (map
)Container for information about the master user.
MasterUserARN
— (String
)Amazon Resource Name (ARN) for the master user. Only specify if
InternalUserDatabaseEnabled
isfalse
.MasterUserName
— (String
)User name for the master user. Only specify if
InternalUserDatabaseEnabled
istrue
.MasterUserPassword
— (String
)Password for the master user. Only specify if
InternalUserDatabaseEnabled
istrue
.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True to enable SAML authentication for a domain.
Idp
— (map
)The SAML Identity Provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
MasterUserName
— (String
)The SAML master user name, which is stored in the domain's internal user database.
MasterBackendRole
— (String
)The backend role that the SAML master user is mapped to.
SubjectKey
— (String
)Element of the SAML assertion to use for the user name. Default is
NameID
.RolesKey
— (String
)Element of the SAML assertion to use for backend roles. Default is
roles
.SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True to enable JWT authentication and authorization for a domain.
SubjectKey
— (String
)Element of the JWT assertion to use for the user name.
RolesKey
— (String
)Element of the JWT assertion to use for roles.
PublicKey
— (String
)Element of the JWT assertion used by the cluster to verify JWT signatures.
AnonymousAuthEnabled
— (Boolean
)True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
TagList
— (Array<map>
)List of tags to add to the domain upon creation.
Key
— required — (String
)The tag key. Tag keys must be unique for the domain to which they are attached.
Value
— required — (String
)The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of
project : Trinity
andcost-center : Trinity
AutoTuneOptions
— (map
)Options for Auto-Tune.
DesiredState
— (String
)Whether Auto-Tune is enabled or disabled.
Possible values include:"ENABLED"
"DISABLED"
MaintenanceSchedules
— (Array<map>
)A list of maintenance schedules during which Auto-Tune can deploy changes. Maintenance windows are deprecated and have been replaced with off-peak windows.
StartAt
— (Date
)The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
Duration
— (map
)The duration of the maintenance schedule. For example,
"Duration": {"Value": 2, "Unit": "HOURS"}
.Value
— (Integer
)Integer to specify the value of a maintenance schedule duration.
Unit
— (String
)The unit of measurement for the duration of a maintenance schedule.
Possible values include:"HOURS"
CronExpressionForRecurrence
— (String
)A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
UseOffPeakWindow
— (Boolean
)Whether to schedule Auto-Tune optimizations that require blue/green deployments during the domain's configured daily off-peak window.
OffPeakWindowOptions
— (map
)Specifies a daily 10-hour time block during which OpenSearch Service can perform configuration changes on the domain, including service software updates and Auto-Tune enhancements that require a blue/green deployment. If no options are specified, the default start time of 10:00 P.M. local time (for the Region that the domain is created in) is used.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
SoftwareUpdateOptions
— (map
)Software update options for the domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
AIMLOptions
— (map
)Options for all machine learning features for the specified domain.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
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. Thedata
object has the following properties:DomainStatus
— (map
)The status of the newly created domain.
DomainId
— required — (String
)Unique identifier for the domain.
DomainName
— required — (String
)Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
ARN
— required — (String
)The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
Created
— (Boolean
)Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
Deleted
— (Boolean
)Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
Endpoint
— (String
)Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
EndpointV2
— (String
)If
IPAddressType
to set todualstack
, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.Endpoints
— (map<String>
)The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
-
IPv4 IP addresses -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
-
Dual stack IP addresses -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
-
DomainEndpointV2HostedZoneId
— (String
)The dual stack hosted zone ID for the domain.
Processing
— (Boolean
)The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing
— (Boolean
)The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch that the domain is running, in the format
Elasticsearch_X.Y
orOpenSearch_X.Y
.ClusterConfig
— required — (map
)Container for the cluster configuration of the domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
EBSOptions
— (map
)Container for EBS-based storage settings for the domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
AccessPolicies
— (String
)Identity and Access Management (IAM) policy document specifying the access policies for the domain.
IPAddressType
— (String
)The type of IP addresses supported by the endpoint for the domain.
Possible values include:"ipv4"
"dualstack"
SnapshotOptions
— (map
)DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
VPCOptions
— (map
)The VPC configuration for the domain.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
CognitoOptions
— (map
)Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
EncryptionAtRestOptions
— (map
)Encryption at rest settings for the domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
NodeToNodeEncryptionOptions
— (map
)Whether node-to-node encryption is enabled or disabled.
Enabled
— (Boolean
)True to enable node-to-node encryption.
AdvancedOptions
— (map<String>
)Key-value pairs that specify advanced configuration options.
LogPublishingOptions
— (map<map>
)Log publishing options for the domain.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
ServiceSoftwareOptions
— (map
)The current status of the domain's service software.
CurrentVersion
— (String
)The current service software version present on the domain.
NewVersion
— (String
)The new service software version, if one is available.
UpdateAvailable
— (Boolean
)True if you're able to update your service software version. False if you can't update your service software version.
Cancellable
— (Boolean
)True if you're able to cancel your service software version update. False if you can't cancel your service software update.
UpdateStatus
— (String
)The status of your service software update.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Description
— (String
)A description of the service software update status.
AutomatedUpdateDate
— (Date
)The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment
— (Boolean
)True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
AdvancedSecurityOptions
— (map
)Settings for fine-grained access control.
Enabled
— (Boolean
)True if fine-grained access control is enabled.
InternalUserDatabaseEnabled
— (Boolean
)True if the internal user database is enabled.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True if SAML is enabled.
Idp
— (map
)Describes the SAML identity provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
SubjectKey
— (String
)The key used for matching the SAML subject attribute.
RolesKey
— (String
)The key used for matching the SAML roles attribute.
SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True if JWT use is enabled.
SubjectKey
— (String
)The key used for matching the JWT subject attribute.
RolesKey
— (String
)The key used for matching the JWT roles attribute.
PublicKey
— (String
)The key used to verify the signature of incoming JWT requests.
AnonymousAuthDisableDate
— (Date
)Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
AnonymousAuthEnabled
— (Boolean
)True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
AutoTuneOptions
— (map
)Auto-Tune settings for the domain.
State
— (String
)The current state of Auto-Tune on the domain.
Possible values include:"ENABLED"
"DISABLED"
"ENABLE_IN_PROGRESS"
"DISABLE_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_SCHEDULED"
"DISABLED_AND_ROLLBACK_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_COMPLETE"
"DISABLED_AND_ROLLBACK_ERROR"
"ERROR"
ErrorMessage
— (String
)Any errors that occurred while enabling or disabling Auto-Tune.
UseOffPeakWindow
— (Boolean
)Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
ChangeProgressDetails
— (map
)Information about a configuration change happening on the domain.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
OffPeakWindowOptions
— (map
)Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
SoftwareUpdateOptions
— (map
)Service software update options for the domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
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"}
".
"PLAIN_TEXT"
"STRINGIFIED_JSON"
-
AIMLOptions
— (map
)Container for parameters required to enable all machine learning features.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
CurrentState
— (String
)The current state of the natural language query generation feature, indicating completion, in progress, or failure.
Possible values include:"NOT_ENABLED"
"ENABLE_COMPLETE"
"ENABLE_IN_PROGRESS"
"ENABLE_FAILED"
"DISABLE_COMPLETE"
"DISABLE_IN_PROGRESS"
"DISABLE_FAILED"
-
(AWS.Response)
—
Returns:
createOutboundConnection(params = {}, callback) ⇒ AWS.Request
Creates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the createOutboundConnection operation
var params = {
ConnectionAlias: 'STRING_VALUE', /* required */
LocalDomainInfo: { /* required */
AWSDomainInformation: {
DomainName: 'STRING_VALUE', /* required */
OwnerId: 'STRING_VALUE',
Region: 'STRING_VALUE'
}
},
RemoteDomainInfo: { /* required */
AWSDomainInformation: {
DomainName: 'STRING_VALUE', /* required */
OwnerId: 'STRING_VALUE',
Region: 'STRING_VALUE'
}
},
ConnectionMode: DIRECT | VPC_ENDPOINT,
ConnectionProperties: {
CrossClusterSearch: {
SkipUnavailable: ENABLED | DISABLED
},
Endpoint: 'STRING_VALUE'
}
};
opensearch.createOutboundConnection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
LocalDomainInfo
— (map
)Name and Region of the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Name and Region of the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionAlias
— (String
)Name of the connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
ConnectionProperties
— (map
)The
ConnectionProperties
for the outbound connection.Endpoint
— (String
)The Endpoint attribute cannot be modified.
The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.
CrossClusterSearch
— (map
)The connection properties for cross cluster search.
SkipUnavailable
— (String
)The status of the
Possible values include:SkipUnavailable
setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters."ENABLED"
"DISABLED"
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. Thedata
object has the following properties:LocalDomainInfo
— (map
)Information about the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Information about the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionAlias
— (String
)Name of the connection.
ConnectionStatus
— (map
)The status of the connection.
StatusCode
— (String
)The status code for the outbound connection. Can be one of the following:
-
VALIDATING - The outbound connection request is being validated.
-
VALIDATION_FAILED - Validation failed for the connection request.
-
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
-
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
-
PROVISIONING - Outbound connection request is in process.
-
ACTIVE - Outbound connection is active and ready to use.
-
REJECTING - Outbound connection rejection by remote domain owner is in progress.
-
REJECTED - Outbound connection request is rejected by remote domain owner.
-
DELETING - Outbound connection deletion is in progress.
-
DELETED - Outbound connection is deleted and can no longer be used.
"VALIDATING"
"VALIDATION_FAILED"
"PENDING_ACCEPTANCE"
"APPROVED"
"PROVISIONING"
"ACTIVE"
"REJECTING"
"REJECTED"
"DELETING"
"DELETED"
-
Message
— (String
)Verbose information for the outbound connection.
ConnectionId
— (String
)The unique identifier for the created outbound connection, which is used for subsequent operations on the connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
ConnectionProperties
— (map
)The
ConnectionProperties
for the newly created connection.Endpoint
— (String
)The Endpoint attribute cannot be modified.
The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.
CrossClusterSearch
— (map
)The connection properties for cross cluster search.
SkipUnavailable
— (String
)The status of the
Possible values include:SkipUnavailable
setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters."ENABLED"
"DISABLED"
-
(AWS.Response)
—
Returns:
createPackage(params = {}, callback) ⇒ AWS.Request
Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the createPackage operation
var params = {
PackageName: 'STRING_VALUE', /* required */
PackageSource: { /* required */
S3BucketName: 'STRING_VALUE',
S3Key: 'STRING_VALUE'
},
PackageType: TXT-DICTIONARY | ZIP-PLUGIN, /* required */
PackageDescription: 'STRING_VALUE'
};
opensearch.createPackage(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
PackageName
— (String
)Unique name for the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
PackageDescription
— (String
)Description of the package.
PackageSource
— (map
)The Amazon S3 location from which to import the package.
S3BucketName
— (String
)The name of the Amazon S3 bucket containing the package.
S3Key
— (String
)Key (file name) of the package.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:PackageDetails
— (map
)Basic information about an OpenSearch Service package.
PackageID
— (String
)The unique identifier of the package.
PackageName
— (String
)The user-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
PackageDescription
— (String
)User-specified description of the package.
PackageStatus
— (String
)The current status of the package. The available options are
Possible values include:AVAILABLE
,COPYING
,COPY_FAILED
,VALIDATNG
,VALIDATION_FAILED
,DELETING
, andDELETE_FAILED
."COPYING"
"COPY_FAILED"
"VALIDATING"
"VALIDATION_FAILED"
"AVAILABLE"
"DELETING"
"DELETED"
"DELETE_FAILED"
CreatedAt
— (Date
)The timestamp when the package was created.
LastUpdatedAt
— (Date
)Date and time when the package was last updated.
AvailablePackageVersion
— (String
)The package version.
ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties
— (map
)If the package is a
ZIP-PLUGIN
package, additional information about plugin properties.Name
— (String
)The name of the plugin.
Description
— (String
)The description of the plugin.
Version
— (String
)The version of the plugin.
ClassName
— (String
)The name of the class to load.
UncompressedSizeInBytes
— (Integer
)The uncompressed size of the plugin.
-
(AWS.Response)
—
Returns:
createVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Creates an Amazon OpenSearch Service-managed VPC endpoint.
Service Reference:
Examples:
Calling the createVpcEndpoint operation
var params = {
DomainArn: 'STRING_VALUE', /* required */
VpcOptions: { /* required */
SecurityGroupIds: [
'STRING_VALUE',
/* more items */
],
SubnetIds: [
'STRING_VALUE',
/* more items */
]
},
ClientToken: 'STRING_VALUE'
};
opensearch.createVpcEndpoint(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainArn
— (String
)The Amazon Resource Name (ARN) of the domain to create the endpoint for.
VpcOptions
— (map
)Options to specify the subnets and security groups for the endpoint.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
ClientToken
— (String
)Unique, case-sensitive identifier to ensure idempotency of the request.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:VpcEndpoint
— (map
)Information about the newly created VPC endpoint.
VpcEndpointId
— (String
)The unique identifier of the endpoint.
VpcEndpointOwner
— (String
)The creator of the endpoint.
DomainArn
— (String
)The Amazon Resource Name (ARN) of the domain associated with the endpoint.
VpcOptions
— (map
)Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
Status
— (String
)The current status of the endpoint.
Possible values include:"CREATING"
"CREATE_FAILED"
"ACTIVE"
"UPDATING"
"UPDATE_FAILED"
"DELETING"
"DELETE_FAILED"
Endpoint
— (String
)The connection endpoint ID for connecting to the domain.
-
(AWS.Response)
—
Returns:
deleteDataSource(params = {}, callback) ⇒ AWS.Request
Deletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3.
Service Reference:
Examples:
Calling the deleteDataSource operation
var params = {
DomainName: 'STRING_VALUE', /* required */
Name: 'STRING_VALUE' /* required */
};
opensearch.deleteDataSource(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.
Name
— (String
)The name of the data source to 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. Thedata
object has the following properties:Message
— (String
)A message associated with deletion of the data source.
-
(AWS.Response)
—
Returns:
deleteDomain(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it.
Service Reference:
Examples:
Calling the deleteDomain operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.deleteDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain you want to permanently delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainStatus
— (map
)The status of the domain being deleted.
DomainId
— required — (String
)Unique identifier for the domain.
DomainName
— required — (String
)Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
ARN
— required — (String
)The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
Created
— (Boolean
)Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
Deleted
— (Boolean
)Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
Endpoint
— (String
)Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
EndpointV2
— (String
)If
IPAddressType
to set todualstack
, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.Endpoints
— (map<String>
)The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
-
IPv4 IP addresses -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
-
Dual stack IP addresses -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
-
DomainEndpointV2HostedZoneId
— (String
)The dual stack hosted zone ID for the domain.
Processing
— (Boolean
)The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing
— (Boolean
)The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch that the domain is running, in the format
Elasticsearch_X.Y
orOpenSearch_X.Y
.ClusterConfig
— required — (map
)Container for the cluster configuration of the domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
EBSOptions
— (map
)Container for EBS-based storage settings for the domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
AccessPolicies
— (String
)Identity and Access Management (IAM) policy document specifying the access policies for the domain.
IPAddressType
— (String
)The type of IP addresses supported by the endpoint for the domain.
Possible values include:"ipv4"
"dualstack"
SnapshotOptions
— (map
)DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
VPCOptions
— (map
)The VPC configuration for the domain.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
CognitoOptions
— (map
)Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
EncryptionAtRestOptions
— (map
)Encryption at rest settings for the domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
NodeToNodeEncryptionOptions
— (map
)Whether node-to-node encryption is enabled or disabled.
Enabled
— (Boolean
)True to enable node-to-node encryption.
AdvancedOptions
— (map<String>
)Key-value pairs that specify advanced configuration options.
LogPublishingOptions
— (map<map>
)Log publishing options for the domain.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
ServiceSoftwareOptions
— (map
)The current status of the domain's service software.
CurrentVersion
— (String
)The current service software version present on the domain.
NewVersion
— (String
)The new service software version, if one is available.
UpdateAvailable
— (Boolean
)True if you're able to update your service software version. False if you can't update your service software version.
Cancellable
— (Boolean
)True if you're able to cancel your service software version update. False if you can't cancel your service software update.
UpdateStatus
— (String
)The status of your service software update.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Description
— (String
)A description of the service software update status.
AutomatedUpdateDate
— (Date
)The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment
— (Boolean
)True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
AdvancedSecurityOptions
— (map
)Settings for fine-grained access control.
Enabled
— (Boolean
)True if fine-grained access control is enabled.
InternalUserDatabaseEnabled
— (Boolean
)True if the internal user database is enabled.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True if SAML is enabled.
Idp
— (map
)Describes the SAML identity provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
SubjectKey
— (String
)The key used for matching the SAML subject attribute.
RolesKey
— (String
)The key used for matching the SAML roles attribute.
SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True if JWT use is enabled.
SubjectKey
— (String
)The key used for matching the JWT subject attribute.
RolesKey
— (String
)The key used for matching the JWT roles attribute.
PublicKey
— (String
)The key used to verify the signature of incoming JWT requests.
AnonymousAuthDisableDate
— (Date
)Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
AnonymousAuthEnabled
— (Boolean
)True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
AutoTuneOptions
— (map
)Auto-Tune settings for the domain.
State
— (String
)The current state of Auto-Tune on the domain.
Possible values include:"ENABLED"
"DISABLED"
"ENABLE_IN_PROGRESS"
"DISABLE_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_SCHEDULED"
"DISABLED_AND_ROLLBACK_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_COMPLETE"
"DISABLED_AND_ROLLBACK_ERROR"
"ERROR"
ErrorMessage
— (String
)Any errors that occurred while enabling or disabling Auto-Tune.
UseOffPeakWindow
— (Boolean
)Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
ChangeProgressDetails
— (map
)Information about a configuration change happening on the domain.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
OffPeakWindowOptions
— (map
)Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
SoftwareUpdateOptions
— (map
)Service software update options for the domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
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"}
".
"PLAIN_TEXT"
"STRINGIFIED_JSON"
-
AIMLOptions
— (map
)Container for parameters required to enable all machine learning features.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
CurrentState
— (String
)The current state of the natural language query generation feature, indicating completion, in progress, or failure.
Possible values include:"NOT_ENABLED"
"ENABLE_COMPLETE"
"ENABLE_IN_PROGRESS"
"ENABLE_FAILED"
"DISABLE_COMPLETE"
"DISABLE_IN_PROGRESS"
"DISABLE_FAILED"
-
(AWS.Response)
—
Returns:
deleteInboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the deleteInboundConnection operation
var params = {
ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.deleteInboundConnection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ConnectionId
— (String
)The ID of the inbound connection to permanently delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Connection
— (map
)The deleted inbound connection.
LocalDomainInfo
— (map
)Information about the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Information about the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionId
— (String
)The unique identifier of the connection.
ConnectionStatus
— (map
)The current status of the connection.
StatusCode
— (String
)The status code for the connection. Can be one of the following:
-
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
-
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
-
PROVISIONING: Inbound connection is being provisioned.
-
ACTIVE: Inbound connection is active and ready to use.
-
REJECTING: Inbound connection rejection is in process.
-
REJECTED: Inbound connection is rejected.
-
DELETING: Inbound connection deletion is in progress.
-
DELETED: Inbound connection is deleted and can no longer be used.
"PENDING_ACCEPTANCE"
"APPROVED"
"PROVISIONING"
"ACTIVE"
"REJECTING"
"REJECTED"
"DELETING"
"DELETED"
-
Message
— (String
)Information about the connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
-
(AWS.Response)
—
Returns:
deleteOutboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see Cross-cluster search for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the deleteOutboundConnection operation
var params = {
ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.deleteOutboundConnection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ConnectionId
— (String
)The ID of the outbound connection you want to permanently delete.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Connection
— (map
)The deleted inbound connection.
LocalDomainInfo
— (map
)Information about the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Information about the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionId
— (String
)Unique identifier of the connection.
ConnectionAlias
— (String
)Name of the connection.
ConnectionStatus
— (map
)Status of the connection.
StatusCode
— (String
)The status code for the outbound connection. Can be one of the following:
-
VALIDATING - The outbound connection request is being validated.
-
VALIDATION_FAILED - Validation failed for the connection request.
-
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
-
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
-
PROVISIONING - Outbound connection request is in process.
-
ACTIVE - Outbound connection is active and ready to use.
-
REJECTING - Outbound connection rejection by remote domain owner is in progress.
-
REJECTED - Outbound connection request is rejected by remote domain owner.
-
DELETING - Outbound connection deletion is in progress.
-
DELETED - Outbound connection is deleted and can no longer be used.
"VALIDATING"
"VALIDATION_FAILED"
"PENDING_ACCEPTANCE"
"APPROVED"
"PROVISIONING"
"ACTIVE"
"REJECTING"
"REJECTED"
"DELETING"
"DELETED"
-
Message
— (String
)Verbose information for the outbound connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
ConnectionProperties
— (map
)Properties for the outbound connection.
Endpoint
— (String
)The Endpoint attribute cannot be modified.
The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.
CrossClusterSearch
— (map
)The connection properties for cross cluster search.
SkipUnavailable
— (String
)The status of the
Possible values include:SkipUnavailable
setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters."ENABLED"
"DISABLED"
-
(AWS.Response)
—
Returns:
deletePackage(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the deletePackage operation
var params = {
PackageID: 'STRING_VALUE' /* required */
};
opensearch.deletePackage(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
PackageID
— (String
)The internal ID of the package you want to delete. Use
DescribePackages
to find this value.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:PackageDetails
— (map
)Information about the deleted package.
PackageID
— (String
)The unique identifier of the package.
PackageName
— (String
)The user-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
PackageDescription
— (String
)User-specified description of the package.
PackageStatus
— (String
)The current status of the package. The available options are
Possible values include:AVAILABLE
,COPYING
,COPY_FAILED
,VALIDATNG
,VALIDATION_FAILED
,DELETING
, andDELETE_FAILED
."COPYING"
"COPY_FAILED"
"VALIDATING"
"VALIDATION_FAILED"
"AVAILABLE"
"DELETING"
"DELETED"
"DELETE_FAILED"
CreatedAt
— (Date
)The timestamp when the package was created.
LastUpdatedAt
— (Date
)Date and time when the package was last updated.
AvailablePackageVersion
— (String
)The package version.
ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties
— (map
)If the package is a
ZIP-PLUGIN
package, additional information about plugin properties.Name
— (String
)The name of the plugin.
Description
— (String
)The description of the plugin.
Version
— (String
)The version of the plugin.
ClassName
— (String
)The name of the class to load.
UncompressedSizeInBytes
— (Integer
)The uncompressed size of the plugin.
-
(AWS.Response)
—
Returns:
deleteVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
Service Reference:
Examples:
Calling the deleteVpcEndpoint operation
var params = {
VpcEndpointId: 'STRING_VALUE' /* required */
};
opensearch.deleteVpcEndpoint(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
VpcEndpointId
— (String
)The unique identifier of the endpoint.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:VpcEndpointSummary
— (map
)Information about the deleted endpoint, including its current status (
DELETING
orDELETE_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"
-
(AWS.Response)
—
Returns:
describeDomain(params = {}, callback) ⇒ AWS.Request
Describes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.
Service Reference:
Examples:
Calling the describeDomain operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.describeDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain that you want information about.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainStatus
— (map
)List that contains the status of each specified OpenSearch Service domain.
DomainId
— required — (String
)Unique identifier for the domain.
DomainName
— required — (String
)Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
ARN
— required — (String
)The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
Created
— (Boolean
)Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
Deleted
— (Boolean
)Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
Endpoint
— (String
)Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
EndpointV2
— (String
)If
IPAddressType
to set todualstack
, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.Endpoints
— (map<String>
)The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
-
IPv4 IP addresses -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
-
Dual stack IP addresses -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
-
DomainEndpointV2HostedZoneId
— (String
)The dual stack hosted zone ID for the domain.
Processing
— (Boolean
)The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing
— (Boolean
)The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch that the domain is running, in the format
Elasticsearch_X.Y
orOpenSearch_X.Y
.ClusterConfig
— required — (map
)Container for the cluster configuration of the domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
EBSOptions
— (map
)Container for EBS-based storage settings for the domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
AccessPolicies
— (String
)Identity and Access Management (IAM) policy document specifying the access policies for the domain.
IPAddressType
— (String
)The type of IP addresses supported by the endpoint for the domain.
Possible values include:"ipv4"
"dualstack"
SnapshotOptions
— (map
)DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
VPCOptions
— (map
)The VPC configuration for the domain.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
CognitoOptions
— (map
)Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
EncryptionAtRestOptions
— (map
)Encryption at rest settings for the domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
NodeToNodeEncryptionOptions
— (map
)Whether node-to-node encryption is enabled or disabled.
Enabled
— (Boolean
)True to enable node-to-node encryption.
AdvancedOptions
— (map<String>
)Key-value pairs that specify advanced configuration options.
LogPublishingOptions
— (map<map>
)Log publishing options for the domain.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
ServiceSoftwareOptions
— (map
)The current status of the domain's service software.
CurrentVersion
— (String
)The current service software version present on the domain.
NewVersion
— (String
)The new service software version, if one is available.
UpdateAvailable
— (Boolean
)True if you're able to update your service software version. False if you can't update your service software version.
Cancellable
— (Boolean
)True if you're able to cancel your service software version update. False if you can't cancel your service software update.
UpdateStatus
— (String
)The status of your service software update.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Description
— (String
)A description of the service software update status.
AutomatedUpdateDate
— (Date
)The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment
— (Boolean
)True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
AdvancedSecurityOptions
— (map
)Settings for fine-grained access control.
Enabled
— (Boolean
)True if fine-grained access control is enabled.
InternalUserDatabaseEnabled
— (Boolean
)True if the internal user database is enabled.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True if SAML is enabled.
Idp
— (map
)Describes the SAML identity provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
SubjectKey
— (String
)The key used for matching the SAML subject attribute.
RolesKey
— (String
)The key used for matching the SAML roles attribute.
SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True if JWT use is enabled.
SubjectKey
— (String
)The key used for matching the JWT subject attribute.
RolesKey
— (String
)The key used for matching the JWT roles attribute.
PublicKey
— (String
)The key used to verify the signature of incoming JWT requests.
AnonymousAuthDisableDate
— (Date
)Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
AnonymousAuthEnabled
— (Boolean
)True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
AutoTuneOptions
— (map
)Auto-Tune settings for the domain.
State
— (String
)The current state of Auto-Tune on the domain.
Possible values include:"ENABLED"
"DISABLED"
"ENABLE_IN_PROGRESS"
"DISABLE_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_SCHEDULED"
"DISABLED_AND_ROLLBACK_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_COMPLETE"
"DISABLED_AND_ROLLBACK_ERROR"
"ERROR"
ErrorMessage
— (String
)Any errors that occurred while enabling or disabling Auto-Tune.
UseOffPeakWindow
— (Boolean
)Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
ChangeProgressDetails
— (map
)Information about a configuration change happening on the domain.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
OffPeakWindowOptions
— (map
)Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
SoftwareUpdateOptions
— (map
)Service software update options for the domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
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"}
".
"PLAIN_TEXT"
"STRINGIFIED_JSON"
-
AIMLOptions
— (map
)Container for parameters required to enable all machine learning features.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
CurrentState
— (String
)The current state of the natural language query generation feature, indicating completion, in progress, or failure.
Possible values include:"NOT_ENABLED"
"ENABLE_COMPLETE"
"ENABLE_IN_PROGRESS"
"ENABLE_FAILED"
"DISABLE_COMPLETE"
"DISABLE_IN_PROGRESS"
"DISABLE_FAILED"
-
(AWS.Response)
—
Returns:
describeDomainAutoTunes(params = {}, callback) ⇒ AWS.Request
Returns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the describeDomainAutoTunes operation
var params = {
DomainName: 'STRING_VALUE', /* required */
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.describeDomainAutoTunes(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)Name of the domain that you want Auto-Tune details about.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
DescribeDomainAutoTunes
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribeDomainAutoTunes
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:AutoTunes
— (Array<map>
)The list of setting adjustments that Auto-Tune has made to the domain.
AutoTuneType
— (String
)The type of Auto-Tune action.
Possible values include:"SCHEDULED_ACTION"
AutoTuneDetails
— (map
)Details about an Auto-Tune action.
ScheduledAutoTuneDetails
— (map
)Container for details about a scheduled Auto-Tune action.
Date
— (Date
)The date and time when the Auto-Tune action is scheduled for the domain.
ActionType
— (String
)The type of Auto-Tune action.
Possible values include:"JVM_HEAP_SIZE_TUNING"
"JVM_YOUNG_GEN_TUNING"
Action
— (String
)A description of the Auto-Tune action.
Severity
— (String
)The severity of the Auto-Tune action. Valid values are
Possible values include:LOW
,MEDIUM
, andHIGH
."LOW"
"MEDIUM"
"HIGH"
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
describeDomainChangeProgress(params = {}, callback) ⇒ AWS.Request
Returns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration changes in Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the describeDomainChangeProgress operation
var params = {
DomainName: 'STRING_VALUE', /* required */
ChangeId: 'STRING_VALUE'
};
opensearch.describeDomainChangeProgress(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain to get progress information for.
ChangeId
— (String
)The specific change ID for which you want to get progress information. If omitted, the request returns information about the most recent configuration change.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ChangeProgressStatus
— (map
)Container for information about the stages of a configuration change happening on a domain.
ChangeId
— (String
)The unique change identifier associated with a specific domain configuration change.
StartTime
— (Date
)The time at which the configuration change is made on the domain.
Status
— (String
)The overall status of the domain configuration change.
Possible values include:"PENDING"
"PROCESSING"
"COMPLETED"
"FAILED"
PendingProperties
— (Array<String>
)The list of properties in the domain configuration change that are still pending.
CompletedProperties
— (Array<String>
)The list of properties in the domain configuration change that have completed.
TotalNumberOfStages
— (Integer
)The total number of stages required for the configuration change.
ChangeProgressStages
— (Array<map>
)The specific stages that the domain is going through to perform the configuration change.
Name
— (String
)The name of the stage.
Status
— (String
)The status of the stage.
Description
— (String
)The description of the stage.
LastUpdated
— (Date
)The most recent updated timestamp of the stage.
LastUpdatedTime
— (Date
)The last time that the status of the configuration change was updated.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
-
(AWS.Response)
—
Returns:
describeDomainConfig(params = {}, callback) ⇒ AWS.Request
Returns the configuration of an Amazon OpenSearch Service domain.
Service Reference:
Examples:
Calling the describeDomainConfig operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.describeDomainConfig(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)Name of the OpenSearch Service domain configuration that you want to describe.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainConfig
— (map
)Container for the configuration of the OpenSearch Service domain.
EngineVersion
— (map
)The OpenSearch or Elasticsearch version that the domain is running.
Options
— required — (String
)The OpenSearch or Elasticsearch version for the specified domain.
Status
— required — (map
)The status of the version options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
ClusterConfig
— (map
)Container for the cluster configuration of a the domain.
Options
— required — (map
)Cluster configuration options for the specified domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Status
— required — (map
)The status of cluster configuration options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
EBSOptions
— (map
)Container for EBS options configured for the domain.
Options
— required — (map
)The configured EBS options for the specified domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
Status
— required — (map
)The status of the EBS options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AccessPolicies
— (map
)Specifies the access policies for the domain.
Options
— required — (String
)The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.
Status
— required — (map
)The status of the access policy for the domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
IPAddressType
— (map
)Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
Options
— required — (String
)The IP address options for the domain.
Possible values include:"ipv4"
"dualstack"
Status
— required — (map
)Provides the current status of an entity.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
SnapshotOptions
— (map
)DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
Options
— required — (map
)The daily snapshot options specified for the domain.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
Status
— required — (map
)The status of a daily automated snapshot.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
VPCOptions
— (map
)The current VPC options for the domain and the status of any updates to their configuration.
Options
— required — (map
)The VPC options for the specified domain.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
Status
— required — (map
)The status of the VPC options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
CognitoOptions
— (map
)Container for Amazon Cognito options for the domain.
Options
— required — (map
)Cognito options for the specified domain.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
Status
— required — (map
)The status of the Cognito options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
EncryptionAtRestOptions
— (map
)Key-value pairs to enable encryption at rest.
Options
— required — (map
)Encryption at rest options for the specified domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
Status
— required — (map
)The status of the encryption at rest options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
NodeToNodeEncryptionOptions
— (map
)Whether node-to-node encryption is enabled or disabled.
Options
— required — (map
)The node-to-node encryption options for the specified domain.
Enabled
— (Boolean
)True to enable node-to-node encryption.
Status
— required — (map
)The status of the node-to-node encryption options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AdvancedOptions
— (map
)Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
Options
— required — (map<String>
)The status of advanced options for the specified domain.
Status
— required — (map
)The status of advanced options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
LogPublishingOptions
— (map
)Key-value pairs to configure log publishing.
Options
— (map<map>
)The log publishing options configured for the domain.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
Status
— (map
)The status of the log publishing options for the domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Options
— required — (map
)Options to configure the endpoint for a domain.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
Status
— required — (map
)The status of the endpoint options for a domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AdvancedSecurityOptions
— (map
)Container for fine-grained access control settings for the domain.
Options
— required — (map
)Container for fine-grained access control settings.
Enabled
— (Boolean
)True if fine-grained access control is enabled.
InternalUserDatabaseEnabled
— (Boolean
)True if the internal user database is enabled.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True if SAML is enabled.
Idp
— (map
)Describes the SAML identity provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
SubjectKey
— (String
)The key used for matching the SAML subject attribute.
RolesKey
— (String
)The key used for matching the SAML roles attribute.
SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True if JWT use is enabled.
SubjectKey
— (String
)The key used for matching the JWT subject attribute.
RolesKey
— (String
)The key used for matching the JWT roles attribute.
PublicKey
— (String
)The key used to verify the signature of incoming JWT requests.
AnonymousAuthDisableDate
— (Date
)Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
AnonymousAuthEnabled
— (Boolean
)True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
Status
— required — (map
)Status of the fine-grained access control settings for a domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AutoTuneOptions
— (map
)Container for Auto-Tune settings for the domain.
Options
— (map
)Auto-Tune settings for updating a domain.
DesiredState
— (String
)Whether Auto-Tune is enabled or disabled.
Possible values include:"ENABLED"
"DISABLED"
RollbackOnDisable
— (String
)When disabling Auto-Tune, specify
Possible values include:NO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specifyDEFAULT_ROLLBACK
, you must include aMaintenanceSchedule
in the request. Otherwise, OpenSearch Service is unable to perform the rollback."NO_ROLLBACK"
"DEFAULT_ROLLBACK"
MaintenanceSchedules
— (Array<map>
)DEPRECATED. Use off-peak window instead.
A list of maintenance schedules during which Auto-Tune can deploy changes.
StartAt
— (Date
)The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
Duration
— (map
)The duration of the maintenance schedule. For example,
"Duration": {"Value": 2, "Unit": "HOURS"}
.Value
— (Integer
)Integer to specify the value of a maintenance schedule duration.
Unit
— (String
)The unit of measurement for the duration of a maintenance schedule.
Possible values include:"HOURS"
CronExpressionForRecurrence
— (String
)A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
UseOffPeakWindow
— (Boolean
)Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
Status
— (map
)The current status of Auto-Tune for a domain.
CreationDate
— required — (Date
)Date and time when Auto-Tune was enabled for the domain.
UpdateDate
— required — (Date
)Date and time when the Auto-Tune options were last updated for the domain.
UpdateVersion
— (Integer
)The latest version of the Auto-Tune options.
State
— required — (String
)The current state of Auto-Tune on the domain.
Possible values include:"ENABLED"
"DISABLED"
"ENABLE_IN_PROGRESS"
"DISABLE_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_SCHEDULED"
"DISABLED_AND_ROLLBACK_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_COMPLETE"
"DISABLED_AND_ROLLBACK_ERROR"
"ERROR"
ErrorMessage
— (String
)Any errors that occurred while enabling or disabling Auto-Tune.
PendingDeletion
— (Boolean
)Indicates whether the domain is being deleted.
ChangeProgressDetails
— (map
)Container for information about the progress of an existing configuration change.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
OffPeakWindowOptions
— (map
)Container for off-peak window options for the domain.
Options
— (map
)The domain's off-peak window configuration.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
Status
— (map
)The current status of off-peak window options.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
SoftwareUpdateOptions
— (map
)Software update options for the domain.
Options
— (map
)The service software update options for a domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
Status
— (map
)The status of service software update options, including creation date and last updated date.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
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"}
".
"PLAIN_TEXT"
"STRINGIFIED_JSON"
-
AIMLOptions
— (map
)Container for parameters required to enable all machine learning features.
Options
— (map
)Machine learning options on the specified domain.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
CurrentState
— (String
)The current state of the natural language query generation feature, indicating completion, in progress, or failure.
Possible values include:"NOT_ENABLED"
"ENABLE_COMPLETE"
"ENABLE_IN_PROGRESS"
"ENABLE_FAILED"
"DISABLE_COMPLETE"
"DISABLE_IN_PROGRESS"
"DISABLE_FAILED"
Status
— (map
)Provides the current status of an entity.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
-
(AWS.Response)
—
Returns:
describeDomainHealth(params = {}, callback) ⇒ AWS.Request
Returns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.
Service Reference:
Examples:
Calling the describeDomainHealth operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.describeDomainHealth(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.
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. Thedata
object has the following properties:DomainState
— (String
)The current state of the domain.
-
Processing
- The domain has updates in progress. -
Active
- Requested changes have been processed and deployed to the domain.
"Active"
"Processing"
"NotAvailable"
-
AvailabilityZoneCount
— (String
)The number of Availability Zones configured for the domain. If the service is unable to fetch this information, it will return
NotAvailable
.ActiveAvailabilityZoneCount
— (String
)The number of active Availability Zones configured for the domain. If the service is unable to fetch this information, it will return
NotAvailable
.StandByAvailabilityZoneCount
— (String
)The number of standby Availability Zones configured for the domain. If the service is unable to fetch this information, it will return
NotAvailable
.DataNodeCount
— (String
)The number of data nodes configured for the domain. If the service is unable to fetch this information, it will return
NotAvailable
.DedicatedMaster
— (Boolean
)A boolean that indicates if dedicated master nodes are activated for the domain.
MasterEligibleNodeCount
— (String
)The number of nodes that can be elected as a master node. If dedicated master nodes is turned on, this value is the number of dedicated master nodes configured for the domain. If the service is unable to fetch this information, it will return
NotAvailable
.WarmNodeCount
— (String
)The number of warm nodes configured for the domain.
MasterNode
— (String
)Indicates whether the domain has an elected master node.
-
Available - The domain has an elected master node.
-
UnAvailable - The master node hasn't yet been elected, and a quorum to elect a new master node hasn't been reached.
"Available"
"UnAvailable"
-
ClusterHealth
— (String
)The current health status of your cluster.
-
Red
- At least one primary shard is not allocated to any node. -
Yellow
- All primary shards are allocated to nodes, but some replicas aren’t. -
Green
- All primary shards and their replicas are allocated to nodes. -
NotAvailable
- Unable to retrieve cluster health.
"Red"
"Yellow"
"Green"
"NotAvailable"
-
TotalShards
— (String
)The total number of primary and replica shards for the domain.
TotalUnAssignedShards
— (String
)The total number of primary and replica shards not allocated to any of the nodes for the cluster.
EnvironmentInformation
— (Array<map>
)A list of
EnvironmentInfo
for the domain.AvailabilityZoneInformation
— (Array<map>
)A list of
AvailabilityZoneInfo
for the domain.AvailabilityZoneName
— (String
)The name of the Availability Zone.
ZoneStatus
— (String
)The current state of the Availability Zone. Current options are
Active
andStandBy
.-
Active
- Data nodes in the Availability Zone are in use. -
StandBy
- Data nodes in the Availability Zone are in a standby state. -
NotAvailable
- Unable to retrieve information.
"Active"
"StandBy"
"NotAvailable"
-
ConfiguredDataNodeCount
— (String
)The total number of data nodes configured in the Availability Zone.
AvailableDataNodeCount
— (String
)The number of data nodes active in the Availability Zone.
TotalShards
— (String
)The total number of primary and replica shards in the Availability Zone.
TotalUnAssignedShards
— (String
)The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.
-
(AWS.Response)
—
Returns:
describeDomainNodes(params = {}, callback) ⇒ AWS.Request
Returns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.
Service Reference:
Examples:
Calling the describeDomainNodes operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.describeDomainNodes(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.
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. Thedata
object has the following properties:DomainNodesStatusList
— (Array<map>
)Contains nodes information list
DomainNodesStatusList
with details about the all nodes on the requested domain.NodeId
— (String
)The ID of the node.
NodeType
— (String
)Indicates whether the nodes is a data, master, or ultrawarm node.
Possible values include:"Data"
"Ultrawarm"
"Master"
AvailabilityZone
— (String
)The Availability Zone of the node.
InstanceType
— (String
)The instance type information of the node.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
NodeStatus
— (String
)Indicates if the node is active or in standby.
Possible values include:"Active"
"StandBy"
"NotAvailable"
StorageType
— (String
)Indicates if the node has EBS or instance storage.
StorageVolumeType
— (String
)If the nodes has EBS storage, indicates if the volume type is GP2 or GP3. Only applicable for data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
StorageSize
— (String
)The storage size of the node, in GiB.
-
(AWS.Response)
—
Returns:
describeDomains(params = {}, callback) ⇒ AWS.Request
Returns domain configuration information about the specified Amazon OpenSearch Service domains.
Service Reference:
Examples:
Calling the describeDomains operation
var params = {
DomainNames: [ /* required */
'STRING_VALUE',
/* more items */
]
};
opensearch.describeDomains(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainNames
— (Array<String>
)Array of OpenSearch Service domain names that you want information about. You must specify at least one domain name.
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. Thedata
object has the following properties:DomainStatusList
— (Array<map>
)The status of the requested domains.
DomainId
— required — (String
)Unique identifier for the domain.
DomainName
— required — (String
)Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
ARN
— required — (String
)The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
Created
— (Boolean
)Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
Deleted
— (Boolean
)Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
Endpoint
— (String
)Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
EndpointV2
— (String
)If
IPAddressType
to set todualstack
, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.Endpoints
— (map<String>
)The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
-
IPv4 IP addresses -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
-
Dual stack IP addresses -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
-
DomainEndpointV2HostedZoneId
— (String
)The dual stack hosted zone ID for the domain.
Processing
— (Boolean
)The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing
— (Boolean
)The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch that the domain is running, in the format
Elasticsearch_X.Y
orOpenSearch_X.Y
.ClusterConfig
— required — (map
)Container for the cluster configuration of the domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
EBSOptions
— (map
)Container for EBS-based storage settings for the domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
AccessPolicies
— (String
)Identity and Access Management (IAM) policy document specifying the access policies for the domain.
IPAddressType
— (String
)The type of IP addresses supported by the endpoint for the domain.
Possible values include:"ipv4"
"dualstack"
SnapshotOptions
— (map
)DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
VPCOptions
— (map
)The VPC configuration for the domain.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
CognitoOptions
— (map
)Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
EncryptionAtRestOptions
— (map
)Encryption at rest settings for the domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
NodeToNodeEncryptionOptions
— (map
)Whether node-to-node encryption is enabled or disabled.
Enabled
— (Boolean
)True to enable node-to-node encryption.
AdvancedOptions
— (map<String>
)Key-value pairs that specify advanced configuration options.
LogPublishingOptions
— (map<map>
)Log publishing options for the domain.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
ServiceSoftwareOptions
— (map
)The current status of the domain's service software.
CurrentVersion
— (String
)The current service software version present on the domain.
NewVersion
— (String
)The new service software version, if one is available.
UpdateAvailable
— (Boolean
)True if you're able to update your service software version. False if you can't update your service software version.
Cancellable
— (Boolean
)True if you're able to cancel your service software version update. False if you can't cancel your service software update.
UpdateStatus
— (String
)The status of your service software update.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Description
— (String
)A description of the service software update status.
AutomatedUpdateDate
— (Date
)The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment
— (Boolean
)True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
AdvancedSecurityOptions
— (map
)Settings for fine-grained access control.
Enabled
— (Boolean
)True if fine-grained access control is enabled.
InternalUserDatabaseEnabled
— (Boolean
)True if the internal user database is enabled.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True if SAML is enabled.
Idp
— (map
)Describes the SAML identity provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
SubjectKey
— (String
)The key used for matching the SAML subject attribute.
RolesKey
— (String
)The key used for matching the SAML roles attribute.
SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True if JWT use is enabled.
SubjectKey
— (String
)The key used for matching the JWT subject attribute.
RolesKey
— (String
)The key used for matching the JWT roles attribute.
PublicKey
— (String
)The key used to verify the signature of incoming JWT requests.
AnonymousAuthDisableDate
— (Date
)Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
AnonymousAuthEnabled
— (Boolean
)True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
AutoTuneOptions
— (map
)Auto-Tune settings for the domain.
State
— (String
)The current state of Auto-Tune on the domain.
Possible values include:"ENABLED"
"DISABLED"
"ENABLE_IN_PROGRESS"
"DISABLE_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_SCHEDULED"
"DISABLED_AND_ROLLBACK_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_COMPLETE"
"DISABLED_AND_ROLLBACK_ERROR"
"ERROR"
ErrorMessage
— (String
)Any errors that occurred while enabling or disabling Auto-Tune.
UseOffPeakWindow
— (Boolean
)Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
ChangeProgressDetails
— (map
)Information about a configuration change happening on the domain.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
OffPeakWindowOptions
— (map
)Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
SoftwareUpdateOptions
— (map
)Service software update options for the domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
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"}
".
"PLAIN_TEXT"
"STRINGIFIED_JSON"
-
AIMLOptions
— (map
)Container for parameters required to enable all machine learning features.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
CurrentState
— (String
)The current state of the natural language query generation feature, indicating completion, in progress, or failure.
Possible values include:"NOT_ENABLED"
"ENABLE_COMPLETE"
"ENABLE_IN_PROGRESS"
"ENABLE_FAILED"
"DISABLE_COMPLETE"
"DISABLE_IN_PROGRESS"
"DISABLE_FAILED"
-
(AWS.Response)
—
Returns:
describeDryRunProgress(params = {}, callback) ⇒ AWS.Request
Describes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will cause a blue/green deployment.
Service Reference:
Examples:
Calling the describeDryRunProgress operation
var params = {
DomainName: 'STRING_VALUE', /* required */
DryRunId: 'STRING_VALUE',
LoadDryRunConfig: true || false
};
opensearch.describeDryRunProgress(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.
DryRunId
— (String
)The unique identifier of the dry run.
LoadDryRunConfig
— (Boolean
)Whether to include the configuration of the dry run in the response. The configuration specifies the updates that you're planning to make on the domain.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DryRunProgressStatus
— (map
)The current status of the dry run, including any validation errors.
DryRunId
— required — (String
)The unique identifier of the dry run.
DryRunStatus
— required — (String
)The current status of the dry run.
CreationDate
— required — (String
)The timestamp when the dry run was initiated.
UpdateDate
— required — (String
)The timestamp when the dry run was last updated.
ValidationFailures
— (Array<map>
)Any validation failures that occurred as a result of the dry run.
Code
— (String
)The error code of the failure.
Message
— (String
)A message corresponding to the failure.
DryRunConfig
— (map
)Details about the changes you're planning to make on the domain.
DomainId
— required — (String
)Unique identifier for the domain.
DomainName
— required — (String
)Name of the domain. Domain names are unique across all domains owned by the same account within an Amazon Web Services Region.
ARN
— required — (String
)The Amazon Resource Name (ARN) of the domain. For more information, see IAM identifiers in the AWS Identity and Access Management User Guide.
Created
— (Boolean
)Creation status of an OpenSearch Service domain. True if domain creation is complete. False if domain creation is still in progress.
Deleted
— (Boolean
)Deletion status of an OpenSearch Service domain. True if domain deletion is complete. False if domain deletion is still in progress. Once deletion is complete, the status of the domain is no longer returned.
Endpoint
— (String
)Domain-specific endpoint used to submit index, search, and data upload requests to the domain.
EndpointV2
— (String
)If
IPAddressType
to set todualstack
, a version 2 domain endpoint is provisioned. This endpoint functions like a normal endpoint, except that it works with both IPv4 and IPv6 IP addresses. Normal endpoints work only with IPv4 IP addresses.Endpoints
— (map<String>
)The key-value pair that exists if the OpenSearch Service domain uses VPC endpoints. For example:
-
IPv4 IP addresses -
'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'
-
Dual stack IP addresses -
'vpcv2':'vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.aos.us-east-1.on.aws'
-
DomainEndpointV2HostedZoneId
— (String
)The dual stack hosted zone ID for the domain.
Processing
— (Boolean
)The status of the domain configuration. True if OpenSearch Service is processing configuration changes. False if the configuration is active.
UpgradeProcessing
— (Boolean
)The status of a domain version upgrade to a new version of OpenSearch or Elasticsearch. True if OpenSearch Service is in the process of a version upgrade. False if the configuration is active.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch that the domain is running, in the format
Elasticsearch_X.Y
orOpenSearch_X.Y
.ClusterConfig
— required — (map
)Container for the cluster configuration of the domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
EBSOptions
— (map
)Container for EBS-based storage settings for the domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
AccessPolicies
— (String
)Identity and Access Management (IAM) policy document specifying the access policies for the domain.
IPAddressType
— (String
)The type of IP addresses supported by the endpoint for the domain.
Possible values include:"ipv4"
"dualstack"
SnapshotOptions
— (map
)DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
VPCOptions
— (map
)The VPC configuration for the domain.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
CognitoOptions
— (map
)Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
EncryptionAtRestOptions
— (map
)Encryption at rest settings for the domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
NodeToNodeEncryptionOptions
— (map
)Whether node-to-node encryption is enabled or disabled.
Enabled
— (Boolean
)True to enable node-to-node encryption.
AdvancedOptions
— (map<String>
)Key-value pairs that specify advanced configuration options.
LogPublishingOptions
— (map<map>
)Log publishing options for the domain.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
ServiceSoftwareOptions
— (map
)The current status of the domain's service software.
CurrentVersion
— (String
)The current service software version present on the domain.
NewVersion
— (String
)The new service software version, if one is available.
UpdateAvailable
— (Boolean
)True if you're able to update your service software version. False if you can't update your service software version.
Cancellable
— (Boolean
)True if you're able to cancel your service software version update. False if you can't cancel your service software update.
UpdateStatus
— (String
)The status of your service software update.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Description
— (String
)A description of the service software update status.
AutomatedUpdateDate
— (Date
)The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment
— (Boolean
)True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
AdvancedSecurityOptions
— (map
)Settings for fine-grained access control.
Enabled
— (Boolean
)True if fine-grained access control is enabled.
InternalUserDatabaseEnabled
— (Boolean
)True if the internal user database is enabled.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True if SAML is enabled.
Idp
— (map
)Describes the SAML identity provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
SubjectKey
— (String
)The key used for matching the SAML subject attribute.
RolesKey
— (String
)The key used for matching the SAML roles attribute.
SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True if JWT use is enabled.
SubjectKey
— (String
)The key used for matching the JWT subject attribute.
RolesKey
— (String
)The key used for matching the JWT roles attribute.
PublicKey
— (String
)The key used to verify the signature of incoming JWT requests.
AnonymousAuthDisableDate
— (Date
)Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
AnonymousAuthEnabled
— (Boolean
)True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
AutoTuneOptions
— (map
)Auto-Tune settings for the domain.
State
— (String
)The current state of Auto-Tune on the domain.
Possible values include:"ENABLED"
"DISABLED"
"ENABLE_IN_PROGRESS"
"DISABLE_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_SCHEDULED"
"DISABLED_AND_ROLLBACK_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_COMPLETE"
"DISABLED_AND_ROLLBACK_ERROR"
"ERROR"
ErrorMessage
— (String
)Any errors that occurred while enabling or disabling Auto-Tune.
UseOffPeakWindow
— (Boolean
)Whether the domain's off-peak window will be used to deploy Auto-Tune changes rather than a maintenance schedule.
ChangeProgressDetails
— (map
)Information about a configuration change happening on the domain.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
OffPeakWindowOptions
— (map
)Options that specify a custom 10-hour window during which OpenSearch Service can perform configuration changes on the domain.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
SoftwareUpdateOptions
— (map
)Service software update options for the domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
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"}
".
"PLAIN_TEXT"
"STRINGIFIED_JSON"
-
AIMLOptions
— (map
)Container for parameters required to enable all machine learning features.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
CurrentState
— (String
)The current state of the natural language query generation feature, indicating completion, in progress, or failure.
Possible values include:"NOT_ENABLED"
"ENABLE_COMPLETE"
"ENABLE_IN_PROGRESS"
"ENABLE_FAILED"
"DISABLE_COMPLETE"
"DISABLE_IN_PROGRESS"
"DISABLE_FAILED"
DryRunResults
— (map
)The results of the dry run.
DeploymentType
— (String
)Specifies the way in which OpenSearch Service will apply an update. Possible values are:
-
Blue/Green - The update requires a blue/green deployment.
-
DynamicUpdate - No blue/green deployment required
-
Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.
-
None - The request doesn't include any configuration changes.
-
Message
— (String
)A message corresponding to the deployment type.
-
(AWS.Response)
—
Returns:
describeInboundConnections(params = {}, callback) ⇒ AWS.Request
Lists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the describeInboundConnections operation
var params = {
Filters: [
{
Name: 'STRING_VALUE',
Values: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.describeInboundConnections(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Filters
— (Array<map>
)A list of filters used to match properties for inbound cross-cluster connections.
Name
— (String
)The name of the filter.
Values
— (Array<String>
)One or more values for the filter.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
DescribeInboundConnections
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribeInboundConnections
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Connections
— (Array<map>
)List of inbound connections.
LocalDomainInfo
— (map
)Information about the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Information about the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionId
— (String
)The unique identifier of the connection.
ConnectionStatus
— (map
)The current status of the connection.
StatusCode
— (String
)The status code for the connection. Can be one of the following:
-
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
-
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
-
PROVISIONING: Inbound connection is being provisioned.
-
ACTIVE: Inbound connection is active and ready to use.
-
REJECTING: Inbound connection rejection is in process.
-
REJECTED: Inbound connection is rejected.
-
DELETING: Inbound connection deletion is in progress.
-
DELETED: Inbound connection is deleted and can no longer be used.
"PENDING_ACCEPTANCE"
"APPROVED"
"PROVISIONING"
"ACTIVE"
"REJECTING"
"REJECTED"
"DELETING"
"DELETED"
-
Message
— (String
)Information about the connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
describeInstanceTypeLimits(params = {}, callback) ⇒ AWS.Request
Describes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.
Service Reference:
Examples:
Calling the describeInstanceTypeLimits operation
var params = {
EngineVersion: 'STRING_VALUE', /* required */
InstanceType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | or1.medium.search | or1.large.search | or1.xlarge.search | or1.2xlarge.search | or1.4xlarge.search | or1.8xlarge.search | or1.12xlarge.search | or1.16xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search, /* required */
DomainName: 'STRING_VALUE'
};
opensearch.describeInstanceTypeLimits(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain. Only specify if you need the limits for an existing domain.
InstanceType
— (String
)The OpenSearch Service instance type for which you need limit information.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:LimitsByRole
— (map<map>
)Map that contains all applicable instance type limits.
data
refers to data nodes.master
refers to dedicated master nodes.StorageTypes
— (Array<map>
)Storage-related attributes that are available for a given instance type.
StorageTypeName
— (String
)The name of the storage type.
StorageSubTypeName
— (String
)The storage sub-type, such as
gp3
orio1
.StorageTypeLimits
— (Array<map>
)Limits that are applicable for the given storage type.
LimitName
— (String
)Name of storage limits that are applicable for the given storage type. If
StorageType
isebs
, the following options are available:-
MinimumVolumeSize - Minimum volume size that is available for the given storage type. Can be empty if not applicable.
-
MaximumVolumeSize - Maximum volume size that is available for the given storage type. Can be empty if not applicable.
-
MaximumIops - Maximum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
-
MinimumIops - Minimum amount of IOPS that is available for the given the storage type. Can be empty if not applicable.
-
MaximumThroughput - Maximum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
-
MinimumThroughput - Minimum amount of throughput that is available for the given the storage type. Can be empty if not applicable.
-
LimitValues
— (Array<String>
)The limit values.
InstanceLimits
— (map
)The limits for a given instance type.
InstanceCountLimits
— (map
)Limits on the number of instances that can be created for a given instance type.
MinimumInstanceCount
— (Integer
)The maximum allowed number of instances.
MaximumInstanceCount
— (Integer
)The minimum allowed number of instances.
AdditionalLimits
— (Array<map>
)List of additional limits that are specific to a given instance type for each of its instance roles.
LimitName
— (String
)-
MaximumNumberOfDataNodesSupported
- This attribute only applies to master nodes and specifies the maximum number of data nodes of a given instance type a master node can support. -
MaximumNumberOfDataNodesWithoutMasterNode
- This attribute only applies to data nodes and specifies the maximum number of data nodes of a given instance type can exist without a master node governing them.
-
LimitValues
— (Array<String>
)The values of the additional instance type limits.
-
(AWS.Response)
—
Returns:
describeOutboundConnections(params = {}, callback) ⇒ AWS.Request
Lists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the describeOutboundConnections operation
var params = {
Filters: [
{
Name: 'STRING_VALUE',
Values: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.describeOutboundConnections(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Filters
— (Array<map>
)List of filter names and values that you can use for requests.
Name
— (String
)The name of the filter.
Values
— (Array<String>
)One or more values for the filter.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
DescribeOutboundConnections
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribeOutboundConnections
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Connections
— (Array<map>
)List of outbound connections that match the filter criteria.
LocalDomainInfo
— (map
)Information about the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Information about the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionId
— (String
)Unique identifier of the connection.
ConnectionAlias
— (String
)Name of the connection.
ConnectionStatus
— (map
)Status of the connection.
StatusCode
— (String
)The status code for the outbound connection. Can be one of the following:
-
VALIDATING - The outbound connection request is being validated.
-
VALIDATION_FAILED - Validation failed for the connection request.
-
PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by the remote domain owner.
-
APPROVED - Outbound connection has been approved by the remote domain owner for getting provisioned.
-
PROVISIONING - Outbound connection request is in process.
-
ACTIVE - Outbound connection is active and ready to use.
-
REJECTING - Outbound connection rejection by remote domain owner is in progress.
-
REJECTED - Outbound connection request is rejected by remote domain owner.
-
DELETING - Outbound connection deletion is in progress.
-
DELETED - Outbound connection is deleted and can no longer be used.
"VALIDATING"
"VALIDATION_FAILED"
"PENDING_ACCEPTANCE"
"APPROVED"
"PROVISIONING"
"ACTIVE"
"REJECTING"
"REJECTED"
"DELETING"
"DELETED"
-
Message
— (String
)Verbose information for the outbound connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
ConnectionProperties
— (map
)Properties for the outbound connection.
Endpoint
— (String
)The Endpoint attribute cannot be modified.
The endpoint of the remote domain. Applicable for VPC_ENDPOINT connection mode.
CrossClusterSearch
— (map
)The connection properties for cross cluster search.
SkipUnavailable
— (String
)The status of the
Possible values include:SkipUnavailable
setting for the outbound connection. This feature allows you to specify some clusters as optional and ensure that your cross-cluster queries return partial results despite failures on one or more remote clusters."ENABLED"
"DISABLED"
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
describePackages(params = {}, callback) ⇒ AWS.Request
Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the describePackages operation
var params = {
Filters: [
{
Name: PackageID | PackageName | PackageStatus | PackageType | EngineVersion,
Value: [
'STRING_VALUE',
/* more items */
]
},
/* more items */
],
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.describePackages(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
Filters
— (Array<map>
)Only returns packages that match the
DescribePackagesFilterList
values.Name
— (String
)Any field from
Possible values include:PackageDetails
."PackageID"
"PackageName"
"PackageStatus"
"PackageType"
"EngineVersion"
Value
— (Array<String>
)A non-empty list of values for the specified filter field.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
DescribePackageFilters
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribePackageFilters
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:PackageDetailsList
— (Array<map>
)Basic information about a package.
PackageID
— (String
)The unique identifier of the package.
PackageName
— (String
)The user-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
PackageDescription
— (String
)User-specified description of the package.
PackageStatus
— (String
)The current status of the package. The available options are
Possible values include:AVAILABLE
,COPYING
,COPY_FAILED
,VALIDATNG
,VALIDATION_FAILED
,DELETING
, andDELETE_FAILED
."COPYING"
"COPY_FAILED"
"VALIDATING"
"VALIDATION_FAILED"
"AVAILABLE"
"DELETING"
"DELETED"
"DELETE_FAILED"
CreatedAt
— (Date
)The timestamp when the package was created.
LastUpdatedAt
— (Date
)Date and time when the package was last updated.
AvailablePackageVersion
— (String
)The package version.
ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties
— (map
)If the package is a
ZIP-PLUGIN
package, additional information about plugin properties.Name
— (String
)The name of the plugin.
Description
— (String
)The description of the plugin.
Version
— (String
)The version of the plugin.
ClassName
— (String
)The name of the class to load.
UncompressedSizeInBytes
— (Integer
)The uncompressed size of the plugin.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
describeReservedInstanceOfferings(params = {}, callback) ⇒ AWS.Request
Describes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the describeReservedInstanceOfferings operation
var params = {
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE',
ReservedInstanceOfferingId: 'STRING_VALUE'
};
opensearch.describeReservedInstanceOfferings(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ReservedInstanceOfferingId
— (String
)The Reserved Instance identifier filter value. Use this parameter to show only the available instance types that match the specified reservation identifier.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
DescribeReservedInstanceOfferings
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribeReservedInstanceOfferings
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.ReservedInstanceOfferings
— (Array<map>
)List of Reserved Instance offerings.
ReservedInstanceOfferingId
— (String
)The unique identifier of the Reserved Instance offering.
InstanceType
— (String
)The OpenSearch instance type offered by the Reserved Instance offering.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
Duration
— (Integer
)The duration, in seconds, for which the offering will reserve the OpenSearch instance.
FixedPrice
— (Float
)The upfront fixed charge you will pay to purchase the specific Reserved Instance offering.
UsagePrice
— (Float
)The hourly rate at which you're charged for the domain using this Reserved Instance.
CurrencyCode
— (String
)The currency code for the Reserved Instance offering.
PaymentOption
— (String
)Payment option for the Reserved Instance offering
Possible values include:"ALL_UPFRONT"
"PARTIAL_UPFRONT"
"NO_UPFRONT"
RecurringCharges
— (Array<map>
)The recurring charge to your account, regardless of whether you creates any domains using the offering.
RecurringChargeAmount
— (Float
)The monetary amount of the recurring charge.
RecurringChargeFrequency
— (String
)The frequency of the recurring charge.
-
(AWS.Response)
—
Returns:
describeReservedInstances(params = {}, callback) ⇒ AWS.Request
Describes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the describeReservedInstances operation
var params = {
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE',
ReservedInstanceId: 'STRING_VALUE'
};
opensearch.describeReservedInstances(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ReservedInstanceId
— (String
)The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved OpenSearch instance ID.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
DescribeReservedInstances
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribeReservedInstances
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.ReservedInstances
— (Array<map>
)List of Reserved Instances in the current Region.
ReservationName
— (String
)The customer-specified identifier to track this reservation.
ReservedInstanceId
— (String
)The unique identifier for the reservation.
BillingSubscriptionId
— (Integer
)The unique identifier of the billing subscription.
ReservedInstanceOfferingId
— (String
)The unique identifier of the Reserved Instance offering.
InstanceType
— (String
)The OpenSearch instance type offered by theReserved Instance offering.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
StartTime
— (Date
)The date and time when the reservation was purchased.
Duration
— (Integer
)The duration, in seconds, for which the OpenSearch instance is reserved.
FixedPrice
— (Float
)The upfront fixed charge you will paid to purchase the specific Reserved Instance offering.
UsagePrice
— (Float
)The hourly rate at which you're charged for the domain using this Reserved Instance.
CurrencyCode
— (String
)The currency code for the offering.
InstanceCount
— (Integer
)The number of OpenSearch instances that have been reserved.
State
— (String
)The state of the Reserved Instance.
PaymentOption
— (String
)The payment option as defined in the Reserved Instance offering.
Possible values include:"ALL_UPFRONT"
"PARTIAL_UPFRONT"
"NO_UPFRONT"
RecurringCharges
— (Array<map>
)The recurring charge to your account, regardless of whether you create any domains using the Reserved Instance offering.
RecurringChargeAmount
— (Float
)The monetary amount of the recurring charge.
RecurringChargeFrequency
— (String
)The frequency of the recurring charge.
-
(AWS.Response)
—
Returns:
describeVpcEndpoints(params = {}, callback) ⇒ AWS.Request
Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
Service Reference:
Examples:
Calling the describeVpcEndpoints operation
var params = {
VpcEndpointIds: [ /* required */
'STRING_VALUE',
/* more items */
]
};
opensearch.describeVpcEndpoints(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
VpcEndpointIds
— (Array<String>
)The unique identifiers of the endpoints to get information about.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:VpcEndpoints
— (Array<map>
)Information about each requested VPC endpoint.
VpcEndpointId
— (String
)The unique identifier of the endpoint.
VpcEndpointOwner
— (String
)The creator of the endpoint.
DomainArn
— (String
)The Amazon Resource Name (ARN) of the domain associated with the endpoint.
VpcOptions
— (map
)Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
Status
— (String
)The current status of the endpoint.
Possible values include:"CREATING"
"CREATE_FAILED"
"ACTIVE"
"UPDATING"
"UPDATE_FAILED"
"DELETING"
"DELETE_FAILED"
Endpoint
— (String
)The connection endpoint ID for connecting to the domain.
VpcEndpointErrors
— (Array<map>
)Any errors associated with the request.
VpcEndpointId
— (String
)The unique identifier of the endpoint.
ErrorCode
— (String
)The code associated with the error.
Possible values include:"ENDPOINT_NOT_FOUND"
"SERVER_ERROR"
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
dissociatePackage(params = {}, callback) ⇒ AWS.Request
Removes a package from the specified Amazon OpenSearch Service domain. The package can't be in use with any OpenSearch index for the dissociation to succeed. The package is still available in OpenSearch Service for association later. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the dissociatePackage operation
var params = {
DomainName: 'STRING_VALUE', /* required */
PackageID: 'STRING_VALUE' /* required */
};
opensearch.dissociatePackage(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
PackageID
— (String
)Internal ID of the package to dissociate from the domain. Use
ListPackagesForDomain
to find this value.DomainName
— (String
)Name of the domain to dissociate the package from.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainPackageDetails
— (map
)Information about a package that has been dissociated from the domain.
PackageID
— (String
)Internal ID of the package.
PackageName
— (String
)User-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
LastUpdated
— (Date
)Timestamp of the most recent update to the package association status.
DomainName
— (String
)Name of the domain that the package is associated with.
DomainPackageStatus
— (String
)State of the association.
Possible values include:"ASSOCIATING"
"ASSOCIATION_FAILED"
"ACTIVE"
"DISSOCIATING"
"DISSOCIATION_FAILED"
PackageVersion
— (String
)The current version of the package.
ReferencePath
— (String
)The relative path of the package on the OpenSearch Service cluster nodes. This is
synonym_path
when the package is for synonym files.ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
-
(AWS.Response)
—
Returns:
getCompatibleVersions(params = {}, callback) ⇒ AWS.Request
Returns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
Service Reference:
Examples:
Calling the getCompatibleVersions operation
var params = {
DomainName: 'STRING_VALUE'
};
opensearch.getCompatibleVersions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of an existing domain. Provide this parameter to limit the results to a single domain.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:CompatibleVersions
— (Array<map>
)A map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.
SourceVersion
— (String
)The current version that the OpenSearch Service domain is running.
TargetVersions
— (Array<String>
)The possible versions that you can upgrade the domain to.
-
(AWS.Response)
—
Returns:
getDataSource(params = {}, callback) ⇒ AWS.Request
Retrieves information about a direct query data source.
Service Reference:
Examples:
Calling the getDataSource operation
var params = {
DomainName: 'STRING_VALUE', /* required */
Name: 'STRING_VALUE' /* required */
};
opensearch.getDataSource(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.
Name
— (String
)The name of the data source 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. Thedata
object has the following properties:DataSourceType
— (map
)The type of data source.
S3GlueDataCatalog
— (map
)An Amazon S3 data source.
RoleArn
— (String
)>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
Name
— (String
)The name of the data source.
Description
— (String
)A description of the data source.
Status
— (String
)The status of the data source.
Possible values include:"ACTIVE"
"DISABLED"
-
(AWS.Response)
—
Returns:
getDomainMaintenanceStatus(params = {}, callback) ⇒ AWS.Request
The status of the maintenance action.
Service Reference:
Examples:
Calling the getDomainMaintenanceStatus operation
var params = {
DomainName: 'STRING_VALUE', /* required */
MaintenanceId: 'STRING_VALUE' /* required */
};
opensearch.getDomainMaintenanceStatus(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.
MaintenanceId
— (String
)The request ID of the maintenance action.
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. Thedata
object has the following properties:Status
— (String
)The status of the maintenance action.
Possible values include:"PENDING"
"IN_PROGRESS"
"COMPLETED"
"FAILED"
"TIMED_OUT"
StatusMessage
— (String
)The status message of the maintenance action.
NodeId
— (String
)The node ID of the maintenance action.
Action
— (String
)The action name.
Possible values include:"REBOOT_NODE"
"RESTART_SEARCH_PROCESS"
"RESTART_DASHBOARD"
CreatedAt
— (Date
)The time at which the action was created.
UpdatedAt
— (Date
)The time at which the action was updated.
-
(AWS.Response)
—
Returns:
getPackageVersionHistory(params = {}, callback) ⇒ AWS.Request
Returns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package). For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the getPackageVersionHistory operation
var params = {
PackageID: 'STRING_VALUE', /* required */
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.getPackageVersionHistory(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
PackageID
— (String
)The unique identifier of the package.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
GetPackageVersionHistory
operation returns anextToken
, you can include the returnednextToken
in subsequentGetPackageVersionHistory
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:PackageID
— (String
)The unique identifier of the package.
PackageVersionHistoryList
— (Array<map>
)A list of package versions, along with their creation time and commit message.
PackageVersion
— (String
)The package version.
CommitMessage
— (String
)A message associated with the package version when it was uploaded.
CreatedAt
— (Date
)The date and time when the package was created.
PluginProperties
— (map
)Additional information about plugin properties if the package is a
ZIP-PLUGIN
package.Name
— (String
)The name of the plugin.
Description
— (String
)The description of the plugin.
Version
— (String
)The version of the plugin.
ClassName
— (String
)The name of the class to load.
UncompressedSizeInBytes
— (Integer
)The uncompressed size of the plugin.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
getUpgradeHistory(params = {}, callback) ⇒ AWS.Request
Retrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.
Service Reference:
Examples:
Calling the getUpgradeHistory operation
var params = {
DomainName: 'STRING_VALUE', /* required */
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.getUpgradeHistory(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of an existing domain.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
GetUpgradeHistory
operation returns anextToken
, you can include the returnednextToken
in subsequentGetUpgradeHistory
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpgradeHistories
— (Array<map>
)A list of objects corresponding to each upgrade or upgrade eligibility check performed on a domain.
UpgradeName
— (String
)A string that describes the upgrade.
StartTimestamp
— (Date
)UTC timestamp at which the upgrade API call was made, in the format
yyyy-MM-ddTHH:mm:ssZ
.UpgradeStatus
— (String
)The current status of the upgrade. The status can take one of the following values:
-
In Progress
-
Succeeded
-
Succeeded with Issues
-
Failed
"IN_PROGRESS"
"SUCCEEDED"
"SUCCEEDED_WITH_ISSUES"
"FAILED"
-
StepsList
— (Array<map>
)A list of each step performed as part of a specific upgrade or upgrade eligibility check.
UpgradeStep
— (String
)One of three steps that an upgrade or upgrade eligibility check goes through:
-
PreUpgradeCheck
-
Snapshot
-
Upgrade
"PRE_UPGRADE_CHECK"
"SNAPSHOT"
"UPGRADE"
-
UpgradeStepStatus
— (String
)The current status of the upgrade. The status can take one of the following values:
-
In Progress
-
Succeeded
-
Succeeded with Issues
-
Failed
"IN_PROGRESS"
"SUCCEEDED"
"SUCCEEDED_WITH_ISSUES"
"FAILED"
-
Issues
— (Array<String>
)A list of strings containing detailed information about the errors encountered in a particular step.
ProgressPercent
— (Float
)The floating point value representing the progress percentage of a particular step.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
getUpgradeStatus(params = {}, callback) ⇒ AWS.Request
Returns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.
Service Reference:
Examples:
Calling the getUpgradeStatus operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.getUpgradeStatus(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The domain of the domain to get upgrade status information for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpgradeStep
— (String
)One of three steps that an upgrade or upgrade eligibility check goes through.
Possible values include:"PRE_UPGRADE_CHECK"
"SNAPSHOT"
"UPGRADE"
StepStatus
— (String
)The status of the current step that an upgrade is on.
Possible values include:"IN_PROGRESS"
"SUCCEEDED"
"SUCCEEDED_WITH_ISSUES"
"FAILED"
UpgradeName
— (String
)A string that describes the update.
-
(AWS.Response)
—
Returns:
listDataSources(params = {}, callback) ⇒ AWS.Request
Lists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct queries with Amazon S3.
Service Reference:
Examples:
Calling the listDataSources operation
var params = {
DomainName: 'STRING_VALUE' /* required */
};
opensearch.listDataSources(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.
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. Thedata
object has the following properties:DataSources
— (Array<map>
)A list of data sources associated with specified domain.
DataSourceType
— (map
)The type of data source.
S3GlueDataCatalog
— (map
)An Amazon S3 data source.
RoleArn
— (String
)>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
Name
— (String
)The name of the data source.
Description
— (String
)A description of the data source.
Status
— (String
)The status of the data source.
Possible values include:"ACTIVE"
"DISABLED"
-
(AWS.Response)
—
Returns:
listDomainMaintenances(params = {}, callback) ⇒ AWS.Request
A list of maintenance actions for the domain.
Service Reference:
Examples:
Calling the listDomainMaintenances operation
var params = {
DomainName: 'STRING_VALUE', /* required */
Action: REBOOT_NODE | RESTART_SEARCH_PROCESS | RESTART_DASHBOARD,
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE',
Status: PENDING | IN_PROGRESS | COMPLETED | FAILED | TIMED_OUT
};
opensearch.listDomainMaintenances(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.
Action
— (String
)The name of the action.
Possible values include:"REBOOT_NODE"
"RESTART_SEARCH_PROCESS"
"RESTART_DASHBOARD"
Status
— (String
)The status of the action.
Possible values include:"PENDING"
"IN_PROGRESS"
"COMPLETED"
"FAILED"
"TIMED_OUT"
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
ListDomainMaintenances
operation returns anextToken
, include the returnednextToken
in subsequentListDomainMaintenances
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainMaintenances
— (Array<map>
)A list of the submitted maintenance actions.
MaintenanceId
— (String
)The ID of the requested action.
DomainName
— (String
)The name of the domain.
Action
— (String
)The name of the action.
Possible values include:"REBOOT_NODE"
"RESTART_SEARCH_PROCESS"
"RESTART_DASHBOARD"
NodeId
— (String
)The ID of the data node.
Status
— (String
)The status of the action.
Possible values include:"PENDING"
"IN_PROGRESS"
"COMPLETED"
"FAILED"
"TIMED_OUT"
StatusMessage
— (String
)The status message for the action.
CreatedAt
— (Date
)The time at which the action was created.
UpdatedAt
— (Date
)The time at which the action was updated.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listDomainNames(params = {}, callback) ⇒ AWS.Request
Returns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.
Service Reference:
Examples:
Calling the listDomainNames operation
var params = {
EngineType: OpenSearch | Elasticsearch
};
opensearch.listDomainNames(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
EngineType
— (String
)Filters the output by domain engine type.
Possible values include:"OpenSearch"
"Elasticsearch"
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainNames
— (Array<map>
)The names of all OpenSearch Service domains owned by the current user and their respective engine types.
DomainName
— (String
)Name of the domain.
EngineType
— (String
)The type of search engine that the domain is running.
Possible values include:OpenSearch
for an OpenSearch engine, orElasticsearch
for a legacy Elasticsearch OSS engine."OpenSearch"
"Elasticsearch"
-
(AWS.Response)
—
Returns:
listDomainsForPackage(params = {}, callback) ⇒ AWS.Request
Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the listDomainsForPackage operation
var params = {
PackageID: 'STRING_VALUE', /* required */
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.listDomainsForPackage(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
PackageID
— (String
)The unique identifier of the package for which to list associated domains.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
ListDomainsForPackage
operation returns anextToken
, you can include the returnednextToken
in subsequentListDomainsForPackage
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainPackageDetailsList
— (Array<map>
)Information about all domains associated with a package.
PackageID
— (String
)Internal ID of the package.
PackageName
— (String
)User-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
LastUpdated
— (Date
)Timestamp of the most recent update to the package association status.
DomainName
— (String
)Name of the domain that the package is associated with.
DomainPackageStatus
— (String
)State of the association.
Possible values include:"ASSOCIATING"
"ASSOCIATION_FAILED"
"ACTIVE"
"DISSOCIATING"
"DISSOCIATION_FAILED"
PackageVersion
— (String
)The current version of the package.
ReferencePath
— (String
)The relative path of the package on the OpenSearch Service cluster nodes. This is
synonym_path
when the package is for synonym files.ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listInstanceTypeDetails(params = {}, callback) ⇒ AWS.Request
Lists all instance types and available features for a given OpenSearch or Elasticsearch version.
Service Reference:
Examples:
Calling the listInstanceTypeDetails operation
var params = {
EngineVersion: 'STRING_VALUE', /* required */
DomainName: 'STRING_VALUE',
InstanceType: 'STRING_VALUE',
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE',
RetrieveAZs: true || false
};
opensearch.listInstanceTypeDetails(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
EngineVersion
— (String
)The version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
DomainName
— (String
)The name of the domain.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
ListInstanceTypeDetails
operation returns anextToken
, you can include the returnednextToken
in subsequentListInstanceTypeDetails
operations, which returns results in the next page.RetrieveAZs
— (Boolean
)An optional parameter that specifies the Availability Zones for the domain.
InstanceType
— (String
)An optional parameter that lists information for a given instance type.
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. Thedata
object has the following properties:InstanceTypeDetails
— (Array<map>
)Lists all supported instance types and features for the given OpenSearch or Elasticsearch version.
InstanceType
— (String
)The instance type.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
EncryptionEnabled
— (Boolean
)Whether encryption at rest and node-to-node encryption are supported for the instance type.
CognitoEnabled
— (Boolean
)Whether Amazon Cognito access is supported for the instance type.
AppLogsEnabled
— (Boolean
)Whether logging is supported for the instance type.
AdvancedSecurityEnabled
— (Boolean
)Whether fine-grained access control is supported for the instance type.
WarmEnabled
— (Boolean
)Whether UltraWarm is supported for the instance type.
InstanceRole
— (Array<String>
)Whether the instance acts as a data node, a dedicated master node, or an UltraWarm node.
AvailabilityZones
— (Array<String>
)The supported Availability Zones for the instance type.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listPackagesForDomain(params = {}, callback) ⇒ AWS.Request
Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the listPackagesForDomain operation
var params = {
DomainName: 'STRING_VALUE', /* required */
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.listPackagesForDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain for which you want to list associated packages.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
ListPackagesForDomain
operation returns anextToken
, you can include the returnednextToken
in subsequentListPackagesForDomain
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:DomainPackageDetailsList
— (Array<map>
)List of all packages associated with a domain.
PackageID
— (String
)Internal ID of the package.
PackageName
— (String
)User-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
LastUpdated
— (Date
)Timestamp of the most recent update to the package association status.
DomainName
— (String
)Name of the domain that the package is associated with.
DomainPackageStatus
— (String
)State of the association.
Possible values include:"ASSOCIATING"
"ASSOCIATION_FAILED"
"ACTIVE"
"DISSOCIATING"
"DISSOCIATION_FAILED"
PackageVersion
— (String
)The current version of the package.
ReferencePath
— (String
)The relative path of the package on the OpenSearch Service cluster nodes. This is
synonym_path
when the package is for synonym files.ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listScheduledActions(params = {}, callback) ⇒ AWS.Request
Retrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements.
Service Reference:
Examples:
Calling the listScheduledActions operation
var params = {
DomainName: 'STRING_VALUE', /* required */
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.listScheduledActions(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.
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
ListScheduledActions
operation returns anextToken
, you can include the returnednextToken
in subsequentListScheduledActions
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ScheduledActions
— (Array<map>
)A list of actions that are scheduled for the domain.
Id
— required — (String
)The unique identifier of the scheduled action.
Type
— required — (String
)The type of action that will be taken on the domain.
Possible values include:"SERVICE_SOFTWARE_UPDATE"
"JVM_HEAP_SIZE_TUNING"
"JVM_YOUNG_GEN_TUNING"
Severity
— required — (String
)The severity of the action.
Possible values include:"HIGH"
"MEDIUM"
"LOW"
ScheduledTime
— required — (Integer
)The time when the change is scheduled to happen.
Description
— (String
)A description of the action to be taken.
ScheduledBy
— (String
)Whether the action was scheduled manually (
Possible values include:CUSTOMER
, or by OpenSearch Service automatically (SYSTEM
)."CUSTOMER"
"SYSTEM"
Status
— (String
)The current status of the scheduled action.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"FAILED"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Mandatory
— (Boolean
)Whether the action is required or optional.
Cancellable
— (Boolean
)Whether or not the scheduled action is cancellable.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listTags(params = {}, callback) ⇒ AWS.Request
Returns all resource tags for an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
Service Reference:
Examples:
Calling the listTags operation
var params = {
ARN: 'STRING_VALUE' /* required */
};
opensearch.listTags(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ARN
— (String
)Amazon Resource Name (ARN) for the domain to view tags for.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:TagList
— (Array<map>
)List of resource tags associated with the specified domain.
Key
— required — (String
)The tag key. Tag keys must be unique for the domain to which they are attached.
Value
— required — (String
)The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of
project : Trinity
andcost-center : Trinity
-
(AWS.Response)
—
Returns:
listVersions(params = {}, callback) ⇒ AWS.Request
Lists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
Service Reference:
Examples:
Calling the listVersions operation
var params = {
MaxResults: 'NUMBER_VALUE',
NextToken: 'STRING_VALUE'
};
opensearch.listVersions(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
MaxResults
— (Integer
)An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.NextToken
— (String
)If your initial
ListVersions
operation returns anextToken
, you can include the returnednextToken
in subsequentListVersions
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Versions
— (Array<String>
)A list of all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request
Retrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
Service Reference:
Examples:
Calling the listVpcEndpointAccess operation
var params = {
DomainName: 'STRING_VALUE', /* required */
NextToken: 'STRING_VALUE'
};
opensearch.listVpcEndpointAccess(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the OpenSearch Service domain to retrieve access information for.
NextToken
— (String
)If your initial
ListVpcEndpointAccess
operation returns anextToken
, you can include the returnednextToken
in subsequentListVpcEndpointAccess
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:AuthorizedPrincipalList
— (Array<map>
)A list of IAM principals that can currently access the domain.
PrincipalType
— (String
)The type of principal.
Possible values include:"AWS_ACCOUNT"
"AWS_SERVICE"
Principal
— (String
)The IAM principal that is allowed access to the domain.
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listVpcEndpoints(params = {}, callback) ⇒ AWS.Request
Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.
Service Reference:
Examples:
Calling the listVpcEndpoints operation
var params = {
NextToken: 'STRING_VALUE'
};
opensearch.listVpcEndpoints(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
NextToken
— (String
)If your initial
ListVpcEndpoints
operation returns anextToken
, you can include the returnednextToken
in subsequentListVpcEndpoints
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:VpcEndpointSummaryList
— (Array<map>
)Information about each endpoint.
VpcEndpointId
— (String
)The unique identifier of the endpoint.
VpcEndpointOwner
— (String
)The creator of the endpoint.
DomainArn
— (String
)The Amazon Resource Name (ARN) of the domain associated with the endpoint.
Status
— (String
)The current status of the endpoint.
Possible values include:"CREATING"
"CREATE_FAILED"
"ACTIVE"
"UPDATING"
"UPDATE_FAILED"
"DELETING"
"DELETE_FAILED"
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
listVpcEndpointsForDomain(params = {}, callback) ⇒ AWS.Request
Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
Service Reference:
Examples:
Calling the listVpcEndpointsForDomain operation
var params = {
DomainName: 'STRING_VALUE', /* required */
NextToken: 'STRING_VALUE'
};
opensearch.listVpcEndpointsForDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain to list associated VPC endpoints for.
NextToken
— (String
)If your initial
ListEndpointsForDomain
operation returns anextToken
, you can include the returnednextToken
in subsequentListEndpointsForDomain
operations, which returns results in the next page.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:VpcEndpointSummaryList
— (Array<map>
)Information about each endpoint associated with the domain.
VpcEndpointId
— (String
)The unique identifier of the endpoint.
VpcEndpointOwner
— (String
)The creator of the endpoint.
DomainArn
— (String
)The Amazon Resource Name (ARN) of the domain associated with the endpoint.
Status
— (String
)The current status of the endpoint.
Possible values include:"CREATING"
"CREATE_FAILED"
"ACTIVE"
"UPDATING"
"UPDATE_FAILED"
"DELETING"
"DELETE_FAILED"
NextToken
— (String
)When
nextToken
is returned, there are more results available. The value ofnextToken
is a unique pagination token for each page. Send the request again using the returned token to retrieve the next page.
-
(AWS.Response)
—
Returns:
purchaseReservedInstanceOffering(params = {}, callback) ⇒ AWS.Request
Allows you to purchase Amazon OpenSearch Service Reserved Instances.
Service Reference:
Examples:
Calling the purchaseReservedInstanceOffering operation
var params = {
ReservationName: 'STRING_VALUE', /* required */
ReservedInstanceOfferingId: 'STRING_VALUE', /* required */
InstanceCount: 'NUMBER_VALUE'
};
opensearch.purchaseReservedInstanceOffering(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ReservedInstanceOfferingId
— (String
)The ID of the Reserved Instance offering to purchase.
ReservationName
— (String
)A customer-specified identifier to track this reservation.
InstanceCount
— (Integer
)The number of OpenSearch instances to reserve.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:ReservedInstanceId
— (String
)The ID of the Reserved Instance offering that was purchased.
ReservationName
— (String
)The customer-specified identifier used to track this reservation.
-
(AWS.Response)
—
Returns:
rejectInboundConnection(params = {}, callback) ⇒ AWS.Request
Allows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.
Service Reference:
Examples:
Calling the rejectInboundConnection operation
var params = {
ConnectionId: 'STRING_VALUE' /* required */
};
opensearch.rejectInboundConnection(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ConnectionId
— (String
)The unique identifier of the inbound connection to reject.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:Connection
— (map
)Contains details about the rejected inbound connection.
LocalDomainInfo
— (map
)Information about the source (local) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
RemoteDomainInfo
— (map
)Information about the destination (remote) domain.
AWSDomainInformation
— (map
)Information about an Amazon OpenSearch Service domain.
OwnerId
— (String
)The Amazon Web Services account ID of the domain owner.
DomainName
— required — (String
)Name of the domain.
Region
— (String
)The Amazon Web Services Region in which the domain is located.
ConnectionId
— (String
)The unique identifier of the connection.
ConnectionStatus
— (map
)The current status of the connection.
StatusCode
— (String
)The status code for the connection. Can be one of the following:
-
PENDING_ACCEPTANCE - Inbound connection is not yet accepted by the remote domain owner.
-
APPROVED: Inbound connection is pending acceptance by the remote domain owner.
-
PROVISIONING: Inbound connection is being provisioned.
-
ACTIVE: Inbound connection is active and ready to use.
-
REJECTING: Inbound connection rejection is in process.
-
REJECTED: Inbound connection is rejected.
-
DELETING: Inbound connection deletion is in progress.
-
DELETED: Inbound connection is deleted and can no longer be used.
"PENDING_ACCEPTANCE"
"APPROVED"
"PROVISIONING"
"ACTIVE"
"REJECTING"
"REJECTED"
"DELETING"
"DELETED"
-
Message
— (String
)Information about the connection.
ConnectionMode
— (String
)The connection mode.
Possible values include:"DIRECT"
"VPC_ENDPOINT"
-
(AWS.Response)
—
Returns:
removeTags(params = {}, callback) ⇒ AWS.Request
Removes the specified set of tags from an Amazon OpenSearch Service domain. For more information, see Tagging Amazon OpenSearch Service domains.
Service Reference:
Examples:
Calling the removeTags operation
var params = {
ARN: 'STRING_VALUE', /* required */
TagKeys: [ /* required */
'STRING_VALUE',
/* more items */
]
};
opensearch.removeTags(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
ARN
— (String
)The Amazon Resource Name (ARN) of the domain from which you want to delete the specified tags.
TagKeys
— (Array<String>
)The list of tag keys to remove from the domain.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
revokeVpcEndpointAccess(params = {}, callback) ⇒ AWS.Request
Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
Service Reference:
Examples:
Calling the revokeVpcEndpointAccess operation
var params = {
Account: 'STRING_VALUE', /* required */
DomainName: 'STRING_VALUE' /* required */
};
opensearch.revokeVpcEndpointAccess(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the OpenSearch Service domain.
Account
— (String
)The account ID to revoke access from.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs.
-
(AWS.Response)
—
Returns:
startDomainMaintenance(params = {}, callback) ⇒ AWS.Request
Starts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a Dashboard or Kibana restart.
Service Reference:
Examples:
Calling the startDomainMaintenance operation
var params = {
Action: REBOOT_NODE | RESTART_SEARCH_PROCESS | RESTART_DASHBOARD, /* required */
DomainName: 'STRING_VALUE', /* required */
NodeId: 'STRING_VALUE'
};
opensearch.startDomainMaintenance(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.
Action
— (String
)The name of the action.
Possible values include:"REBOOT_NODE"
"RESTART_SEARCH_PROCESS"
"RESTART_DASHBOARD"
NodeId
— (String
)The ID of the data node.
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. Thedata
object has the following properties:MaintenanceId
— (String
)The request ID of requested action.
-
(AWS.Response)
—
Returns:
startServiceSoftwareUpdate(params = {}, callback) ⇒ AWS.Request
Schedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the startServiceSoftwareUpdate operation
var params = {
DomainName: 'STRING_VALUE', /* required */
DesiredStartTime: 'NUMBER_VALUE',
ScheduleAt: NOW | TIMESTAMP | OFF_PEAK_WINDOW
};
opensearch.startServiceSoftwareUpdate(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain that you want to update to the latest service software.
ScheduleAt
— (String
)When to start the service software update.
-
NOW
- Immediately schedules the update to happen in the current hour if there's capacity available. -
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value forDesiredStartTime
. -
OFF_PEAK_WINDOW
- Marks the update to be picked up during an upcoming off-peak window. There's no guarantee that the update will happen during the next immediate window. Depending on capacity, it might happen in subsequent days.
Default:
Possible values include:NOW
if you don't specify a value forDesiredStartTime
, andTIMESTAMP
if you do."NOW"
"TIMESTAMP"
"OFF_PEAK_WINDOW"
-
DesiredStartTime
— (Integer
)The Epoch timestamp when you want the service software update to start. You only need to specify this parameter if you set
ScheduleAt
toTIMESTAMP
.
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. Thedata
object has the following properties:ServiceSoftwareOptions
— (map
)The current status of the OpenSearch Service software update.
CurrentVersion
— (String
)The current service software version present on the domain.
NewVersion
— (String
)The new service software version, if one is available.
UpdateAvailable
— (Boolean
)True if you're able to update your service software version. False if you can't update your service software version.
Cancellable
— (Boolean
)True if you're able to cancel your service software version update. False if you can't cancel your service software update.
UpdateStatus
— (String
)The status of your service software update.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Description
— (String
)A description of the service software update status.
AutomatedUpdateDate
— (Date
)The timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
OptionalDeployment
— (Boolean
)True if a service software is never automatically updated. False if a service software is automatically updated after the automated update date.
-
(AWS.Response)
—
Returns:
updateDataSource(params = {}, callback) ⇒ AWS.Request
Updates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3.
Service Reference:
Examples:
Calling the updateDataSource operation
var params = {
DataSourceType: { /* required */
S3GlueDataCatalog: {
RoleArn: 'STRING_VALUE'
}
},
DomainName: 'STRING_VALUE', /* required */
Name: 'STRING_VALUE', /* required */
Description: 'STRING_VALUE',
Status: ACTIVE | DISABLED
};
opensearch.updateDataSource(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.
Name
— (String
)The name of the data source to modify.
DataSourceType
— (map
)The type of data source.
S3GlueDataCatalog
— (map
)An Amazon S3 data source.
RoleArn
— (String
)>The Amazon Resource Name (ARN) for the S3 Glue Data Catalog.
Description
— (String
)A new description of the data source.
Status
— (String
)The status of the data source update.
Possible values include:"ACTIVE"
"DISABLED"
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. Thedata
object has the following properties:Message
— (String
)A message associated with the updated data source.
-
(AWS.Response)
—
Returns:
updateDomainConfig(params = {}, callback) ⇒ AWS.Request
Modifies the cluster configuration of the specified Amazon OpenSearch Service domain.
Service Reference:
Examples:
Calling the updateDomainConfig operation
var params = {
DomainName: 'STRING_VALUE', /* required */
AIMLOptions: {
NaturalLanguageQueryGenerationOptions: {
DesiredState: ENABLED | DISABLED
}
},
AccessPolicies: 'STRING_VALUE',
AdvancedOptions: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
},
AdvancedSecurityOptions: {
AnonymousAuthEnabled: true || false,
Enabled: true || false,
InternalUserDatabaseEnabled: true || false,
JWTOptions: {
Enabled: true || false,
PublicKey: 'STRING_VALUE',
RolesKey: 'STRING_VALUE',
SubjectKey: 'STRING_VALUE'
},
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,
UseOffPeakWindow: true || false
},
ClusterConfig: {
ColdStorageOptions: {
Enabled: true || false /* required */
},
DedicatedMasterCount: 'NUMBER_VALUE',
DedicatedMasterEnabled: true || false,
DedicatedMasterType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | or1.medium.search | or1.large.search | or1.xlarge.search | or1.2xlarge.search | or1.4xlarge.search | or1.8xlarge.search | or1.12xlarge.search | or1.16xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
InstanceCount: 'NUMBER_VALUE',
InstanceType: m3.medium.search | m3.large.search | m3.xlarge.search | m3.2xlarge.search | m4.large.search | m4.xlarge.search | m4.2xlarge.search | m4.4xlarge.search | m4.10xlarge.search | m5.large.search | m5.xlarge.search | m5.2xlarge.search | m5.4xlarge.search | m5.12xlarge.search | m5.24xlarge.search | r5.large.search | r5.xlarge.search | r5.2xlarge.search | r5.4xlarge.search | r5.12xlarge.search | r5.24xlarge.search | c5.large.search | c5.xlarge.search | c5.2xlarge.search | c5.4xlarge.search | c5.9xlarge.search | c5.18xlarge.search | t3.nano.search | t3.micro.search | t3.small.search | t3.medium.search | t3.large.search | t3.xlarge.search | t3.2xlarge.search | or1.medium.search | or1.large.search | or1.xlarge.search | or1.2xlarge.search | or1.4xlarge.search | or1.8xlarge.search | or1.12xlarge.search | or1.16xlarge.search | ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search | t2.micro.search | t2.small.search | t2.medium.search | r3.large.search | r3.xlarge.search | r3.2xlarge.search | r3.4xlarge.search | r3.8xlarge.search | i2.xlarge.search | i2.2xlarge.search | d2.xlarge.search | d2.2xlarge.search | d2.4xlarge.search | d2.8xlarge.search | c4.large.search | c4.xlarge.search | c4.2xlarge.search | c4.4xlarge.search | c4.8xlarge.search | r4.large.search | r4.xlarge.search | r4.2xlarge.search | r4.4xlarge.search | r4.8xlarge.search | r4.16xlarge.search | i3.large.search | i3.xlarge.search | i3.2xlarge.search | i3.4xlarge.search | i3.8xlarge.search | i3.16xlarge.search | r6g.large.search | r6g.xlarge.search | r6g.2xlarge.search | r6g.4xlarge.search | r6g.8xlarge.search | r6g.12xlarge.search | m6g.large.search | m6g.xlarge.search | m6g.2xlarge.search | m6g.4xlarge.search | m6g.8xlarge.search | m6g.12xlarge.search | c6g.large.search | c6g.xlarge.search | c6g.2xlarge.search | c6g.4xlarge.search | c6g.8xlarge.search | c6g.12xlarge.search | r6gd.large.search | r6gd.xlarge.search | r6gd.2xlarge.search | r6gd.4xlarge.search | r6gd.8xlarge.search | r6gd.12xlarge.search | r6gd.16xlarge.search | t4g.small.search | t4g.medium.search,
MultiAZWithStandbyEnabled: true || false,
WarmCount: 'NUMBER_VALUE',
WarmEnabled: true || false,
WarmType: ultrawarm1.medium.search | ultrawarm1.large.search | ultrawarm1.xlarge.search,
ZoneAwarenessConfig: {
AvailabilityZoneCount: 'NUMBER_VALUE'
},
ZoneAwarenessEnabled: true || false
},
CognitoOptions: {
Enabled: true || false,
IdentityPoolId: 'STRING_VALUE',
RoleArn: 'STRING_VALUE',
UserPoolId: 'STRING_VALUE'
},
DomainEndpointOptions: {
CustomEndpoint: 'STRING_VALUE',
CustomEndpointCertificateArn: 'STRING_VALUE',
CustomEndpointEnabled: true || false,
EnforceHTTPS: true || false,
TLSSecurityPolicy: Policy-Min-TLS-1-0-2019-07 | Policy-Min-TLS-1-2-2019-07 | Policy-Min-TLS-1-2-PFS-2023-10
},
DryRun: true || false,
DryRunMode: Basic | Verbose,
EBSOptions: {
EBSEnabled: true || false,
Iops: 'NUMBER_VALUE',
Throughput: 'NUMBER_VALUE',
VolumeSize: 'NUMBER_VALUE',
VolumeType: standard | gp2 | io1 | gp3
},
EncryptionAtRestOptions: {
Enabled: true || false,
KmsKeyId: 'STRING_VALUE'
},
IPAddressType: ipv4 | dualstack,
LogPublishingOptions: {
'<LogType>': {
CloudWatchLogsLogGroupArn: 'STRING_VALUE',
Enabled: true || false
},
/* '<LogType>': ... */
},
NodeToNodeEncryptionOptions: {
Enabled: true || false
},
OffPeakWindowOptions: {
Enabled: true || false,
OffPeakWindow: {
WindowStartTime: {
Hours: 'NUMBER_VALUE', /* required */
Minutes: 'NUMBER_VALUE' /* required */
}
}
},
SnapshotOptions: {
AutomatedSnapshotStartHour: 'NUMBER_VALUE'
},
SoftwareUpdateOptions: {
AutoSoftwareUpdateEnabled: true || false
},
VPCOptions: {
SecurityGroupIds: [
'STRING_VALUE',
/* more items */
],
SubnetIds: [
'STRING_VALUE',
/* more items */
]
}
};
opensearch.updateDomainConfig(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain that you're updating.
ClusterConfig
— (map
)Changes that you want to make to the cluster configuration, such as the instance type and number of EC2 instances.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
EBSOptions
— (map
)The type and size of the EBS volume to attach to instances in the domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
SnapshotOptions
— (map
)Option to set the time, in UTC format, for the daily automated snapshot. Default value is
0
hours.AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
VPCOptions
— (map
)Options to specify the subnets and security groups for a VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
CognitoOptions
— (map
)Key-value pairs to configure Amazon Cognito authentication for OpenSearch Dashboards.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
AdvancedOptions
— (map<String>
)Key-value pairs to specify advanced configuration options. The following key-value pairs are supported:
-
"rest.action.multi.allow_explicit_index": "true" | "false"
- Note the use of a string rather than a boolean. Specifies whether explicit references to indexes are allowed inside the body of HTTP requests. If you want to configure access policies for domain sub-resources, such as specific indexes and domain APIs, you must disable this property. Default is true. -
"indices.fielddata.cache.size": "80"
- Note the use of a string rather than a boolean. Specifies the percentage of heap space allocated to field data. Default is unbounded. -
"indices.query.bool.max_clause_count": "1024"
- Note the use of a string rather than a boolean. Specifies the maximum number of clauses allowed in a Lucene boolean query. Default is 1,024. Queries with more than the permitted number of clauses result in aTooManyClauses
error.
For more information, see Advanced cluster parameters.
-
AccessPolicies
— (String
)Identity and Access Management (IAM) access policy as a JSON-formatted string.
IPAddressType
— (String
)Specify either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If your IP address type is currently set to dual stack, you can't change it.
Possible values include:"ipv4"
"dualstack"
LogPublishingOptions
— (map<map>
)Options to publish OpenSearch logs to Amazon CloudWatch Logs.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
EncryptionAtRestOptions
— (map
)Encryption at rest options for the domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
NodeToNodeEncryptionOptions
— (map
)Node-to-node encryption options for the domain.
Enabled
— (Boolean
)True to enable node-to-node encryption.
AdvancedSecurityOptions
— (map
)Options for fine-grained access control.
Enabled
— (Boolean
)True to enable fine-grained access control.
InternalUserDatabaseEnabled
— (Boolean
)True to enable the internal user database.
MasterUserOptions
— (map
)Container for information about the master user.
MasterUserARN
— (String
)Amazon Resource Name (ARN) for the master user. Only specify if
InternalUserDatabaseEnabled
isfalse
.MasterUserName
— (String
)User name for the master user. Only specify if
InternalUserDatabaseEnabled
istrue
.MasterUserPassword
— (String
)Password for the master user. Only specify if
InternalUserDatabaseEnabled
istrue
.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True to enable SAML authentication for a domain.
Idp
— (map
)The SAML Identity Provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
MasterUserName
— (String
)The SAML master user name, which is stored in the domain's internal user database.
MasterBackendRole
— (String
)The backend role that the SAML master user is mapped to.
SubjectKey
— (String
)Element of the SAML assertion to use for the user name. Default is
NameID
.RolesKey
— (String
)Element of the SAML assertion to use for backend roles. Default is
roles
.SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True to enable JWT authentication and authorization for a domain.
SubjectKey
— (String
)Element of the JWT assertion to use for the user name.
RolesKey
— (String
)Element of the JWT assertion to use for roles.
PublicKey
— (String
)Element of the JWT assertion used by the cluster to verify JWT signatures.
AnonymousAuthEnabled
— (Boolean
)True to enable a 30-day migration period during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
AutoTuneOptions
— (map
)Options for Auto-Tune.
DesiredState
— (String
)Whether Auto-Tune is enabled or disabled.
Possible values include:"ENABLED"
"DISABLED"
RollbackOnDisable
— (String
)When disabling Auto-Tune, specify
Possible values include:NO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specifyDEFAULT_ROLLBACK
, you must include aMaintenanceSchedule
in the request. Otherwise, OpenSearch Service is unable to perform the rollback."NO_ROLLBACK"
"DEFAULT_ROLLBACK"
MaintenanceSchedules
— (Array<map>
)DEPRECATED. Use off-peak window instead.
A list of maintenance schedules during which Auto-Tune can deploy changes.
StartAt
— (Date
)The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
Duration
— (map
)The duration of the maintenance schedule. For example,
"Duration": {"Value": 2, "Unit": "HOURS"}
.Value
— (Integer
)Integer to specify the value of a maintenance schedule duration.
Unit
— (String
)The unit of measurement for the duration of a maintenance schedule.
Possible values include:"HOURS"
CronExpressionForRecurrence
— (String
)A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
UseOffPeakWindow
— (Boolean
)Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
DryRun
— (Boolean
)This flag, when set to True, specifies whether the
UpdateDomain
request should return the results of a dry run analysis without actually applying the change. A dry run determines what type of deployment the update will cause.DryRunMode
— (String
)The type of dry run to perform.
-
Basic
only returns the type of deployment (blue/green or dynamic) that the update will cause. -
Verbose
runs an additional check to validate the changes you're making. For more information, see Validating a domain update.
"Basic"
"Verbose"
-
OffPeakWindowOptions
— (map
)Off-peak window options for the domain.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
SoftwareUpdateOptions
— (map
)Service software update options for the domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
AIMLOptions
— (map
)Options for all machine learning features for the specified domain.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
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. Thedata
object has the following properties:DomainConfig
— (map
)The status of the updated domain.
EngineVersion
— (map
)The OpenSearch or Elasticsearch version that the domain is running.
Options
— required — (String
)The OpenSearch or Elasticsearch version for the specified domain.
Status
— required — (map
)The status of the version options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
ClusterConfig
— (map
)Container for the cluster configuration of a the domain.
Options
— required — (map
)Cluster configuration options for the specified domain.
InstanceType
— (String
)Instance type of data nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
InstanceCount
— (Integer
)Number of data nodes in the cluster. This number must be greater than 1, otherwise you receive a validation exception.
DedicatedMasterEnabled
— (Boolean
)Indicates whether dedicated master nodes are enabled for the cluster.
True
if the cluster will use a dedicated master node.False
if the cluster will not.ZoneAwarenessEnabled
— (Boolean
)Indicates whether multiple Availability Zones are enabled. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
ZoneAwarenessConfig
— (map
)Container for zone awareness configuration options. Only required if
ZoneAwarenessEnabled
istrue
.AvailabilityZoneCount
— (Integer
)If you enabled multiple Availability Zones, this value is the number of zones that you want the domain to use. Valid values are
2
and3
. If your domain is provisioned within a VPC, this value be equal to number of subnets.
DedicatedMasterType
— (String
)OpenSearch Service instance type of the dedicated master nodes in the cluster.
Possible values include:"m3.medium.search"
"m3.large.search"
"m3.xlarge.search"
"m3.2xlarge.search"
"m4.large.search"
"m4.xlarge.search"
"m4.2xlarge.search"
"m4.4xlarge.search"
"m4.10xlarge.search"
"m5.large.search"
"m5.xlarge.search"
"m5.2xlarge.search"
"m5.4xlarge.search"
"m5.12xlarge.search"
"m5.24xlarge.search"
"r5.large.search"
"r5.xlarge.search"
"r5.2xlarge.search"
"r5.4xlarge.search"
"r5.12xlarge.search"
"r5.24xlarge.search"
"c5.large.search"
"c5.xlarge.search"
"c5.2xlarge.search"
"c5.4xlarge.search"
"c5.9xlarge.search"
"c5.18xlarge.search"
"t3.nano.search"
"t3.micro.search"
"t3.small.search"
"t3.medium.search"
"t3.large.search"
"t3.xlarge.search"
"t3.2xlarge.search"
"or1.medium.search"
"or1.large.search"
"or1.xlarge.search"
"or1.2xlarge.search"
"or1.4xlarge.search"
"or1.8xlarge.search"
"or1.12xlarge.search"
"or1.16xlarge.search"
"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
"t2.micro.search"
"t2.small.search"
"t2.medium.search"
"r3.large.search"
"r3.xlarge.search"
"r3.2xlarge.search"
"r3.4xlarge.search"
"r3.8xlarge.search"
"i2.xlarge.search"
"i2.2xlarge.search"
"d2.xlarge.search"
"d2.2xlarge.search"
"d2.4xlarge.search"
"d2.8xlarge.search"
"c4.large.search"
"c4.xlarge.search"
"c4.2xlarge.search"
"c4.4xlarge.search"
"c4.8xlarge.search"
"r4.large.search"
"r4.xlarge.search"
"r4.2xlarge.search"
"r4.4xlarge.search"
"r4.8xlarge.search"
"r4.16xlarge.search"
"i3.large.search"
"i3.xlarge.search"
"i3.2xlarge.search"
"i3.4xlarge.search"
"i3.8xlarge.search"
"i3.16xlarge.search"
"r6g.large.search"
"r6g.xlarge.search"
"r6g.2xlarge.search"
"r6g.4xlarge.search"
"r6g.8xlarge.search"
"r6g.12xlarge.search"
"m6g.large.search"
"m6g.xlarge.search"
"m6g.2xlarge.search"
"m6g.4xlarge.search"
"m6g.8xlarge.search"
"m6g.12xlarge.search"
"c6g.large.search"
"c6g.xlarge.search"
"c6g.2xlarge.search"
"c6g.4xlarge.search"
"c6g.8xlarge.search"
"c6g.12xlarge.search"
"r6gd.large.search"
"r6gd.xlarge.search"
"r6gd.2xlarge.search"
"r6gd.4xlarge.search"
"r6gd.8xlarge.search"
"r6gd.12xlarge.search"
"r6gd.16xlarge.search"
"t4g.small.search"
"t4g.medium.search"
DedicatedMasterCount
— (Integer
)Number of dedicated master nodes in the cluster. This number must be greater than 2 and not 4, otherwise you receive a validation exception.
WarmEnabled
— (Boolean
)Whether to enable warm storage for the cluster.
WarmType
— (String
)The instance type for the cluster's warm nodes.
Possible values include:"ultrawarm1.medium.search"
"ultrawarm1.large.search"
"ultrawarm1.xlarge.search"
WarmCount
— (Integer
)The number of warm nodes in the cluster.
ColdStorageOptions
— (map
)Container for cold storage configuration options.
Enabled
— required — (Boolean
)Whether to enable or disable cold storage on the domain. You must enable UltraWarm storage to enable cold storage.
MultiAZWithStandbyEnabled
— (Boolean
)A boolean that indicates whether a multi-AZ domain is turned on with a standby AZ. For more information, see Configuring a multi-AZ domain in Amazon OpenSearch Service.
Status
— required — (map
)The status of cluster configuration options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
EBSOptions
— (map
)Container for EBS options configured for the domain.
Options
— required — (map
)The configured EBS options for the specified domain.
EBSEnabled
— (Boolean
)Indicates whether EBS volumes are attached to data nodes in an OpenSearch Service domain.
VolumeType
— (String
)Specifies the type of EBS volumes attached to data nodes.
Possible values include:"standard"
"gp2"
"io1"
"gp3"
VolumeSize
— (Integer
)Specifies the size (in GiB) of EBS volumes attached to data nodes.
Iops
— (Integer
)Specifies the baseline input/output (I/O) performance of EBS volumes attached to data nodes. Applicable only for the
gp3
and provisioned IOPS EBS volume types.Throughput
— (Integer
)Specifies the throughput (in MiB/s) of the EBS volumes attached to data nodes. Applicable only for the
gp3
volume type.
Status
— required — (map
)The status of the EBS options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AccessPolicies
— (map
)Specifies the access policies for the domain.
Options
— required — (String
)The access policy configured for the domain. Access policies can be resource-based, IP-based, or IAM-based. For more information, see Configuring access policies.
Status
— required — (map
)The status of the access policy for the domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
IPAddressType
— (map
)Choose either dual stack or IPv4 as your IP address type. Dual stack allows you to share domain resources across IPv4 and IPv6 address types, and is the recommended option. If you set your IP address type to dual stack, you can't change your address type later.
Options
— required — (String
)The IP address options for the domain.
Possible values include:"ipv4"
"dualstack"
Status
— required — (map
)Provides the current status of an entity.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
SnapshotOptions
— (map
)DEPRECATED. Container for parameters required to configure automated snapshots of domain indexes.
Options
— required — (map
)The daily snapshot options specified for the domain.
AutomatedSnapshotStartHour
— (Integer
)The time, in UTC format, when OpenSearch Service takes a daily automated snapshot of the specified domain. Default is
0
hours.
Status
— required — (map
)The status of a daily automated snapshot.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
VPCOptions
— (map
)The current VPC options for the domain and the status of any updates to their configuration.
Options
— required — (map
)The VPC options for the specified domain.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
Status
— required — (map
)The status of the VPC options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
CognitoOptions
— (map
)Container for Amazon Cognito options for the domain.
Options
— required — (map
)Cognito options for the specified domain.
Enabled
— (Boolean
)Whether to enable or disable Amazon Cognito authentication for OpenSearch Dashboards.
UserPoolId
— (String
)The Amazon Cognito user pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
IdentityPoolId
— (String
)The Amazon Cognito identity pool ID that you want OpenSearch Service to use for OpenSearch Dashboards authentication.
RoleArn
— (String
)The
AmazonOpenSearchServiceCognitoAccess
role that allows OpenSearch Service to configure your user pool and identity pool.
Status
— required — (map
)The status of the Cognito options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
EncryptionAtRestOptions
— (map
)Key-value pairs to enable encryption at rest.
Options
— required — (map
)Encryption at rest options for the specified domain.
Enabled
— (Boolean
)True to enable encryption at rest.
KmsKeyId
— (String
)The KMS key ID. Takes the form
1a2a3a4-1a2a-3a4a-5a6a-1a2a3a4a5a6a
.
Status
— required — (map
)The status of the encryption at rest options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
NodeToNodeEncryptionOptions
— (map
)Whether node-to-node encryption is enabled or disabled.
Options
— required — (map
)The node-to-node encryption options for the specified domain.
Enabled
— (Boolean
)True to enable node-to-node encryption.
Status
— required — (map
)The status of the node-to-node encryption options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AdvancedOptions
— (map
)Key-value pairs to specify advanced configuration options. For more information, see Advanced options.
Options
— required — (map<String>
)The status of advanced options for the specified domain.
Status
— required — (map
)The status of advanced options for the specified domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
LogPublishingOptions
— (map
)Key-value pairs to configure log publishing.
Options
— (map<map>
)The log publishing options configured for the domain.
CloudWatchLogsLogGroupArn
— (String
)The Amazon Resource Name (ARN) of the CloudWatch Logs group to publish logs to.
Enabled
— (Boolean
)Whether the log should be published.
Status
— (map
)The status of the log publishing options for the domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
DomainEndpointOptions
— (map
)Additional options for the domain endpoint, such as whether to require HTTPS for all traffic.
Options
— required — (map
)Options to configure the endpoint for a domain.
EnforceHTTPS
— (Boolean
)True to require that all traffic to the domain arrive over HTTPS.
TLSSecurityPolicy
— (String
)Specify the TLS security policy to apply to the HTTPS endpoint of the domain. The policy 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
"Policy-Min-TLS-1-0-2019-07"
"Policy-Min-TLS-1-2-2019-07"
"Policy-Min-TLS-1-2-PFS-2023-10"
-
CustomEndpointEnabled
— (Boolean
)Whether to enable a custom endpoint for the domain.
CustomEndpoint
— (String
)The fully qualified URL for the custom endpoint.
CustomEndpointCertificateArn
— (String
)The ARN for your security certificate, managed in Amazon Web Services Certificate Manager (ACM).
Status
— required — (map
)The status of the endpoint options for a domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AdvancedSecurityOptions
— (map
)Container for fine-grained access control settings for the domain.
Options
— required — (map
)Container for fine-grained access control settings.
Enabled
— (Boolean
)True if fine-grained access control is enabled.
InternalUserDatabaseEnabled
— (Boolean
)True if the internal user database is enabled.
SAMLOptions
— (map
)Container for information about the SAML configuration for OpenSearch Dashboards.
Enabled
— (Boolean
)True if SAML is enabled.
Idp
— (map
)Describes the SAML identity provider's information.
MetadataContent
— required — (String
)The metadata of the SAML application, in XML format.
EntityId
— required — (String
)The unique entity ID of the application in the SAML identity provider.
SubjectKey
— (String
)The key used for matching the SAML subject attribute.
RolesKey
— (String
)The key used for matching the SAML roles attribute.
SessionTimeoutMinutes
— (Integer
)The duration, in minutes, after which a user session becomes inactive.
JWTOptions
— (map
)Container for information about the JWT configuration of the Amazon OpenSearch Service.
Enabled
— (Boolean
)True if JWT use is enabled.
SubjectKey
— (String
)The key used for matching the JWT subject attribute.
RolesKey
— (String
)The key used for matching the JWT roles attribute.
PublicKey
— (String
)The key used to verify the signature of incoming JWT requests.
AnonymousAuthDisableDate
— (Date
)Date and time when the migration period will be disabled. Only necessary when enabling fine-grained access control on an existing domain.
AnonymousAuthEnabled
— (Boolean
)True if a 30-day migration period is enabled, during which administrators can create role mappings. Only necessary when enabling fine-grained access control on an existing domain.
Status
— required — (map
)Status of the fine-grained access control settings for a domain.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
AutoTuneOptions
— (map
)Container for Auto-Tune settings for the domain.
Options
— (map
)Auto-Tune settings for updating a domain.
DesiredState
— (String
)Whether Auto-Tune is enabled or disabled.
Possible values include:"ENABLED"
"DISABLED"
RollbackOnDisable
— (String
)When disabling Auto-Tune, specify
Possible values include:NO_ROLLBACK
to retain all prior Auto-Tune settings orDEFAULT_ROLLBACK
to revert to the OpenSearch Service defaults. If you specifyDEFAULT_ROLLBACK
, you must include aMaintenanceSchedule
in the request. Otherwise, OpenSearch Service is unable to perform the rollback."NO_ROLLBACK"
"DEFAULT_ROLLBACK"
MaintenanceSchedules
— (Array<map>
)DEPRECATED. Use off-peak window instead.
A list of maintenance schedules during which Auto-Tune can deploy changes.
StartAt
— (Date
)The Epoch timestamp at which the Auto-Tune maintenance schedule starts.
Duration
— (map
)The duration of the maintenance schedule. For example,
"Duration": {"Value": 2, "Unit": "HOURS"}
.Value
— (Integer
)Integer to specify the value of a maintenance schedule duration.
Unit
— (String
)The unit of measurement for the duration of a maintenance schedule.
Possible values include:"HOURS"
CronExpressionForRecurrence
— (String
)A cron expression for a recurring maintenance schedule during which Auto-Tune can deploy changes.
UseOffPeakWindow
— (Boolean
)Whether to use the domain's off-peak window to deploy configuration changes on the domain rather than a maintenance schedule.
Status
— (map
)The current status of Auto-Tune for a domain.
CreationDate
— required — (Date
)Date and time when Auto-Tune was enabled for the domain.
UpdateDate
— required — (Date
)Date and time when the Auto-Tune options were last updated for the domain.
UpdateVersion
— (Integer
)The latest version of the Auto-Tune options.
State
— required — (String
)The current state of Auto-Tune on the domain.
Possible values include:"ENABLED"
"DISABLED"
"ENABLE_IN_PROGRESS"
"DISABLE_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_SCHEDULED"
"DISABLED_AND_ROLLBACK_IN_PROGRESS"
"DISABLED_AND_ROLLBACK_COMPLETE"
"DISABLED_AND_ROLLBACK_ERROR"
"ERROR"
ErrorMessage
— (String
)Any errors that occurred while enabling or disabling Auto-Tune.
PendingDeletion
— (Boolean
)Indicates whether the domain is being deleted.
ChangeProgressDetails
— (map
)Container for information about the progress of an existing configuration change.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
OffPeakWindowOptions
— (map
)Container for off-peak window options for the domain.
Options
— (map
)The domain's off-peak window configuration.
Enabled
— (Boolean
)Whether to enable an off-peak window.
This option is only available when modifying a domain created prior to February 16, 2023, not when creating a new domain. All domains created after this date have the off-peak window enabled by default. You can't disable the off-peak window after it's enabled for a domain.
OffPeakWindow
— (map
)Off-peak window settings for the domain.
WindowStartTime
— (map
)A custom start time for the off-peak window, in Coordinated Universal Time (UTC). The window length will always be 10 hours, so you can't specify an end time. For example, if you specify 11:00 P.M. UTC as a start time, the end time will automatically be set to 9:00 A.M.
Hours
— required — (Integer
)The start hour of the window in Coordinated Universal Time (UTC), using 24-hour time. For example,
17
refers to 5:00 P.M. UTC.Minutes
— required — (Integer
)The start minute of the window, in UTC.
Status
— (map
)The current status of off-peak window options.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
SoftwareUpdateOptions
— (map
)Software update options for the domain.
Options
— (map
)The service software update options for a domain.
AutoSoftwareUpdateEnabled
— (Boolean
)Whether automatic service software updates are enabled for the domain.
Status
— (map
)The status of service software update options, including creation date and last updated date.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
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"}
".
"PLAIN_TEXT"
"STRINGIFIED_JSON"
-
AIMLOptions
— (map
)Container for parameters required to enable all machine learning features.
Options
— (map
)Machine learning options on the specified domain.
NaturalLanguageQueryGenerationOptions
— (map
)Container for parameters required for natural language query generation on the specified domain.
DesiredState
— (String
)The desired state of the natural language query generation feature. Valid values are ENABLED and DISABLED.
Possible values include:"ENABLED"
"DISABLED"
CurrentState
— (String
)The current state of the natural language query generation feature, indicating completion, in progress, or failure.
Possible values include:"NOT_ENABLED"
"ENABLE_COMPLETE"
"ENABLE_IN_PROGRESS"
"ENABLE_FAILED"
"DISABLE_COMPLETE"
"DISABLE_IN_PROGRESS"
"DISABLE_FAILED"
Status
— (map
)Provides the current status of an entity.
CreationDate
— required — (Date
)The timestamp when the entity was created.
UpdateDate
— required — (Date
)The timestamp of the last time the entity was updated.
UpdateVersion
— (Integer
)The latest version of the entity.
State
— required — (String
)The state of the entity.
Possible values include:"RequiresIndexDocuments"
"Processing"
"Active"
PendingDeletion
— (Boolean
)Indicates whether the entity is being deleted.
DryRunResults
— (map
)Results of the dry run performed in the update domain request.
DeploymentType
— (String
)Specifies the way in which OpenSearch Service will apply an update. Possible values are:
-
Blue/Green - The update requires a blue/green deployment.
-
DynamicUpdate - No blue/green deployment required
-
Undetermined - The domain is in the middle of an update and can't predict the deployment type. Try again after the update is complete.
-
None - The request doesn't include any configuration changes.
-
Message
— (String
)A message corresponding to the deployment type.
DryRunProgressStatus
— (map
)The status of the dry run being performed on the domain, if any.
DryRunId
— required — (String
)The unique identifier of the dry run.
DryRunStatus
— required — (String
)The current status of the dry run.
CreationDate
— required — (String
)The timestamp when the dry run was initiated.
UpdateDate
— required — (String
)The timestamp when the dry run was last updated.
ValidationFailures
— (Array<map>
)Any validation failures that occurred as a result of the dry run.
Code
— (String
)The error code of the failure.
Message
— (String
)A message corresponding to the failure.
-
(AWS.Response)
—
Returns:
updatePackage(params = {}, callback) ⇒ AWS.Request
Updates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
Service Reference:
Examples:
Calling the updatePackage operation
var params = {
PackageID: 'STRING_VALUE', /* required */
PackageSource: { /* required */
S3BucketName: 'STRING_VALUE',
S3Key: 'STRING_VALUE'
},
CommitMessage: 'STRING_VALUE',
PackageDescription: 'STRING_VALUE'
};
opensearch.updatePackage(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
PackageID
— (String
)The unique identifier for the package.
PackageSource
— (map
)Amazon S3 bucket and key for the package.
S3BucketName
— (String
)The name of the Amazon S3 bucket containing the package.
S3Key
— (String
)Key (file name) of the package.
PackageDescription
— (String
)A new description of the package.
CommitMessage
— (String
)Commit message for the updated file, which is shown as part of
GetPackageVersionHistoryResponse
.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:PackageDetails
— (map
)Information about a package.
PackageID
— (String
)The unique identifier of the package.
PackageName
— (String
)The user-specified name of the package.
PackageType
— (String
)The type of package.
Possible values include:"TXT-DICTIONARY"
"ZIP-PLUGIN"
PackageDescription
— (String
)User-specified description of the package.
PackageStatus
— (String
)The current status of the package. The available options are
Possible values include:AVAILABLE
,COPYING
,COPY_FAILED
,VALIDATNG
,VALIDATION_FAILED
,DELETING
, andDELETE_FAILED
."COPYING"
"COPY_FAILED"
"VALIDATING"
"VALIDATION_FAILED"
"AVAILABLE"
"DELETING"
"DELETED"
"DELETE_FAILED"
CreatedAt
— (Date
)The timestamp when the package was created.
LastUpdatedAt
— (Date
)Date and time when the package was last updated.
AvailablePackageVersion
— (String
)The package version.
ErrorDetails
— (map
)Additional information if the package is in an error state. Null otherwise.
ErrorType
— (String
)The type of error that occurred.
ErrorMessage
— (String
)A message describing the error.
EngineVersion
— (String
)Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties
— (map
)If the package is a
ZIP-PLUGIN
package, additional information about plugin properties.Name
— (String
)The name of the plugin.
Description
— (String
)The description of the plugin.
Version
— (String
)The version of the plugin.
ClassName
— (String
)The name of the class to load.
UncompressedSizeInBytes
— (Integer
)The uncompressed size of the plugin.
-
(AWS.Response)
—
Returns:
updateScheduledAction(params = {}, callback) ⇒ AWS.Request
Reschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune enhancement.
Service Reference:
Examples:
Calling the updateScheduledAction operation
var params = {
ActionID: 'STRING_VALUE', /* required */
ActionType: SERVICE_SOFTWARE_UPDATE | JVM_HEAP_SIZE_TUNING | JVM_YOUNG_GEN_TUNING, /* required */
DomainName: 'STRING_VALUE', /* required */
ScheduleAt: NOW | TIMESTAMP | OFF_PEAK_WINDOW, /* required */
DesiredStartTime: 'NUMBER_VALUE'
};
opensearch.updateScheduledAction(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)The name of the domain to reschedule an action for.
ActionID
— (String
)The unique identifier of the action to reschedule. To retrieve this ID, send a ListScheduledActions request.
ActionType
— (String
)The type of action to reschedule. Can be one of
Possible values include:SERVICE_SOFTWARE_UPDATE
,JVM_HEAP_SIZE_TUNING
, orJVM_YOUNG_GEN_TUNING
. To retrieve this value, send a ListScheduledActions request."SERVICE_SOFTWARE_UPDATE"
"JVM_HEAP_SIZE_TUNING"
"JVM_YOUNG_GEN_TUNING"
ScheduleAt
— (String
)When to schedule the action.
-
NOW
- Immediately schedules the update to happen in the current hour if there's capacity available. -
TIMESTAMP
- Lets you specify a custom date and time to apply the update. If you specify this value, you must also provide a value forDesiredStartTime
. -
OFF_PEAK_WINDOW
- Marks the action to be picked up during an upcoming off-peak window. There's no guarantee that the change will be implemented during the next immediate window. Depending on capacity, it might happen in subsequent days.
"NOW"
"TIMESTAMP"
"OFF_PEAK_WINDOW"
-
DesiredStartTime
— (Integer
)The time to implement the change, in Coordinated Universal Time (UTC). Only specify this parameter if you set
ScheduleAt
toTIMESTAMP
.
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. Thedata
object has the following properties:ScheduledAction
— (map
)Information about the rescheduled action.
Id
— required — (String
)The unique identifier of the scheduled action.
Type
— required — (String
)The type of action that will be taken on the domain.
Possible values include:"SERVICE_SOFTWARE_UPDATE"
"JVM_HEAP_SIZE_TUNING"
"JVM_YOUNG_GEN_TUNING"
Severity
— required — (String
)The severity of the action.
Possible values include:"HIGH"
"MEDIUM"
"LOW"
ScheduledTime
— required — (Integer
)The time when the change is scheduled to happen.
Description
— (String
)A description of the action to be taken.
ScheduledBy
— (String
)Whether the action was scheduled manually (
Possible values include:CUSTOMER
, or by OpenSearch Service automatically (SYSTEM
)."CUSTOMER"
"SYSTEM"
Status
— (String
)The current status of the scheduled action.
Possible values include:"PENDING_UPDATE"
"IN_PROGRESS"
"FAILED"
"COMPLETED"
"NOT_ELIGIBLE"
"ELIGIBLE"
Mandatory
— (Boolean
)Whether the action is required or optional.
Cancellable
— (Boolean
)Whether or not the scheduled action is cancellable.
-
(AWS.Response)
—
Returns:
updateVpcEndpoint(params = {}, callback) ⇒ AWS.Request
Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
Service Reference:
Examples:
Calling the updateVpcEndpoint operation
var params = {
VpcEndpointId: 'STRING_VALUE', /* required */
VpcOptions: { /* required */
SecurityGroupIds: [
'STRING_VALUE',
/* more items */
],
SubnetIds: [
'STRING_VALUE',
/* more items */
]
}
};
opensearch.updateVpcEndpoint(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
VpcEndpointId
— (String
)The unique identifier of the endpoint.
VpcOptions
— (map
)The security groups and/or subnets to add, remove, or modify.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain. If your domain uses multiple Availability Zones, you need to provide two subnet IDs, one per zone. Otherwise, provide only one.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain. If you do not provide a security group ID, OpenSearch Service uses the default security group for the VPC.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:VpcEndpoint
— (map
)The endpoint to be updated.
VpcEndpointId
— (String
)The unique identifier of the endpoint.
VpcEndpointOwner
— (String
)The creator of the endpoint.
DomainArn
— (String
)The Amazon Resource Name (ARN) of the domain associated with the endpoint.
VpcOptions
— (map
)Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
VPCId
— (String
)The ID for your VPC. Amazon VPC generates this value when you create a VPC.
SubnetIds
— (Array<String>
)A list of subnet IDs associated with the VPC endpoints for the domain.
AvailabilityZones
— (Array<String>
)The list of Availability Zones associated with the VPC subnets.
SecurityGroupIds
— (Array<String>
)The list of security group IDs associated with the VPC endpoints for the domain.
Status
— (String
)The current status of the endpoint.
Possible values include:"CREATING"
"CREATE_FAILED"
"ACTIVE"
"UPDATING"
"UPDATE_FAILED"
"DELETING"
"DELETE_FAILED"
Endpoint
— (String
)The connection endpoint ID for connecting to the domain.
-
(AWS.Response)
—
Returns:
upgradeDomain(params = {}, callback) ⇒ AWS.Request
Allows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.
Service Reference:
Examples:
Calling the upgradeDomain operation
var params = {
DomainName: 'STRING_VALUE', /* required */
TargetVersion: 'STRING_VALUE', /* required */
AdvancedOptions: {
'<String>': 'STRING_VALUE',
/* '<String>': ... */
},
PerformCheckOnly: true || false
};
opensearch.upgradeDomain(params, function(err, data) {
if (err) console.log(err, err.stack); // an error occurred
else console.log(data); // successful response
});
Parameters:
-
params
(Object)
(defaults to: {})
—
DomainName
— (String
)Name of the OpenSearch Service domain that you want to upgrade.
TargetVersion
— (String
)OpenSearch or Elasticsearch version to which you want to upgrade, in the format Opensearch_X.Y or Elasticsearch_X.Y.
PerformCheckOnly
— (Boolean
)When true, indicates that an upgrade eligibility check needs to be performed. Does not actually perform the upgrade.
AdvancedOptions
— (map<String>
)Only supports the
override_main_response_version
parameter and not other advanced options. You can only include this option when upgrading to an OpenSearch version. Specifies whether the domain reports its version as 7.10 so that it continues to work with Elasticsearch OSS clients and plugins.
Callback (callback):
-
function(err, data) { ... }
Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.
Context (this):
-
(AWS.Response)
—
the response object containing error, data properties, and the original request object.
Parameters:
-
err
(Error)
—
the error object returned from the request. Set to
null
if the request is successful. -
data
(Object)
—
the de-serialized data returned from the request. Set to
null
if a request error occurs. Thedata
object has the following properties:UpgradeId
— (String
)The unique identifier of the domain upgrade.
DomainName
— (String
)The name of the domain that was upgraded.
TargetVersion
— (String
)OpenSearch or Elasticsearch version that the domain was upgraded to.
PerformCheckOnly
— (Boolean
)When true, indicates that an upgrade eligibility check was performed.
AdvancedOptions
— (map<String>
)The advanced options configuration for the domain.
ChangeProgressDetails
— (map
)Container for information about a configuration change happening on a domain.
ChangeId
— (String
)The ID of the configuration change.
Message
— (String
)A message corresponding to the status of the configuration change.
ConfigChangeStatus
— (String
)The current status of the configuration change.
Possible values include:"Pending"
"Initializing"
"Validating"
"ValidationFailed"
"ApplyingChanges"
"Completed"
"PendingUserInput"
"Cancelled"
InitiatedBy
— (String
)The IAM principal who initiated the configuration change.
Possible values include:"CUSTOMER"
"SERVICE"
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.
-
(AWS.Response)
—
Returns: