OpenSearchClientProtocol

Amazon OpenSearch Configuration Service Use the Amazon OpenSearch configuration API to create, configure, and manage Amazon OpenSearch Service domains. For sample code that uses the configuration API, see the Amazon OpenSearch Service Developer Guide. The guide also contains sample code for sending signed HTTP requests to the OpenSearch APIs. The endpoint for configuration service requests is region-specific: es.region.amazonaws.com. For example, es.us-east-1.amazonaws.com. For a current list of supported regions and endpoints, see Regions and Endpoints.

public protocol OpenSearchClientProtocol 

Requirements

acceptInboundConnection(input:completion:)

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

func acceptInboundConnection(input: AcceptInboundConnectionInput, completion: @escaping (ClientRuntime.SdkResult<AcceptInboundConnectionOutputResponse, AcceptInboundConnectionOutputError>) -> Void)

addTags(input:completion:)

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.

func addTags(input: AddTagsInput, completion: @escaping (ClientRuntime.SdkResult<AddTagsOutputResponse, AddTagsOutputError>) -> Void)

associatePackage(input:completion:)

Associates a package with an Amazon OpenSearch Service domain.

func associatePackage(input: AssociatePackageInput, completion: @escaping (ClientRuntime.SdkResult<AssociatePackageOutputResponse, AssociatePackageOutputError>) -> Void)

cancelServiceSoftwareUpdate(input:completion:)

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.

func cancelServiceSoftwareUpdate(input: CancelServiceSoftwareUpdateInput, completion: @escaping (ClientRuntime.SdkResult<CancelServiceSoftwareUpdateOutputResponse, CancelServiceSoftwareUpdateOutputError>) -> Void)

createDomain(input:completion:)

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.

func createDomain(input: CreateDomainInput, completion: @escaping (ClientRuntime.SdkResult<CreateDomainOutputResponse, CreateDomainOutputError>) -> Void)

createOutboundConnection(input:completion:)

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

func createOutboundConnection(input: CreateOutboundConnectionInput, completion: @escaping (ClientRuntime.SdkResult<CreateOutboundConnectionOutputResponse, CreateOutboundConnectionOutputError>) -> Void)

createPackage(input:completion:)

Create a package for use with Amazon OpenSearch Service domains.

func createPackage(input: CreatePackageInput, completion: @escaping (ClientRuntime.SdkResult<CreatePackageOutputResponse, CreatePackageOutputError>) -> Void)

deleteDomain(input:completion:)

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

func deleteDomain(input: DeleteDomainInput, completion: @escaping (ClientRuntime.SdkResult<DeleteDomainOutputResponse, DeleteDomainOutputError>) -> Void)

deleteInboundConnection(input:completion:)

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

func deleteInboundConnection(input: DeleteInboundConnectionInput, completion: @escaping (ClientRuntime.SdkResult<DeleteInboundConnectionOutputResponse, DeleteInboundConnectionOutputError>) -> Void)

deleteOutboundConnection(input:completion:)

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

func deleteOutboundConnection(input: DeleteOutboundConnectionInput, completion: @escaping (ClientRuntime.SdkResult<DeleteOutboundConnectionOutputResponse, DeleteOutboundConnectionOutputError>) -> Void)

deletePackage(input:completion:)

Deletes the package.

func deletePackage(input: DeletePackageInput, completion: @escaping (ClientRuntime.SdkResult<DeletePackageOutputResponse, DeletePackageOutputError>) -> Void)

describeDomain(input:completion:)

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

func describeDomain(input: DescribeDomainInput, completion: @escaping (ClientRuntime.SdkResult<DescribeDomainOutputResponse, DescribeDomainOutputError>) -> Void)

describeDomainAutoTunes(input:completion:)

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

func describeDomainAutoTunes(input: DescribeDomainAutoTunesInput, completion: @escaping (ClientRuntime.SdkResult<DescribeDomainAutoTunesOutputResponse, DescribeDomainAutoTunesOutputError>) -> Void)

describeDomainConfig(input:completion:)

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

func describeDomainConfig(input: DescribeDomainConfigInput, completion: @escaping (ClientRuntime.SdkResult<DescribeDomainConfigOutputResponse, DescribeDomainConfigOutputError>) -> Void)

describeDomains(input:completion:)

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

func describeDomains(input: DescribeDomainsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeDomainsOutputResponse, DescribeDomainsOutputError>) -> Void)

describeInboundConnections(input:completion:)

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

func describeInboundConnections(input: DescribeInboundConnectionsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeInboundConnectionsOutputResponse, DescribeInboundConnectionsOutputError>) -> Void)

describeInstanceTypeLimits(input:completion:)

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.

func describeInstanceTypeLimits(input: DescribeInstanceTypeLimitsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeInstanceTypeLimitsOutputResponse, DescribeInstanceTypeLimitsOutputError>) -> Void)

describeOutboundConnections(input:completion:)

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

func describeOutboundConnections(input: DescribeOutboundConnectionsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeOutboundConnectionsOutputResponse, DescribeOutboundConnectionsOutputError>) -> Void)

describePackages(input:completion:)

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

func describePackages(input: DescribePackagesInput, completion: @escaping (ClientRuntime.SdkResult<DescribePackagesOutputResponse, DescribePackagesOutputError>) -> Void)

describeReservedInstanceOfferings(input:completion:)

Lists available reserved OpenSearch instance offerings.

func describeReservedInstanceOfferings(input: DescribeReservedInstanceOfferingsInput, completion: @escaping (ClientRuntime.SdkResult<DescribeReservedInstanceOfferingsOutputResponse, DescribeReservedInstanceOfferingsOutputError>) -> Void)

describeReservedInstances(input:completion:)

Returns information about reserved OpenSearch instances for this account.

func describeReservedInstances(input: DescribeReservedInstancesInput, completion: @escaping (ClientRuntime.SdkResult<DescribeReservedInstancesOutputResponse, DescribeReservedInstancesOutputError>) -> Void)

dissociatePackage(input:completion:)

Dissociates a package from the Amazon OpenSearch Service domain.

func dissociatePackage(input: DissociatePackageInput, completion: @escaping (ClientRuntime.SdkResult<DissociatePackageOutputResponse, DissociatePackageOutputError>) -> Void)

getCompatibleVersions(input:completion:)

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.

func getCompatibleVersions(input: GetCompatibleVersionsInput, completion: @escaping (ClientRuntime.SdkResult<GetCompatibleVersionsOutputResponse, GetCompatibleVersionsOutputError>) -> Void)

getPackageVersionHistory(input:completion:)

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

func getPackageVersionHistory(input: GetPackageVersionHistoryInput, completion: @escaping (ClientRuntime.SdkResult<GetPackageVersionHistoryOutputResponse, GetPackageVersionHistoryOutputError>) -> Void)

getUpgradeHistory(input:completion:)

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

func getUpgradeHistory(input: GetUpgradeHistoryInput, completion: @escaping (ClientRuntime.SdkResult<GetUpgradeHistoryOutputResponse, GetUpgradeHistoryOutputError>) -> Void)

getUpgradeStatus(input:completion:)

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

func getUpgradeStatus(input: GetUpgradeStatusInput, completion: @escaping (ClientRuntime.SdkResult<GetUpgradeStatusOutputResponse, GetUpgradeStatusOutputError>) -> Void)

listDomainNames(input:completion:)

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

func listDomainNames(input: ListDomainNamesInput, completion: @escaping (ClientRuntime.SdkResult<ListDomainNamesOutputResponse, ListDomainNamesOutputError>) -> Void)

listDomainsForPackage(input:completion:)

Lists all Amazon OpenSearch Service domains associated with the package.

func listDomainsForPackage(input: ListDomainsForPackageInput, completion: @escaping (ClientRuntime.SdkResult<ListDomainsForPackageOutputResponse, ListDomainsForPackageOutputError>) -> Void)

listInstanceTypeDetails(input:completion:)

func listInstanceTypeDetails(input: ListInstanceTypeDetailsInput, completion: @escaping (ClientRuntime.SdkResult<ListInstanceTypeDetailsOutputResponse, ListInstanceTypeDetailsOutputError>) -> Void)

listPackagesForDomain(input:completion:)

Lists all packages associated with the Amazon OpenSearch Service domain.

func listPackagesForDomain(input: ListPackagesForDomainInput, completion: @escaping (ClientRuntime.SdkResult<ListPackagesForDomainOutputResponse, ListPackagesForDomainOutputError>) -> Void)

listTags(input:completion:)

Returns all tags for the given domain.

func listTags(input: ListTagsInput, completion: @escaping (ClientRuntime.SdkResult<ListTagsOutputResponse, ListTagsOutputError>) -> Void)

listVersions(input:completion:)

List all supported versions of OpenSearch and Elasticsearch.

func listVersions(input: ListVersionsInput, completion: @escaping (ClientRuntime.SdkResult<ListVersionsOutputResponse, ListVersionsOutputError>) -> Void)

purchaseReservedInstanceOffering(input:completion:)

Allows you to purchase reserved OpenSearch instances.

func purchaseReservedInstanceOffering(input: PurchaseReservedInstanceOfferingInput, completion: @escaping (ClientRuntime.SdkResult<PurchaseReservedInstanceOfferingOutputResponse, PurchaseReservedInstanceOfferingOutputError>) -> Void)

rejectInboundConnection(input:completion:)

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

func rejectInboundConnection(input: RejectInboundConnectionInput, completion: @escaping (ClientRuntime.SdkResult<RejectInboundConnectionOutputResponse, RejectInboundConnectionOutputError>) -> Void)

removeTags(input:completion:)

Removes the specified set of tags from the given domain.

func removeTags(input: RemoveTagsInput, completion: @escaping (ClientRuntime.SdkResult<RemoveTagsOutputResponse, RemoveTagsOutputError>) -> Void)

startServiceSoftwareUpdate(input:completion:)

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

func startServiceSoftwareUpdate(input: StartServiceSoftwareUpdateInput, completion: @escaping (ClientRuntime.SdkResult<StartServiceSoftwareUpdateOutputResponse, StartServiceSoftwareUpdateOutputError>) -> Void)

updateDomainConfig(input:completion:)

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

func updateDomainConfig(input: UpdateDomainConfigInput, completion: @escaping (ClientRuntime.SdkResult<UpdateDomainConfigOutputResponse, UpdateDomainConfigOutputError>) -> Void)

updatePackage(input:completion:)

Updates a package for use with Amazon OpenSearch Service domains.

func updatePackage(input: UpdatePackageInput, completion: @escaping (ClientRuntime.SdkResult<UpdatePackageOutputResponse, UpdatePackageOutputError>) -> Void)

upgradeDomain(input:completion:)

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

func upgradeDomain(input: UpgradeDomainInput, completion: @escaping (ClientRuntime.SdkResult<UpgradeDomainOutputResponse, UpgradeDomainOutputError>) -> Void)