aws-api.deno.dev/v0.3/services/es.ts?docs=full

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/es.ts?docs=full";

§Classes

§Interfaces

AcceptInboundCrossClusterSearchConnectionRequest	Container for the parameters to the `"AcceptInboundCrossClusterSearchConnection"` operation.
AcceptInboundCrossClusterSearchConnectionResponse	The result of a `"AcceptInboundCrossClusterSearchConnection"` operation. Contains details of 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 it's `"InstanceRole"` .
AddTagsRequest	Container for the parameters to the `"AddTags"` operation. Specify the tags that you want to attach to the Elasticsearch domain.
AdvancedOptionsStatus	Status of the advanced options for the specified Elasticsearch domain. Currently, the following advanced options are available:
AdvancedSecurityOptions	Specifies the advanced security configuration: whether advanced security is enabled, whether the internal database option is enabled.
AdvancedSecurityOptionsInput	Specifies 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	Specifies the status of advanced security options for the specified Elasticsearch domain.
AssociatePackageRequest	Container for request parameters to `"AssociatePackage"` operation.
AssociatePackageResponse	Container for response returned by `"AssociatePackage"` operation.
AutoTune	Specifies Auto-Tune type and Auto-Tune action details.
AutoTuneDetails	Specifies details of the Auto-Tune action. See the Developer Guide for more information.
AutoTuneMaintenanceSchedule	Specifies Auto-Tune maitenance schedule. See the Developer Guide for more information.
AutoTuneOptions	Specifies 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	Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
AutoTuneOptionsOutput	Specifies the Auto-Tune options: the Auto-Tune desired state for the domain and list of maintenance schedules.
AutoTuneOptionsStatus	Specifies the status of Auto-Tune options for the specified Elasticsearch domain.
AutoTuneStatus	Provides the current status of the Auto-Tune options.
CancelElasticsearchServiceSoftwareUpdateRequest	Container for the parameters to the `"CancelElasticsearchServiceSoftwareUpdate"` operation. Specifies the name of the Elasticsearch domain that you wish to cancel a service software update on.
CancelElasticsearchServiceSoftwareUpdateResponse	The result of a `CancelElasticsearchServiceSoftwareUpdate` operation. Contains the status of the update.
CognitoOptions	Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
CognitoOptionsStatus	Status of the Cognito options for the specified Elasticsearch domain.
ColdStorageOptions	Specifies the configuration for cold storage options such as enabled
CompatibleVersionsMap	A map from an `"ElasticsearchVersion"` to a list of compatible `"ElasticsearchVersion"` s to which the domain can be upgraded.
CreateElasticsearchDomainRequest
CreateElasticsearchDomainResponse	The result of a `CreateElasticsearchDomain` operation. Contains the status of the newly created Elasticsearch domain.
CreateOutboundCrossClusterSearchConnectionRequest	Container for the parameters to the `"CreateOutboundCrossClusterSearchConnection"` operation.
CreateOutboundCrossClusterSearchConnectionResponse	The result of a `"CreateOutboundCrossClusterSearchConnection"` request. Contains the details of the newly created cross-cluster search connection.
CreatePackageRequest	Container for request parameters to `"CreatePackage"` operation.
CreatePackageResponse	Container for response returned by `"CreatePackage"` operation.
DeleteElasticsearchDomainRequest	Container for the parameters to the `"DeleteElasticsearchDomain"` operation. Specifies the name of the Elasticsearch domain that you want to delete.
DeleteElasticsearchDomainResponse	The result of a `DeleteElasticsearchDomain` request. Contains the status of the pending deletion, or no status if the domain and all of its resources have been deleted.
DeleteInboundCrossClusterSearchConnectionRequest	Container for the parameters to the `"DeleteInboundCrossClusterSearchConnection"` operation.
DeleteInboundCrossClusterSearchConnectionResponse	The result of a `"DeleteInboundCrossClusterSearchConnection"` operation. Contains details of deleted inbound connection.
DeleteOutboundCrossClusterSearchConnectionRequest	Container for the parameters to the `"DeleteOutboundCrossClusterSearchConnection"` operation.
DeleteOutboundCrossClusterSearchConnectionResponse	The result of a `"DeleteOutboundCrossClusterSearchConnection"` operation. Contains details of deleted outbound connection.
DeletePackageRequest	Container for request parameters to `"DeletePackage"` operation.
DeletePackageResponse	Container for response parameters to `"DeletePackage"` operation.
DescribeDomainAutoTunesRequest	Container for the parameters to the `DescribeDomainAutoTunes` operation.
DescribeDomainAutoTunesResponse	The result of `DescribeDomainAutoTunes` request. See the Developer Guide for more information.
DescribeElasticsearchDomainConfigRequest	Container for the parameters to the `DescribeElasticsearchDomainConfig` operation. Specifies the domain name for which you want configuration information.
DescribeElasticsearchDomainConfigResponse	The result of a `DescribeElasticsearchDomainConfig` request. Contains the configuration information of the requested domain.
DescribeElasticsearchDomainRequest	Container for the parameters to the `"DescribeElasticsearchDomain"` operation.
DescribeElasticsearchDomainResponse	The result of a `DescribeElasticsearchDomain` request. Contains the status of the domain specified in the request.
DescribeElasticsearchDomainsRequest	Container for the parameters to the `"DescribeElasticsearchDomains"` operation. By default, the API returns the status of all Elasticsearch domains.
DescribeElasticsearchDomainsResponse	The result of a `DescribeElasticsearchDomains` request. Contains the status of the specified domains or all domains owned by the account.
DescribeElasticsearchInstanceTypeLimitsRequest	Container for the parameters to `"DescribeElasticsearchInstanceTypeLimits"` operation.
DescribeElasticsearchInstanceTypeLimitsResponse	Container for the parameters received from `"DescribeElasticsearchInstanceTypeLimits"` operation.
DescribeInboundCrossClusterSearchConnectionsRequest	Container for the parameters to the `"DescribeInboundCrossClusterSearchConnections"` operation.
DescribeInboundCrossClusterSearchConnectionsResponse	The result of a `"DescribeInboundCrossClusterSearchConnections"` request. Contains the list of connections matching the filter criteria.
DescribeOutboundCrossClusterSearchConnectionsRequest	Container for the parameters to the `"DescribeOutboundCrossClusterSearchConnections"` operation.
DescribeOutboundCrossClusterSearchConnectionsResponse	The result of a `"DescribeOutboundCrossClusterSearchConnections"` request. Contains the list of connections matching the filter criteria.
DescribePackagesFilter	Filter to apply in `DescribePackage` response.
DescribePackagesRequest	Container for request parameters to `"DescribePackage"` operation.
DescribePackagesResponse	Container for response returned by `"DescribePackages"` operation.
DescribeReservedElasticsearchInstanceOfferingsRequest	Container for parameters to `DescribeReservedElasticsearchInstanceOfferings`
DescribeReservedElasticsearchInstanceOfferingsResponse	Container for results from `DescribeReservedElasticsearchInstanceOfferings`
DescribeReservedElasticsearchInstancesRequest	Container for parameters to `DescribeReservedElasticsearchInstances`
DescribeReservedElasticsearchInstancesResponse	Container for results from `DescribeReservedElasticsearchInstances`
DissociatePackageRequest	Container for request parameters to `"DissociatePackage"` operation.
DissociatePackageResponse	Container for response returned by `"DissociatePackage"` operation.
DomainEndpointOptions	Options to configure endpoint for the Elasticsearch domain.
DomainEndpointOptionsStatus	The configured endpoint options for the domain and their current status.
DomainInfo
DomainInformation
DomainPackageDetails	Information on a package that is associated with a domain.
DryRunResults
Duration	Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
EBSOptions	Options to enable, disable, and specify the properties of EBS storage volumes. For more information, see Configuring EBS-based Storage.
EBSOptionsStatus	Status of the EBS options for the specified Elasticsearch domain.
ElasticsearchClusterConfig	Specifies the configuration for the domain cluster, such as the type and number of instances.
ElasticsearchClusterConfigStatus	Specifies the configuration status for the specified Elasticsearch domain.
ElasticsearchDomainConfig	The configuration of an Elasticsearch domain.
ElasticsearchDomainStatus	The current status of an Elasticsearch domain.
ElasticsearchVersionStatus	Status of the Elasticsearch version options for the specified Elasticsearch domain.
EncryptionAtRestOptions	Specifies the Encryption At Rest Options.
EncryptionAtRestOptionsStatus	Status of the Encryption At Rest options for the specified Elasticsearch domain.
ErrorDetails
Filter	A filter used to limit results when describing inbound or outbound cross-cluster search connections. Multiple values can be specified per filter. A cross-cluster search connection must match at least one of the specified values for it to be returned from an operation.
GetCompatibleElasticsearchVersionsRequest	Container for request parameters to `"GetCompatibleElasticsearchVersions"` operation.
GetCompatibleElasticsearchVersionsResponse	Container for response returned by `"GetCompatibleElasticsearchVersions"` operation.
GetPackageVersionHistoryRequest	Container for request parameters to `"GetPackageVersionHistory"` operation.
GetPackageVersionHistoryResponse	Container for response returned by `"GetPackageVersionHistory"` operation.
GetUpgradeHistoryRequest	Container for request parameters to `"GetUpgradeHistory"` operation.
GetUpgradeHistoryResponse	Container for response returned by `"GetUpgradeHistory"` operation.
GetUpgradeStatusRequest	Container for request parameters to `"GetUpgradeStatus"` operation.
GetUpgradeStatusResponse	Container for response returned by `"GetUpgradeStatus"` operation.
InboundCrossClusterSearchConnection	Specifies details of an inbound connection.
InboundCrossClusterSearchConnectionStatus	Specifies the coonection status of an inbound cross-cluster search connection.
InstanceCountLimits	InstanceCountLimits represents the limits on number of instances that be created in Amazon Elasticsearch for given InstanceType.
InstanceLimits	InstanceLimits represents the list of instance related attributes that are available for given InstanceType.
Limits	Limits for given InstanceType and for each of it's role.
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 request parameters to `"ListDomainsForPackage"` operation.
ListDomainsForPackageResponse	Container for response parameters to `"ListDomainsForPackage"` operation.
ListElasticsearchInstanceTypesRequest	Container for the parameters to the `"ListElasticsearchInstanceTypes"` operation.
ListElasticsearchInstanceTypesResponse	Container for the parameters returned by `"ListElasticsearchInstanceTypes"` operation.
ListElasticsearchVersionsRequest	Container for the parameters to the `"ListElasticsearchVersions"` operation.
ListElasticsearchVersionsResponse	Container for the parameters for response received from `"ListElasticsearchVersions"` operation.
ListPackagesForDomainRequest	Container for request parameters to `"ListPackagesForDomain"` operation.
ListPackagesForDomainResponse	Container for response parameters to `"ListPackagesForDomain"` operation.
ListTagsRequest	Container for the parameters to the `"ListTags"` operation. Specify the `ARN` for the Elasticsearch domain to which the tags are attached that you want to view are attached.
ListTagsResponse	The result of a `ListTags` operation. Contains tags for all requested Elasticsearch domains.
LogPublishingOption	Log Publishing option that is set for 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	Specifies the node-to-node encryption options.
NodeToNodeEncryptionOptionsStatus	Status of the node-to-node encryption options for the specified Elasticsearch domain.
OptionStatus	Provides the current status of the entity.
OutboundCrossClusterSearchConnection	Specifies details of an outbound connection.
OutboundCrossClusterSearchConnectionStatus	Specifies the connection status of an outbound cross-cluster search connection.
PackageDetails	Basic information about a package.
PackageSource	The S3 location for importing the package specified as `S3BucketName` and `S3Key`
PackageVersionHistory	Details of a package version.
PurchaseReservedElasticsearchInstanceOfferingRequest	Container for parameters to `PurchaseReservedElasticsearchInstanceOffering`
PurchaseReservedElasticsearchInstanceOfferingResponse	Represents the output of a `PurchaseReservedElasticsearchInstanceOffering` operation.
RecurringCharge	Contains the specific price and frequency of a recurring charges for a reserved Elasticsearch instance, or for a reserved Elasticsearch instance offering.
RejectInboundCrossClusterSearchConnectionRequest	Container for the parameters to the `"RejectInboundCrossClusterSearchConnection"` operation.
RejectInboundCrossClusterSearchConnectionResponse	The result of a `"RejectInboundCrossClusterSearchConnection"` operation. Contains details of rejected inbound connection.
RemoveTagsRequest	Container for the parameters to the `"RemoveTags"` operation. Specify the `ARN` for the Elasticsearch domain from which you want to remove the specified `TagKey`.
ReservedElasticsearchInstance	Details of a reserved Elasticsearch instance.
ReservedElasticsearchInstanceOffering	Details of a reserved Elasticsearch instance offering.
SAMLIdp	Specifies the SAML Identity Provider's information.
SAMLOptionsInput	Specifies the SAML application configuration for the domain.
SAMLOptionsOutput	Describes the SAML application configured for the domain.
ScheduledAutoTuneDetails	Specifies details of the scheduled Auto-Tune action. See the Developer Guide for more information.
ServiceSoftwareOptions	The current options of an Elasticsearch domain service software options.
SnapshotOptions	Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is `0` hours.
SnapshotOptionsStatus	Status of a daily automated snapshot.
StartElasticsearchServiceSoftwareUpdateRequest	Container for the parameters to the `"StartElasticsearchServiceSoftwareUpdate"` operation. Specifies the name of the Elasticsearch domain that you wish to schedule a service software update on.
StartElasticsearchServiceSoftwareUpdateResponse	The result of a `StartElasticsearchServiceSoftwareUpdate` operation. Contains the status of the update.
StorageType	StorageTypes represents the list of storage related types and their attributes that are available for given InstanceType.
StorageTypeLimit	Limits that are applicable for given storage type.
Tag	Specifies a key value pair for a resource tag.
UpdateElasticsearchDomainConfigRequest	Container for the parameters to the `"UpdateElasticsearchDomain"` operation. Specifies the type and number of instances in the domain cluster.
UpdateElasticsearchDomainConfigResponse	The result of an `UpdateElasticsearchDomain` request. Contains the status of the Elasticsearch domain being updated.
UpdatePackageRequest	Container for request parameters to `"UpdatePackage"` operation.
UpdatePackageResponse	Container for response returned by `"UpdatePackage"` operation.
UpgradeElasticsearchDomainRequest	Container for request parameters to `"UpgradeElasticsearchDomain"` operation.
UpgradeElasticsearchDomainResponse	Container for response returned by `"UpgradeElasticsearchDomain"` 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.
VPCDerivedInfo	Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
VPCDerivedInfoStatus	Status of the VPC options for the specified Elasticsearch domain.
VPCOptions	Options to specify the subnets and security groups for VPC endpoint. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
ZoneAwarenessConfig	Specifies the zone awareness configuration for the domain cluster, such as the number of availability zones.

§Type Aliases

AutoTuneDesiredState	Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
AutoTuneState	Specifies the Auto-Tune state for the Elasticsearch domain. For valid states see the Developer Guide.
AutoTuneType	Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
DeploymentStatus
DescribePackagesFilterName
DomainPackageStatus
EngineType
ESPartitionInstanceType
ESWarmPartitionInstanceType
InboundCrossClusterSearchConnectionStatusCode
LogType	Type of Log File, it 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: Elasticsearch 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.
OptionState	The state of a requested change. One of the following:
OutboundCrossClusterSearchConnectionStatusCode
PackageStatus
PackageType
ReservedElasticsearchInstancePaymentOption
RollbackOnDisable	Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
ScheduledAutoTuneActionType	Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
ScheduledAutoTuneSeverityType	Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
TimeUnit	Specifies the unit of a maintenance schedule duration. Valid value is HOUR. See the Developer Guide for more information.
TLSSecurityPolicy
UpgradeStatus
UpgradeStep
VolumeType	The type of EBS volume, standard, gp2, or io1. See Configuring EBS-based Storagefor more information.