Amazon OpenSearch Service website screenshot

Amazon OpenSearch Service

Amazon OpenSearch Service is a managed service that makes it easy to deploy, operate, and scale OpenSearch clusters for log analytics, full-text search, application monitoring, and more.

1 APIs 0 Features
AnalyticsElasticsearchFull-Text SearchLog AnalyticsOpenSearchSearch

APIs

Amazon OpenSearch Service API

The Amazon OpenSearch Service API enables you to create, configure, and manage OpenSearch domains for search and analytics workloads.

Collections

Arazzo Workflows

Amazon OpenSearch Service Audit Domain Fleet Readiness

Enumerate domains, bulk-describe them, and drill into a single target domain's status.

ARAZZO

Amazon OpenSearch Service Clone a Domain Engine Version

Read a source domain's engine version and create a new domain that matches it.

ARAZZO

Amazon OpenSearch Service Decommission a Domain

Confirm a domain exists, delete it, and poll until the deletion completes.

ARAZZO

Amazon OpenSearch Service Ensure Domain Exists

Create a domain only when it is not already present in the account.

ARAZZO

Amazon OpenSearch Service Inventory All Domains

List every domain name in the account and fetch full configuration details for all of them.

ARAZZO

Amazon OpenSearch Service Provision Domain and Confirm Endpoint

Create an OpenSearch domain and poll its status until the search endpoint is live.

ARAZZO

Pricing Plans

Rate Limits

FinOps

Semantic Vocabularies

Amazon Opensearch Service Context

0 classes · 3 properties

JSON-LD

Amazon Opensearch Service Openapi Context

2 classes · 10 properties

JSON-LD

API Governance Rules

Amazon OpenSearch Service API Rules

21 rules · 10 errors 10 warnings 1 info

SPECTRAL

JSON Structure

Amazon Opensearch Service Structure

20 properties

JSON STRUCTURE

Openapi Create Domain Request Structure

5 properties

JSON STRUCTURE

Openapi Domain Status Structure

7 properties

JSON STRUCTURE

Example Payloads

Resources

🔗
PostmanWorkspace
PostmanWorkspace
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
🔗
Arazzo
Arazzo
📰
Blog
Blog
💬
Support
Support
🌐
Console
Console
🔗
CLI Reference
CLI Reference
📦
SDKs
SDKs
🟢
Service Status
Service Status
🔗
Compliance
Compliance
📜
TermsOfService
TermsOfService
🔗
Website
Website
🔗
Documentation
Documentation
💰
Pricing
Pricing
🚀
GettingStarted
GettingStarted
💬
FAQ
FAQ
📜
PrivacyPolicy
PrivacyPolicy
📝
Signup
Signup
👥
GitHubOrganization
GitHubOrganization
👥
StackOverflow
StackOverflow
💻
Code Examples
Code Examples
🔗
SpectralRules
SpectralRules
🔗
Vocabulary
Vocabulary
🔗
JSONLD
JSONLD
🔗
JSONLD
JSONLD
🔗
Amazon Opensearch Service
JSONSchema
🔗
Openapi Create Domain Request
JSONSchema
🔗
Openapi Domain Status
JSONSchema

Sources

Raw ↑
opencollection: 1.0.0
info:
  name: Amazon OpenSearch Service API
  version: '2021-01-01'
request:
  auth:
    type: apikey
    key: Authorization
    value: '{{Authorization}}'
    placement: header
items:
- info:
    name: Domains
    type: folder
  items:
  - info:
      name: Amazon OpenSearch Service Create an OpenSearch Domain
      type: http
    http:
      method: POST
      url: https://es.{region}.amazonaws.com/2021-01-01/opensearch/domain
      body:
        type: json
        data: '{}'
    docs: Creates an Amazon OpenSearch Service domain with the specified configuration.
  - info:
      name: Amazon OpenSearch Service Describe an OpenSearch Domain
      type: http
    http:
      method: GET
      url: https://es.{region}.amazonaws.com/2021-01-01/opensearch/domain/:domainName
      params:
      - name: domainName
        value: ''
        type: path
    docs: Returns domain configuration details for the specified domain.
  - info:
      name: Amazon OpenSearch Service Delete an OpenSearch Domain
      type: http
    http:
      method: DELETE
      url: https://es.{region}.amazonaws.com/2021-01-01/opensearch/domain/:domainName
      params:
      - name: domainName
        value: ''
        type: path
    docs: Permanently deletes the specified domain and all of its data.
  - info:
      name: Amazon OpenSearch Service Describe Multiple OpenSearch Domains
      type: http
    http:
      method: POST
      url: https://es.{region}.amazonaws.com/2021-01-01/opensearch/domain-info
      body:
        type: json
        data: '{}'
    docs: Returns domain configuration details for the specified list of domains.
  - info:
      name: Amazon OpenSearch Service List All OpenSearch Domains
      type: http
    http:
      method: GET
      url: https://es.{region}.amazonaws.com/2021-01-01/opensearch/domains
    docs: Returns the names of all OpenSearch domains owned by the current user.
bundled: true