OpenSearch

import { OpenSearch } from "https://aws-api.deno.dev/v0.3/services/opensearch.ts?docs=full";

class OpenSearch {

constructor(apiFactory: client.ApiFactory);

async acceptInboundConnection(params: AcceptInboundConnectionRequest, opts?: client.RequestOptions): Promise<AcceptInboundConnectionResponse>;

async addTags(params: AddTagsRequest, opts?: client.RequestOptions): Promise<void>;

async associatePackage(params: AssociatePackageRequest, opts?: client.RequestOptions): Promise<AssociatePackageResponse>;

async cancelServiceSoftwareUpdate(params: CancelServiceSoftwareUpdateRequest, opts?: client.RequestOptions): Promise<CancelServiceSoftwareUpdateResponse>;

async createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResponse>;

async createOutboundConnection(params: CreateOutboundConnectionRequest, opts?: client.RequestOptions): Promise<CreateOutboundConnectionResponse>;

async createPackage(params: CreatePackageRequest, opts?: client.RequestOptions): Promise<CreatePackageResponse>;

async deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<DeleteDomainResponse>;

async deleteInboundConnection(params: DeleteInboundConnectionRequest, opts?: client.RequestOptions): Promise<DeleteInboundConnectionResponse>;

async deleteOutboundConnection(params: DeleteOutboundConnectionRequest, opts?: client.RequestOptions): Promise<DeleteOutboundConnectionResponse>;

async deletePackage(params: DeletePackageRequest, opts?: client.RequestOptions): Promise<DeletePackageResponse>;

async describeDomain(params: DescribeDomainRequest, opts?: client.RequestOptions): Promise<DescribeDomainResponse>;

async describeDomainAutoTunes(params: DescribeDomainAutoTunesRequest, opts?: client.RequestOptions): Promise<DescribeDomainAutoTunesResponse>;

async describeDomainConfig(params: DescribeDomainConfigRequest, opts?: client.RequestOptions): Promise<DescribeDomainConfigResponse>;

async describeDomains(params: DescribeDomainsRequest, opts?: client.RequestOptions): Promise<DescribeDomainsResponse>;

async describeInboundConnections(params?: DescribeInboundConnectionsRequest, opts?: client.RequestOptions): Promise<DescribeInboundConnectionsResponse>;

async describeInstanceTypeLimits(params: DescribeInstanceTypeLimitsRequest, opts?: client.RequestOptions): Promise<DescribeInstanceTypeLimitsResponse>;

async describeOutboundConnections(params?: DescribeOutboundConnectionsRequest, opts?: client.RequestOptions): Promise<DescribeOutboundConnectionsResponse>;

async describePackages(params?: DescribePackagesRequest, opts?: client.RequestOptions): Promise<DescribePackagesResponse>;

async describeReservedInstanceOfferings(params?: DescribeReservedInstanceOfferingsRequest, opts?: client.RequestOptions): Promise<DescribeReservedInstanceOfferingsResponse>;

async describeReservedInstances(params?: DescribeReservedInstancesRequest, opts?: client.RequestOptions): Promise<DescribeReservedInstancesResponse>;

async dissociatePackage(params: DissociatePackageRequest, opts?: client.RequestOptions): Promise<DissociatePackageResponse>;

async getCompatibleVersions(params?: GetCompatibleVersionsRequest, opts?: client.RequestOptions): Promise<GetCompatibleVersionsResponse>;

async getPackageVersionHistory(params: GetPackageVersionHistoryRequest, opts?: client.RequestOptions): Promise<GetPackageVersionHistoryResponse>;

async getUpgradeHistory(params: GetUpgradeHistoryRequest, opts?: client.RequestOptions): Promise<GetUpgradeHistoryResponse>;

async getUpgradeStatus(params: GetUpgradeStatusRequest, opts?: client.RequestOptions): Promise<GetUpgradeStatusResponse>;

async listDomainNames(params?: ListDomainNamesRequest, opts?: client.RequestOptions): Promise<ListDomainNamesResponse>;

async listDomainsForPackage(params: ListDomainsForPackageRequest, opts?: client.RequestOptions): Promise<ListDomainsForPackageResponse>;

async listInstanceTypeDetails(params: ListInstanceTypeDetailsRequest, opts?: client.RequestOptions): Promise<ListInstanceTypeDetailsResponse>;

async listPackagesForDomain(params: ListPackagesForDomainRequest, opts?: client.RequestOptions): Promise<ListPackagesForDomainResponse>;

async listTags(params: ListTagsRequest, opts?: client.RequestOptions): Promise<ListTagsResponse>;

async listVersions(params?: ListVersionsRequest, opts?: client.RequestOptions): Promise<ListVersionsResponse>;

async purchaseReservedInstanceOffering(params: PurchaseReservedInstanceOfferingRequest, opts?: client.RequestOptions): Promise<PurchaseReservedInstanceOfferingResponse>;

async rejectInboundConnection(params: RejectInboundConnectionRequest, opts?: client.RequestOptions): Promise<RejectInboundConnectionResponse>;

async removeTags(params: RemoveTagsRequest, opts?: client.RequestOptions): Promise<void>;

async startServiceSoftwareUpdate(params: StartServiceSoftwareUpdateRequest, opts?: client.RequestOptions): Promise<StartServiceSoftwareUpdateResponse>;

async updateDomainConfig(params: UpdateDomainConfigRequest, opts?: client.RequestOptions): Promise<UpdateDomainConfigResponse>;

async updatePackage(params: UpdatePackageRequest, opts?: client.RequestOptions): Promise<UpdatePackageResponse>;

async upgradeDomain(params: UpgradeDomainRequest, opts?: client.RequestOptions): Promise<UpgradeDomainResponse>;

static ApiMetadata: client.ApiMetadata;

}

§Constructors

new OpenSearch(apiFactory: client.ApiFactory)

[src]

§Methods

acceptInboundConnection(params: AcceptInboundConnectionRequest, opts?: client.RequestOptions): Promise<AcceptInboundConnectionResponse>

[src]

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

addTags(params: AddTagsRequest, opts?: client.RequestOptions): Promise<void>

[src]

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

associatePackage(params: AssociatePackageRequest, opts?: client.RequestOptions): Promise<AssociatePackageResponse>

[src]

Associates a package with an Amazon OpenSearch Service domain.

cancelServiceSoftwareUpdate(params: CancelServiceSoftwareUpdateRequest, opts?: client.RequestOptions): Promise<CancelServiceSoftwareUpdateResponse>

[src]

Cancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

createDomain(params: CreateDomainRequest, opts?: client.RequestOptions): Promise<CreateDomainResponse>

[src]

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

createOutboundConnection(params: CreateOutboundConnectionRequest, opts?: client.RequestOptions): Promise<CreateOutboundConnectionResponse>

[src]

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

createPackage(params: CreatePackageRequest, opts?: client.RequestOptions): Promise<CreatePackageResponse>

[src]

Create a package for use with Amazon OpenSearch Service domains.

deleteDomain(params: DeleteDomainRequest, opts?: client.RequestOptions): Promise<DeleteDomainResponse>

[src]

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

deleteInboundConnection(params: DeleteInboundConnectionRequest, opts?: client.RequestOptions): Promise<DeleteInboundConnectionResponse>

[src]

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

deleteOutboundConnection(params: DeleteOutboundConnectionRequest, opts?: client.RequestOptions): Promise<DeleteOutboundConnectionResponse>

[src]

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

deletePackage(params: DeletePackageRequest, opts?: client.RequestOptions): Promise<DeletePackageResponse>

[src]

Deletes the package.

describeDomain(params: DescribeDomainRequest, opts?: client.RequestOptions): Promise<DescribeDomainResponse>

[src]

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

describeDomainAutoTunes(params: DescribeDomainAutoTunesRequest, opts?: client.RequestOptions): Promise<DescribeDomainAutoTunesResponse>

[src]

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

describeDomainConfig(params: DescribeDomainConfigRequest, opts?: client.RequestOptions): Promise<DescribeDomainConfigResponse>

[src]

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

describeDomains(params: DescribeDomainsRequest, opts?: client.RequestOptions): Promise<DescribeDomainsResponse>

[src]

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

describeInboundConnections(params?: DescribeInboundConnectionsRequest, opts?: client.RequestOptions): Promise<DescribeInboundConnectionsResponse>

[src]

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

describeInstanceTypeLimits(params: DescribeInstanceTypeLimitsRequest, opts?: client.RequestOptions): Promise<DescribeInstanceTypeLimitsResponse>

[src]

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

describeOutboundConnections(params?: DescribeOutboundConnectionsRequest, opts?: client.RequestOptions): Promise<DescribeOutboundConnectionsResponse>

[src]

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

describePackages(params?: DescribePackagesRequest, opts?: client.RequestOptions): Promise<DescribePackagesResponse>

[src]

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

describeReservedInstanceOfferings(params?: DescribeReservedInstanceOfferingsRequest, opts?: client.RequestOptions): Promise<DescribeReservedInstanceOfferingsResponse>

[src]

Lists available reserved OpenSearch instance offerings.

describeReservedInstances(params?: DescribeReservedInstancesRequest, opts?: client.RequestOptions): Promise<DescribeReservedInstancesResponse>

[src]

Returns information about reserved OpenSearch instances for this account.

dissociatePackage(params: DissociatePackageRequest, opts?: client.RequestOptions): Promise<DissociatePackageResponse>

[src]

Dissociates a package from the Amazon OpenSearch Service domain.

getCompatibleVersions(params?: GetCompatibleVersionsRequest, opts?: client.RequestOptions): Promise<GetCompatibleVersionsResponse>

[src]

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

getPackageVersionHistory(params: GetPackageVersionHistoryRequest, opts?: client.RequestOptions): Promise<GetPackageVersionHistoryResponse>

[src]

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

getUpgradeHistory(params: GetUpgradeHistoryRequest, opts?: client.RequestOptions): Promise<GetUpgradeHistoryResponse>

[src]

Retrieves the complete history of the last 10 upgrades performed on the domain.

getUpgradeStatus(params: GetUpgradeStatusRequest, opts?: client.RequestOptions): Promise<GetUpgradeStatusResponse>

[src]

Retrieves the latest status of the last upgrade or upgrade eligibility check performed on the domain.

listDomainNames(params?: ListDomainNamesRequest, opts?: client.RequestOptions): Promise<ListDomainNamesResponse>

[src]

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

listDomainsForPackage(params: ListDomainsForPackageRequest, opts?: client.RequestOptions): Promise<ListDomainsForPackageResponse>

[src]

Lists all Amazon OpenSearch Service domains associated with the package.

listInstanceTypeDetails(params: ListInstanceTypeDetailsRequest, opts?: client.RequestOptions): Promise<ListInstanceTypeDetailsResponse>

[src]

listPackagesForDomain(params: ListPackagesForDomainRequest, opts?: client.RequestOptions): Promise<ListPackagesForDomainResponse>

[src]

Lists all packages associated with the Amazon OpenSearch Service domain.

listVersions(params?: ListVersionsRequest, opts?: client.RequestOptions): Promise<ListVersionsResponse>

[src]

List all supported versions of OpenSearch and Elasticsearch.

purchaseReservedInstanceOffering(params: PurchaseReservedInstanceOfferingRequest, opts?: client.RequestOptions): Promise<PurchaseReservedInstanceOfferingResponse>

[src]

Allows you to purchase reserved OpenSearch instances.

rejectInboundConnection(params: RejectInboundConnectionRequest, opts?: client.RequestOptions): Promise<RejectInboundConnectionResponse>

[src]

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

removeTags(params: RemoveTagsRequest, opts?: client.RequestOptions): Promise<void>

[src]

Removes the specified set of tags from the given domain.

startServiceSoftwareUpdate(params: StartServiceSoftwareUpdateRequest, opts?: client.RequestOptions): Promise<StartServiceSoftwareUpdateResponse>

[src]

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

updateDomainConfig(params: UpdateDomainConfigRequest, opts?: client.RequestOptions): Promise<UpdateDomainConfigResponse>

[src]

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

updatePackage(params: UpdatePackageRequest, opts?: client.RequestOptions): Promise<UpdatePackageResponse>

[src]

Updates a package for use with Amazon OpenSearch Service domains.

upgradeDomain(params: UpgradeDomainRequest, opts?: client.RequestOptions): Promise<UpgradeDomainResponse>

[src]

Allows you to either upgrade your domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.

§Static Properties

ApiMetadata: client.ApiMetadata

[src]