aws opensearch
Use the Amazon OpenSearch Service configuration API to create, configure, and manage OpenSearch Service domains. AWS CLI reference
103 commands Its page in the AWS CLI reference
Commands
accept-inbound-connectionAllows the destination Amazon OpenSearch Service domain owner to accept an inbound cross-cluster search connection request.add-data-sourceCreates a new direct-query data source to the specified domain.add-direct-query-data-sourceAdds a new data source in Amazon OpenSearch Service so that you can perform direct queries on external data.add-replication-peerStarts replicating a domain to a peer domain in another AWS Region.add-tagsAttaches tags to an existing Amazon OpenSearch Service domain, data source, or application.associate-packageAssociates a package with an Amazon OpenSearch Service domain.associate-packagesOperation in the Amazon OpenSearch Service API for associating multiple packages with a domain simultaneously.attach-data-sourceAttaches a data source to an OpenSearch application.authorize-vpc-endpoint-accessProvides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.cancel-domain-config-changeCancels a pending configuration change on an Amazon OpenSearch Service domain.cancel-service-software-updateCancels a scheduled service software update for an Amazon OpenSearch Service domain.compare-domain-configurationCompares the metadata of two domains and reports where they differ.create-applicationCreates an OpenSearch UI application.create-domainCreates an Amazon OpenSearch Service domain.create-indexCreates an OpenSearch index with optional automatic semantic enrichment for specified text fields.create-outbound-connectionCreates a new cross-cluster search connection from a source Amazon OpenSearch Service domain to a destination domain.create-packageCreates a package for use with Amazon OpenSearch Service domains.create-vpc-endpointCreates an Amazon OpenSearch Service-managed VPC endpoint.delete-applicationDeletes a specified OpenSearch application.delete-data-sourceDeletes a direct-query data source.delete-direct-query-data-sourceDeletes a previously configured direct query data source from Amazon OpenSearch Service.delete-domainDeletes an Amazon OpenSearch Service domain and all of its data.delete-inbound-connectionAllows the destination Amazon OpenSearch Service domain owner to delete an existing inbound cross-cluster search connection.delete-indexDeletes an OpenSearch index.delete-outbound-connectionAllows the source Amazon OpenSearch Service domain owner to delete an existing outbound cross-cluster search connection.delete-packageDeletes an Amazon OpenSearch Service package.delete-vpc-endpointDeletes an Amazon OpenSearch Service-managed interface VPC endpoint.deregister-capabilityDeregisters a capability from an OpenSearch UI application.describe-data-source-attachmentReturns the current status and details of a specific data source attachment for an OpenSearch application.describe-domainDescribes the domain configuration for the specified Amazon OpenSearch Service domain, including the domain ID, domain service endpoint, and domain ARN.describe-domain-auto-tunesReturns the list of optimizations that Auto-Tune has made to an Amazon OpenSearch Service domain.describe-domain-change-progressReturns information about the current blue/green deployment happening on an Amazon OpenSearch Service domain.describe-domain-configReturns the configuration of an Amazon OpenSearch Service domain.describe-domain-healthReturns information about domain and node health, the standby Availability Zone, number of nodes per Availability Zone, and shard count per node.describe-domain-nodesReturns information about domain and nodes, including data nodes, master nodes, ultrawarm nodes, Availability Zone(s), standby nodes, node configurations, and node states.describe-domain-replicationDescribes the replication arrangement that a domain participates in, including the domain's role and the state of its relationship with each peer.describe-domainsReturns domain configuration information about the specified Amazon OpenSearch Service domains.describe-dry-run-progressDescribes the progress of a pre-update dry run analysis on an Amazon OpenSearch Service domain.describe-inbound-connectionsLists all the inbound cross-cluster search connections for a destination (remote) Amazon OpenSearch Service domain.describe-insight-detailsDescribes the details of an existing insight for an Amazon OpenSearch Service domain.describe-instance-type-limitsDescribes the instance count, storage, and master node limits for a given OpenSearch or Elasticsearch version and instance type.describe-outbound-connectionsLists all the outbound cross-cluster connections for a local (source) Amazon OpenSearch Service domain.describe-packagesDescribes all packages available to OpenSearch Service.describe-reserved-instance-offeringsDescribes the available Amazon OpenSearch Service Reserved Instance offerings for a given Region.describe-reserved-instancesDescribes the Amazon OpenSearch Service instances that you have reserved in a given Region.describe-vpc-endpointsDescribes one or more Amazon OpenSearch Service-managed VPC endpoints.detach-data-sourceRemoves a data source from an OpenSearch application.dissociate-packageRemoves a package from the specified Amazon OpenSearch Service domain.dissociate-packagesDissociates multiple packages from a domain simultaneously.failover-replicationPromotes a secondary domain to primary without coordinating with the current primary.get-applicationRetrieves the configuration and status of an existing OpenSearch application.get-capabilityRetrieves information about a registered capability for an OpenSearch UI application, including its configuration and current status.get-compatible-versionsReturns a map of OpenSearch or Elasticsearch versions and the versions you can upgrade them to.get-data-sourceRetrieves information about a direct query data source.get-default-application-settingGets the ARN of the current default application.get-direct-query-data-sourceReturns detailed configuration information for a specific direct query data source in Amazon OpenSearch Service.get-domain-maintenance-statusThe status of the maintenance action.get-indexRetrieves information about an OpenSearch index including its schema and semantic enrichment configuration.get-migrationRetrieves the current status and progress of a migration job, including the number of exported and imported objects and error details if the migration failed.get-package-version-historyReturns a list of Amazon OpenSearch Service package versions, along with their creation time, commit message, and plugin properties (if the package is a zip plugin package).get-upgrade-historyRetrieves the complete history of the last 10 upgrades performed on an Amazon OpenSearch Service domain.get-upgrade-statusReturns the most recent status of the last upgrade or upgrade eligibility check performed on an Amazon OpenSearch Service domain.insight-feedbackSubmits feedback for an existing insight in an Amazon OpenSearch Service domain.list-applicationsLists all OpenSearch applications under your account.list-data-source-attachmentsReturns a paginated list of all data source attachments for an OpenSearch application, including attachments in all states (PENDING, ATTACHED, and FAILED).list-data-sourcesLists direct-query data sources for a specific domain.list-direct-query-data-sourcesLists an inventory of all the direct query data sources that you have configured within Amazon OpenSearch Service.list-domain-maintenancesA list of maintenance actions for the domain.list-domain-namesReturns the names of all Amazon OpenSearch Service domains owned by the current user in the active Region.list-domains-for-packageLists all Amazon OpenSearch Service domains associated with a given package.list-insightsLists insights for an Amazon OpenSearch Service domain or Amazon Web Services account.list-instance-type-detailsLists all instance types and available features for a given OpenSearch or Elasticsearch version.list-migrationsLists migration jobs for an Amazon OpenSearch Service application.list-packages-for-domainLists all packages associated with an Amazon OpenSearch Service domain.list-scheduled-actionsRetrieves a list of configuration changes that are scheduled for a domain.list-tagsReturns all resource tags for an Amazon OpenSearch Service domain, data source, or application.list-versionsLists all versions of OpenSearch and Elasticsearch that Amazon OpenSearch Service supports.list-vpc-endpoint-accessRetrieves information about each Amazon Web Services principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.list-vpc-endpointsRetrieves all Amazon OpenSearch Service-managed VPC endpoints in the current Amazon Web Services account and Region.list-vpc-endpoints-for-domainRetrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.purchase-reserved-instance-offeringAllows you to purchase Amazon OpenSearch Service Reserved Instances.put-default-application-settingSets the default application to the application with the specified ARN.register-capabilityRegisters a capability for an OpenSearch UI application.reject-inbound-connectionAllows the remote Amazon OpenSearch Service domain owner to reject an inbound cross-cluster connection request.remove-replication-peerStops replicating a domain to its peer.remove-tagsRemoves the specified set of tags from an Amazon OpenSearch Service domain, data source, or application.revoke-vpc-endpoint-accessRevokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.rollback-service-software-updateRolls back a service software update for a domain to the previous version.start-domain-maintenanceStarts the node maintenance process on the data node.start-migrationInitiates a migration job to migrate saved objects from a data source to an Amazon OpenSearch Service application workspace.start-service-software-updateSchedules a service software update for an Amazon OpenSearch Service domain.switchover-replicationPromotes a secondary domain to primary, coordinating with the current primary so that no writes are lost.update-applicationUpdates the configuration and settings of an existing OpenSearch application.update-cloneManages a cloned blue/green upgrade that is in progress on a domain.update-data-sourceUpdates a direct-query data source.update-direct-query-data-sourceUpdates the configuration or properties of an existing direct query data source in Amazon OpenSearch Service.update-domain-configModifies the cluster configuration of the specified Amazon OpenSearch Service domain.update-indexUpdates an existing OpenSearch index schema and semantic enrichment configuration.update-packageUpdates a package for use with Amazon OpenSearch Service domains.update-package-scopeUpdates the scope of a package.update-scheduled-actionReschedules a planned domain configuration change for a later time.update-vpc-endpointModifies an Amazon OpenSearch Service-managed interface VPC endpoint.upgrade-domainAllows you to either upgrade your Amazon OpenSearch Service domain or perform an upgrade eligibility check to a compatible version of OpenSearch or Elasticsearch.