Amazon OpenSearch Service
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
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 .
Endpoints 103
- PUTAccept inbound connection
/2021-01-01/opensearch/cc/inboundConnection/:ConnectionId/acceptAllows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request. For more information, see… - GETList data sources
/2021-01-01/opensearch/domain/:DomainName/dataSourceLists direct-query data sources for a specific domain. For more information, see For more information, see Working with Amazon OpenSearch Service direct… - POSTAdd data source
/2021-01-01/opensearch/domain/:DomainName/dataSourceCreates a new direct-query data source to the specified domain. For more information, see Creating Amazon OpenSearch Service data source integrations with… - GETList direct query data sources
/2021-01-01/opensearch/directQueryDataSource?nexttoken=stringLists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service. - POSTAdd direct query data source
/2021-01-01/opensearch/directQueryDataSourceAdds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data. - POSTAdd replication peer
/2021-01-01/opensearch/domain/:DomainName/replication/addPeerStarts replicating a domain to a peer domain in another AWS Region. A domain can have one peer. The domain you call becomes the primary and the peer becomes… - GETList tags
/2021-01-01/tags?arn=stringReturns all resource tags for an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch Service… - POSTAdd tags
/2021-01-01/tagsAttaches tags to an existing Amazon OpenSearch Service domain, data source, or application. Tags are a set of case-sensitive key-value pairs. A domain, data… - POSTAssociate package
/2021-01-01/packages/associate/:PackageID/:DomainNameAssociates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service . - POSTAssociate packages
/2021-01-01/packages/associateMultipleOperation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously. - POSTAttach data source
/2021-01-01/opensearch/application/:id/attachDataSourceAttaches a data source to an OpenSearch application. The data source must be an Amazon OpenSearch Service domain. If both the application and the data source… - POSTAuthorize vpc endpoint access
/2021-01-01/opensearch/domain/:DomainName/authorizeVpcEndpointAccessProvides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint. - POSTCancel domain config change
/2021-01-01/opensearch/domain/:DomainName/config/cancelCancels a pending configuration change on an Amazon OpenSearch Service domain. - POSTCancel service software update
/2021-01-01/opensearch/serviceSoftwareUpdate/cancelCancels a scheduled service software update for an Amazon OpenSearch Service domain. You can only perform this operation before the AutomatedUpdateDate and… - POSTCompare domain configuration
/2021-01-01/opensearch/compareDomainConfigurationCompares the metadata of two domains and reports where they differ. Use this operation to check that a secondary domain is configured consistently with its… - POSTCreate application
/2021-01-01/opensearch/applicationCreates an OpenSearch UI application. For more information, see Using the OpenSearch user interface in Amazon OpenSearch Service . - POSTCreate domain
/2021-01-01/opensearch/domainCreates an Amazon OpenSearch Service domain. For more information, see Creating and managing Amazon OpenSearch Service domains . - POSTCreate index
/2021-01-01/opensearch/domain/:DomainName/indexCreates an OpenSearch index with optional automatic semantic enrichment for specified text fields. Automatic semantic enrichment enables semantic search… - POSTCreate outbound connection
/2021-01-01/opensearch/cc/outboundConnectionCreates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain. For more information, see Cross-cluster… - POSTCreate package
/2021-01-01/packagesCreates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service . - GETList vpc endpoints
/2021-01-01/opensearch/vpcEndpoints?nextToken=stringRetrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region. - POSTCreate vpc endpoint
/2021-01-01/opensearch/vpcEndpointsCreates an Amazon OpenSearch Service-managed VPC endpoint. - GETGet application
/2021-01-01/opensearch/application/:idRetrieves the configuration and status of an existing OpenSearch application. - PUTUpdate application
/2021-01-01/opensearch/application/:idUpdates the configuration and settings of an existing OpenSearch application. - DELETEDelete application
/2021-01-01/opensearch/application/:idDeletes a specified OpenSearch application. - GETGet data source
/2021-01-01/opensearch/domain/:DomainName/dataSource/:NameRetrieves information about a direct query data source. - PUTUpdate data source
/2021-01-01/opensearch/domain/:DomainName/dataSource/:NameUpdates a direct-query data source. For more information, see Working with Amazon OpenSearch Service data source integrations with Amazon S3 . - DELETEDelete data source
/2021-01-01/opensearch/domain/:DomainName/dataSource/:NameDeletes a direct-query data source. For more information, see Deleting an Amazon OpenSearch Service data source with Amazon S3 . - GETGet direct query data source
/2021-01-01/opensearch/directQueryDataSource/:DataSourceNameReturns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service. - PUTUpdate direct query data source
/2021-01-01/opensearch/directQueryDataSource/:DataSourceNameUpdates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service. - DELETEDelete direct query data source
/2021-01-01/opensearch/directQueryDataSource/:DataSourceNameDeletes a previously configured direct query data source from Amazon OpenSearch Service. - GETDescribe domain
/2021-01-01/opensearch/domain/:DomainNameDescribes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN. - DELETEDelete domain
/2021-01-01/opensearch/domain/:DomainNameDeletes an Amazon OpenSearch Service domain and all of its data. You can't recover a domain after you delete it. - DELETEDelete inbound connection
/2021-01-01/opensearch/cc/inboundConnection/:ConnectionIdAllows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection. For more information, see… - GETGet index
/2021-01-01/opensearch/domain/:DomainName/index/:IndexNameRetrieves information about an OpenSearch index including its schema and semantic enrichment configuration. Use this operation to view the current index… - PUTUpdate index
/2021-01-01/opensearch/domain/:DomainName/index/:IndexNameUpdates an existing OpenSearch index schema and semantic enrichment configuration. This operation allows modification of field mappings and semantic search… - DELETEDelete index
/2021-01-01/opensearch/domain/:DomainName/index/:IndexNameDeletes an OpenSearch index. This operation permanently removes the index and cannot be undone. - DELETEDelete outbound connection
/2021-01-01/opensearch/cc/outboundConnection/:ConnectionIdAllows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection. For more information, see… - DELETEDelete package
/2021-01-01/packages/:PackageIDDeletes an Amazon OpenSearch Service package. For more information, see Custom packages for Amazon OpenSearch Service . - DELETEDelete vpc endpoint
/2021-01-01/opensearch/vpcEndpoints/:VpcEndpointIdDeletes an Amazon OpenSearch Service-managed interface VPC endpoint. - DELETEDeregister capability
/2021-01-01/opensearch/application/:applicationId/capability/deregister/:capabilityNameDeregisters a capability from an OpenSearch UI application. This operation removes the capability and its associated configuration. - POSTDescribe data source attachment
/2021-01-01/opensearch/application/:id/describeDataSourceAttachmentReturns the current status and details of a specific data source attachment for an OpenSearch application. Throws a ResourceNotFoundException if no attachment… - GETDescribe domain auto tunes
/2021-01-01/opensearch/domain/:DomainName/autoTunes?maxResults=0&nextToken=stringReturns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain. For more information, see Auto-Tune for Amazon OpenSearch… - GETDescribe domain change progress
/2021-01-01/opensearch/domain/:DomainName/progress?changeid=stringReturns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain. For more information, see Making configuration… - GETDescribe domain config
/2021-01-01/opensearch/domain/:DomainName/configReturns the configuration of an Amazon OpenSearch Service domain. - POSTUpdate domain config
/2021-01-01/opensearch/domain/:DomainName/configModifies the cluster configuration of the specified Amazon OpenSearch Service domain. - GETDescribe domain health
/2021-01-01/opensearch/domain/:DomainName/healthReturns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node. - GETDescribe domain nodes
/2021-01-01/opensearch/domain/:DomainName/nodesReturns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and… - GETDescribe domain replication
/2021-01-01/opensearch/domain/:DomainName/replicationDescribes the replication arrangement that a domain participates in, including the domain's role and the state of its relationship with each peer. A domain… - POSTDescribe domains
/2021-01-01/opensearch/domain-infoReturns domain configuration information about the specified Amazon OpenSearch Service domains. - GETDescribe dry run progress
/2021-01-01/opensearch/domain/:DomainName/dryRun?dryRunId=string&loadDryRunConfig=trueDescribes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain. For more information, see Determining whether a change will… - POSTDescribe inbound connections
/2021-01-01/opensearch/cc/inboundConnection/searchLists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain. For more information, see Cross-cluster… - POSTDescribe insight details
/2021-01-01/opensearch/insight-detailsDescribes the details of an existing insight for an Amazon OpenSearch Service domain. Returns detailed fields associated with the specified insight, such as… - GETDescribe instance type limits
/2021-01-01/opensearch/instanceTypeLimits/:EngineVersion/:InstanceType?domainName=stringDescribes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type. - POSTDescribe outbound connections
/2021-01-01/opensearch/cc/outboundConnection/searchLists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain. For more information, see Cross-cluster search for… - POSTDescribe packages
/2021-01-01/packages/describeDescribes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service . - GETDescribe reserved instance offerings
/2021-01-01/opensearch/reservedInstanceOfferings?offeringId=string&maxResults=0&nextToken=stringDescribes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region. For more information, see Reserved Instances in Amazon… - GETDescribe reserved instances
/2021-01-01/opensearch/reservedInstances?reservationId=string&maxResults=0&nextToken=stringDescribes the Amazon OpenSearch Service instances that you have reserved in a given Region. For more information, see Reserved Instances in Amazon OpenSearch… - POSTDescribe vpc endpoints
/2021-01-01/opensearch/vpcEndpoints/describeDescribes one or more Amazon OpenSearch Service-managed VPC endpoints. - POSTDetach data source
/2021-01-01/opensearch/application/:id/detachDataSourceRemoves a data source from an OpenSearch application. The application must be in the ACTIVE state. This operation removes the data source saved object from… - POSTDissociate package
/2021-01-01/packages/dissociate/:PackageID/:DomainNameRemoves 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.… - POSTDissociate packages
/2021-01-01/packages/dissociateMultipleDissociates multiple packages from a domain simultaneously. - POSTFailover replication
/2021-01-01/opensearch/domain/:DomainName/replication/failoverPromotes a secondary domain to primary without coordinating with the current primary. Use this operation when the primary is unreachable and you cannot wait… - GETGet capability
/2021-01-01/opensearch/application/:applicationId/capability/:capabilityNameRetrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status. - GETGet compatible versions
/2021-01-01/opensearch/compatibleVersions?domainName=stringReturns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to. - GETGet default application setting
/2021-01-01/opensearch/defaultApplicationSettingGets the ARN of the current default application. If the default application isn't set, the operation returns a resource not found error. - PUTPut default application setting
/2021-01-01/opensearch/defaultApplicationSettingSets the default application to the application with the specified ARN. To remove the default application, use the GetDefaultApplicationSetting operation to… - GETGet domain maintenance status
/2021-01-01/opensearch/domain/:DomainName/domainMaintenance?maintenanceId=stringThe status of the maintenance action. - POSTStart domain maintenance
/2021-01-01/opensearch/domain/:DomainName/domainMaintenanceStarts the node maintenance process on the data node. These processes can include a node reboot, an Opensearch or Elasticsearch process restart, or a… - GETGet migration
/2021-01-01/opensearch/app-migrations/:migrationIdRetrieves the current status and progress of a migration job, including the number of exported and imported objects and error details if the migration failed. - GETGet package version history
/2021-01-01/packages/:PackageID/history?maxResults=0&nextToken=stringReturns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip… - GETGet upgrade history
/2021-01-01/opensearch/upgradeDomain/:DomainName/history?maxResults=0&nextToken=stringRetrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain. - GETGet upgrade status
/2021-01-01/opensearch/upgradeDomain/:DomainName/statusReturns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain. - POSTInsight feedback
/2021-01-01/opensearch/insight-feedbackSubmits feedback for an existing insight in an Amazon OpenSearch Service domain. Allows users to provide a thumbs up or thumbs down rating and optional text… - GETList applications
/2021-01-01/opensearch/list-applications?nextToken=string&statuses=&maxResults=0Lists all OpenSearch applications under your account. - POSTList data source attachments
/2021-01-01/opensearch/application/:id/listDataSourceAttachmentsReturns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states ( PENDING , ATTACHED , and FAILED ). - GETList domain maintenances
/2021-01-01/opensearch/domain/:DomainName/domainMaintenances?action=string&status=string&maxResults=0&nextToken=stringA list of maintenance actions for the domain. - GETList domain names
/2021-01-01/domain?engineType=stringReturns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region. - GETList domains for package
/2021-01-01/packages/:PackageID/domains?maxResults=0&nextToken=stringLists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service . - POSTList insights
/2021-01-01/opensearch/insightsLists insights for an Amazon OpenSearch Service domain or Amazon Web Services account. Returns a paginated list of insights based on the specified entity,… - GETList instance type details
/2021-01-01/opensearch/instanceTypeDetails/:EngineVersion?domainName=string&maxResults=0&nextToken=string&retrieveAZs=true&instanceType=stringLists all instance types and available features for a given OpenSearch or Elasticsearch version. - GETList migrations
/2021-01-01/opensearch/app-migrations?applicationId=string&status=string&maxResults=0&nextToken=stringLists migration jobs for an Amazon OpenSearch Service application. You can filter results by migration status. Use pagination to ensure that the operation… - POSTStart migration
/2021-01-01/opensearch/app-migrationsInitiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace. Saved objects include dashboards,… - GETList packages for domain
/2021-01-01/domain/:DomainName/packages?maxResults=0&nextToken=stringLists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service . - GETList scheduled actions
/2021-01-01/opensearch/domain/:DomainName/scheduledActions?maxResults=0&nextToken=stringRetrieves a list of configuration changes that are scheduled for a domain. These changes can be service software updates or blue/green Auto-Tune enhancements . - GETList versions
/2021-01-01/opensearch/versions?maxResults=0&nextToken=stringLists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports. - GETList vpc endpoint access
/2021-01-01/opensearch/domain/:DomainName/listVpcEndpointAccess?nextToken=stringRetrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an… - GETList vpc endpoints for domain
/2021-01-01/opensearch/domain/:DomainName/vpcEndpoints?nextToken=stringRetrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain. - POSTPurchase reserved instance offering
/2021-01-01/opensearch/purchaseReservedInstanceOfferingAllows you to purchase Amazon OpenSearch Service Reserved Instances. - POSTRegister capability
/2021-01-01/opensearch/application/:applicationId/capability/registerRegisters a capability for an OpenSearch UI application. Use this operation to enable specific capabilities, such as AI features, for a given application. The… - PUTReject inbound connection
/2021-01-01/opensearch/cc/inboundConnection/:ConnectionId/rejectAllows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request. - POSTRemove replication peer
/2021-01-01/opensearch/domain/:DomainName/replication/removePeerStops replicating a domain to its peer. Replication ends for both domains, and each domain keeps the data it holds at that point. Neither domain is deleted. - POSTRemove tags
/2021-01-01/tags-removalRemoves the specified set of tags from an Amazon OpenSearch Service domain, data source, or application. For more information, see Tagging Amazon OpenSearch… - POSTRevoke vpc endpoint access
/2021-01-01/opensearch/domain/:DomainName/revokeVpcEndpointAccessRevokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint. - POSTRollback service software update
/2021-01-01/opensearch/serviceSoftwareUpdate/rollbackRolls back a service software update for a domain to the previous version. For more information, see Service software updates in Amazon OpenSearch Service . - POSTStart service software update
/2021-01-01/opensearch/serviceSoftwareUpdate/startSchedules a service software update for an Amazon OpenSearch Service domain. For more information, see Service software updates in Amazon OpenSearch Service . - POSTSwitchover replication
/2021-01-01/opensearch/domain/:DomainName/replication/switchoverPromotes a secondary domain to primary, coordinating with the current primary so that no writes are lost. Use this operation for planned role changes, such as… - POSTUpdate clone
/2021-01-01/opensearch/domain/:DomainName/cloneManages a cloned blue/green upgrade that is in progress on a domain. Use it to shift a percentage of search traffic to the cloned cluster, to cut over to the… - POSTUpdate package
/2021-01-01/packages/updateUpdates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service . - POSTUpdate package scope
/2021-01-01/packages/updateScopeUpdates the scope of a package. Scope of the package defines users who can view and associate a package. - PUTUpdate scheduled action
/2021-01-01/opensearch/domain/:DomainName/scheduledAction/updateReschedules a planned domain configuration change for a later time. This change can be a scheduled service software update or a blue/green Auto-Tune… - POSTUpdate vpc endpoint
/2021-01-01/opensearch/vpcEndpoints/updateModifies an Amazon OpenSearch Service-managed interface VPC endpoint. - POSTUpgrade domain
/2021-01-01/opensearch/upgradeDomainAllows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or…
API details
- Base URL
https://es.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 103 operations on 86 pathsPOST 47GET 38DELETE 10PUT 8
- Description format
- AWS Smithy model, API version
2021-01-01 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon OpenSearch Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon OpenSearch Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Accept inbound connection” (PUT /2021-01-01/opensearch/cc/inboundConnection/:ConnectionId/accept), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon OpenSearch Service?
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. The endpoint for configuration service… It is listed under Developer tools and has 103 endpoints.
Who publishes the Amazon OpenSearch Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon OpenSearch Service?
Requests go to https://es.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon OpenSearch Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon OpenSearch Service have?
103 operations on 86 paths (47 POST, 38 GET, 10 DELETE, 8 PUT).
Is forking the Amazon OpenSearch Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.