Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://aws-api.deno.dev/v0.3/services/opensearch.ts?docs=full";

§Classes

OpenSearch

§Interfaces

AcceptInboundConnectionRequest

Container for the parameters to the "AcceptInboundConnection" operation.

AcceptInboundConnectionResponse

The result of an "AcceptInboundConnection" operation. Contains details about the accepted inbound connection.

AccessPoliciesStatus

The configured access rules for the domain's document and search endpoints, and the current status of those rules.

AdditionalLimit

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

AddTagsRequest

Container for the parameters to the "AddTags" operation. Specifies the tags to attach to the domain.

AdvancedOptionsStatus

Status of the advanced options for the specified domain. Currently, the following advanced options are available:

AdvancedSecurityOptions

The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.

AdvancedSecurityOptionsInput

The advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled, master username and password (if internal database is enabled), and master user ARN (if IAM is enabled).

AdvancedSecurityOptionsStatus

The status of advanced security options for the specified domain.

AssociatePackageRequest

Container for the request parameters to the "AssociatePackage" operation.

AssociatePackageResponse

Container for the response returned by "AssociatePackage" operation.

AutoTune

Specifies the Auto-Tune type and Auto-Tune action details.

AutoTuneDetails

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

AutoTuneMaintenanceSchedule

Specifies the Auto-Tune maintenance schedule. See Auto-Tune for Amazon OpenSearch Service for more information.

AutoTuneOptions

The Auto-Tune options: the Auto-Tune desired state for the domain, rollback state when disabling Auto-Tune options and list of maintenance schedules.

AutoTuneOptionsInput

The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

AutoTuneOptionsOutput

The Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.

AutoTuneOptionsStatus

The Auto-Tune status for the domain.

AutoTuneStatus

Provides the current Auto-Tune status for the domain.

AWSDomainInformation
CancelServiceSoftwareUpdateRequest

Container for the parameters to the "CancelServiceSoftwareUpdate" operation. Specifies the name of the domain that you wish to cancel a service software update on.

CancelServiceSoftwareUpdateResponse

The result of a CancelServiceSoftwareUpdate operation. Contains the status of the update.

ClusterConfig

The configuration for the domain cluster, such as the type and number of instances.

ClusterConfigStatus

The configuration status for the specified domain.

CognitoOptions

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

CognitoOptionsStatus

The status of the Cognito options for the specified domain.

ColdStorageOptions

Specifies the configuration for cold storage options such as enabled

CompatibleVersionsMap

A map from an "EngineVersion" to a list of compatible "EngineVersion" s to which the domain can be upgraded.

CreateDomainRequest
CreateDomainResponse

The result of a CreateDomain operation. Contains the status of the newly created Amazon OpenSearch Service domain.

CreateOutboundConnectionRequest

Container for the parameters to the "CreateOutboundConnection" operation.

CreateOutboundConnectionResponse

The result of a "CreateOutboundConnection" request. Contains the details about the newly created cross-cluster connection.

CreatePackageRequest

Container for request parameters to the "CreatePackage" operation.

CreatePackageResponse

Container for the response returned by the "CreatePackage" operation.

DeleteDomainRequest

Container for the parameters to the "DeleteDomain" operation. Specifies the name of the domain you want to delete.

DeleteDomainResponse

The result of a DeleteDomain request. Contains the status of the pending deletion, or a "domain not found" error if the domain and all of its resources have been deleted.

DeleteInboundConnectionRequest

Container for the parameters to the "DeleteInboundConnection" operation.

DeleteInboundConnectionResponse

The result of a "DeleteInboundConnection" operation. Contains details about the deleted inbound connection.

DeleteOutboundConnectionRequest

Container for the parameters to the "DeleteOutboundConnection" operation.

DeleteOutboundConnectionResponse

The result of a "DeleteOutboundConnection" operation. Contains details about the deleted outbound connection.

DeletePackageRequest

Container for the request parameters to the "DeletePackage" operation.

DeletePackageResponse

Container for the response parameters to the "DeletePackage" operation.

DescribeDomainAutoTunesRequest

Container for the parameters to the DescribeDomainAutoTunes operation.

DescribeDomainAutoTunesResponse

The result of a DescribeDomainAutoTunes request. See Auto-Tune for Amazon OpenSearch Service for more information.

DescribeDomainConfigRequest

Container for the parameters to the DescribeDomainConfig operation. Specifies the domain name for which you want configuration information.

DescribeDomainConfigResponse

The result of a DescribeDomainConfig request. Contains the configuration information of the requested domain.

DescribeDomainRequest

Container for the parameters to the "DescribeDomain" operation.

DescribeDomainResponse

The result of a DescribeDomain request. Contains the status of the domain specified in the request.

DescribeDomainsRequest

Container for the parameters to the "DescribeDomains" operation. By default, the API returns the status of all domains.

DescribeDomainsResponse

The result of a DescribeDomains request. Contains the status of the specified domains or all domains owned by the account.

DescribeInboundConnectionsRequest

Container for the parameters to the "DescribeInboundConnections" operation.

DescribeInboundConnectionsResponse

The result of a "DescribeInboundConnections" request. Contains a list of connections matching the filter criteria.

DescribeInstanceTypeLimitsRequest

Container for the parameters to the "DescribeInstanceTypeLimits" operation.

DescribeInstanceTypeLimitsResponse

Container for the parameters received from the "DescribeInstanceTypeLimits" operation.

DescribeOutboundConnectionsRequest

Container for the parameters to the "DescribeOutboundConnections" operation.

DescribeOutboundConnectionsResponse

The result of a "DescribeOutboundConnections" request. Contains the list of connections matching the filter criteria.

DescribePackagesFilter

A filter to apply to the DescribePackage response.

DescribePackagesRequest

Container for the request parameters to the "DescribePackage" operation.

DescribePackagesResponse

Container for the response returned by the "DescribePackages" operation.

DescribeReservedInstanceOfferingsRequest

Container for parameters to DescribeReservedInstanceOfferings

DescribeReservedInstanceOfferingsResponse

Container for results from DescribeReservedInstanceOfferings

DescribeReservedInstancesRequest

Container for parameters to DescribeReservedInstances

DescribeReservedInstancesResponse

Container for results from DescribeReservedInstances

DissociatePackageRequest

Container for the request parameters to the "DissociatePackage" operation.

DissociatePackageResponse

Container for the response returned by "DissociatePackage" operation.

DomainConfig

The configuration of a domain.

DomainEndpointOptions

Options to configure the endpoint for the domain.

DomainEndpointOptionsStatus

The configured endpoint options for the domain and their current status.

DomainInfo
DomainInformationContainer
DomainPackageDetails

Information on a package associated with a domain.

DomainStatus

The current status of a domain.

DryRunResults
Duration

The maintenance schedule duration: duration value and duration unit. See Auto-Tune for Amazon OpenSearch Service for more information.

EBSOptions

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

EBSOptionsStatus

Status of the EBS options for the specified domain.

EncryptionAtRestOptions

Specifies encryption at rest options.

EncryptionAtRestOptionsStatus

Status of the encryption At Rest options for the specified domain.

ErrorDetails
Filter

A filter used to limit results when describing inbound or outbound cross-cluster connections. Multiple values can be specified per filter. A cross-cluster connection must match at least one of the specified values for it to be returned from an operation.

GetCompatibleVersionsRequest

Container for the request parameters to "GetCompatibleVersions" operation.

GetCompatibleVersionsResponse

Container for the response returned by the "GetCompatibleVersions" operation.

GetPackageVersionHistoryRequest

Container for the request parameters to the "GetPackageVersionHistory" operation.

GetPackageVersionHistoryResponse

Container for response returned by "GetPackageVersionHistory" operation.

GetUpgradeHistoryRequest

Container for the request parameters to the "GetUpgradeHistory" operation.

GetUpgradeHistoryResponse

Container for the response returned by the "GetUpgradeHistory" operation.

GetUpgradeStatusRequest

Container for the request parameters to the "GetUpgradeStatus" operation.

GetUpgradeStatusResponse

Container for the response returned by the "GetUpgradeStatus" operation.

InboundConnection

Details of an inbound connection.

InboundConnectionStatus

The connection status of an inbound cross-cluster connection.

InstanceCountLimits

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

InstanceLimits

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

InstanceTypeDetails
Limits

Limits for a given InstanceType and for each of its roles.

ListDomainNamesRequest

Container for the parameters to the "ListDomainNames" operation.

ListDomainNamesResponse

The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.

ListDomainsForPackageRequest

Container for the request parameters to the "ListDomainsForPackage" operation.

ListDomainsForPackageResponse

Container for the response parameters to the "ListDomainsForPackage" operation.

ListInstanceTypeDetailsRequest
ListInstanceTypeDetailsResponse
ListPackagesForDomainRequest

Container for the request parameters to the "ListPackagesForDomain" operation.

ListPackagesForDomainResponse

Container for the response parameters to the "ListPackagesForDomain" operation.

ListTagsRequest

Container for the parameters to the "ListTags" operation. Specify the ARN of the domain that the tags you want to view are attached to.

ListTagsResponse

The result of a ListTags operation. Contains tags for all requested domains.

ListVersionsRequest

Container for the parameters to the "ListVersions" operation.

ListVersionsResponse

Container for the parameters for response received from the "ListVersions" operation.

LogPublishingOption

Log Publishing option that is set for a given domain.

LogPublishingOptionsStatus

The configured log publishing options for the domain and their current status.

MasterUserOptions

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

NodeToNodeEncryptionOptions

The node-to-node encryption options.

NodeToNodeEncryptionOptionsStatus

Status of the node-to-node encryption options for the specified domain.

OptionStatus

Provides the current status of the entity.

OutboundConnection

Specifies details about an outbound connection.

OutboundConnectionStatus

The connection status of an outbound cross-cluster connection.

PackageDetails

Basic information about a package.

PackageSource

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

PackageVersionHistory

Details of a package version.

PurchaseReservedInstanceOfferingRequest

Container for parameters to PurchaseReservedInstanceOffering

PurchaseReservedInstanceOfferingResponse

Represents the output of a PurchaseReservedInstanceOffering operation.

RecurringCharge

Contains the specific price and frequency of a recurring charges for a reserved OpenSearch instance, or for a reserved OpenSearch instance offering.

RejectInboundConnectionRequest

Container for the parameters to the "RejectInboundConnection" operation.

RejectInboundConnectionResponse

The result of a "RejectInboundConnection" operation. Contains details about the rejected inbound connection.

RemoveTagsRequest

Container for the parameters to the "RemoveTags" operation. Specify the ARN for the domain from which you want to remove the specified TagKey.

ReservedInstance

Details of a reserved OpenSearch instance.

ReservedInstanceOffering

Details of a reserved OpenSearch instance offering.

SAMLIdp

The SAML identity povider's information.

SAMLOptionsInput

The SAML application configuration for the domain.

SAMLOptionsOutput

Describes the SAML application configured for the domain.

ScheduledAutoTuneDetails

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

ServiceSoftwareOptions

The current options of an domain service software options.

SnapshotOptions

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

SnapshotOptionsStatus

Status of a daily automated snapshot.

StartServiceSoftwareUpdateRequest

Container for the parameters to the "StartServiceSoftwareUpdate" operation. Specifies the name of the domain to schedule a service software update for.

StartServiceSoftwareUpdateResponse

The result of a StartServiceSoftwareUpdate operation. Contains the status of the update.

StorageType

StorageTypes represents the list of storage-related types and their attributes that are available for a given InstanceType.

StorageTypeLimit

Limits that are applicable for the given storage type.

Tag

A key value pair for a resource tag.

UpdateDomainConfigRequest

Container for the parameters to the "UpdateDomain" operation. Specifies the type and number of instances in the domain cluster.

UpdateDomainConfigResponse

The result of an UpdateDomain request. Contains the status of the domain being updated.

UpdatePackageRequest

Container for request parameters to the "UpdatePackage" operation.

UpdatePackageResponse

Container for the response returned by the "UpdatePackage" operation.

UpgradeDomainRequest

Container for the request parameters to "UpgradeDomain" operation.

UpgradeDomainResponse

Container for response returned by "UpgradeDomain" operation.

UpgradeHistory

History of the last 10 upgrades and upgrade eligibility checks.

UpgradeStepItem

Represents a single step of the upgrade or upgrade eligibility check workflow.

VersionStatus

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

VPCDerivedInfo

Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

VPCDerivedInfoStatus

Status of the VPC options for the specified domain.

VPCOptions

Options to specify the subnets and security groups for the VPC endpoint. For more information, see Launching your Amazon OpenSearch Service domains using a VPC.

ZoneAwarenessConfig

The zone awareness configuration for the domain cluster, such as the number of availability zones.

§Type Aliases

AutoTuneDesiredState

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

AutoTuneState

The Auto-Tune state for the domain. For valid states see Auto-Tune for Amazon OpenSearch Service.

AutoTuneType

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

DeploymentStatus
DescribePackagesFilterName
DomainPackageStatus
EngineType
InboundConnectionStatusCode
LogType

Type of log file. Can be one of the following:

  • INDEX_SLOW_LOGS: Index slow logs contain insert requests that took more time than configured index query log threshold to execute.
  • SEARCH_SLOW_LOGS: Search slow logs contain search queries that took more time than configured search query log threshold to execute.
  • ES_APPLICATION_LOGS: OpenSearch application logs contain information about errors and warnings raised during the operation of the service and can be useful for troubleshooting.
  • AUDIT_LOGS: Audit logs contain records of user requests for access from the domain.
OpenSearchPartitionInstanceType
OpenSearchWarmPartitionInstanceType
OptionState

The state of a requested change. One of the following:

OutboundConnectionStatusCode
PackageStatus
PackageType
ReservedInstancePaymentOption
RollbackOnDisable

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

ScheduledAutoTuneActionType

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

ScheduledAutoTuneSeverityType

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

TimeUnit

The unit of a maintenance schedule duration. Valid value is HOUR. See Auto-Tune for Amazon OpenSearch Service for more information.

TLSSecurityPolicy
UpgradeStatus
UpgradeStep
VolumeType

The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storage for more information.