How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Amazon OpenSearch Service API Domain API

The Domain API from Amazon OpenSearch Service API — 2 operation(s) for domain.

Amazon OpenSearch Service API Domain API is one of 5 APIs that Amazon OpenSearch Service API publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Domain. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.

This API exposes 2 operations across 2 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against 4 base URLs: http://es.{region}.amazonaws.com, https://es.{region}.amazonaws.com, http://es.{region}.amazonaws.com.cn, https://es.{region}.amazonaws.com.cn.

2 operations 2 paths 24 schemas 2 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://es.amazonaws.com
Authentication
API Key
Terms of Service
Resource Areas
1

Authentication & Security 1

Amazon OpenSearch Service API Domain API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (hmac). By default, every request must be authenticated.

  • hmac — Amazon Signature authorization v4

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.

Domain 2
GET
/2015-01-01/domain
Amazon OpenSearch List Domain Names
ListDomainNames 8 params → 200480481
GET
/2015-01-01/domain/{DomainName}/packages
Amazon OpenSearch List Packages for Domain
ListPackagesForDomain 12 params → 200480481482483484

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are DomainPackageDetails (9 properties), DomainInfo (2 properties), ErrorDetails (2 properties), ListPackagesForDomainResponse (2 properties). Each schema is shown below with its type and property counts.

ListDomainNamesResponse
object
The result of a ListDomainNames operation. Contains the names of all domains owned by this account and their respective engine types.
1 property
DomainName
string
The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or n…
PackageName
string
PackageVersion
string
EngineType
string
ListPackagesForDomainResponse
object
Container for response parameters to ListPackagesForDomain operation.
2 properties
PackageID
string
DomainPackageDetails
object
Information on a package that is associated with a domain.
9 properties
ResourceNotFoundException
ErrorMessage
string
DomainPackageDetailsList
array
String
string
LastUpdated
string
ErrorDetails
object
2 properties
ReferencePath
string
ErrorType
string
AccessDeniedException
ValidationException
BaseException
PackageType
string
DomainInfo
object
2 properties
DomainPackageStatus
string
InternalException
DomainInfoList
array
Contains the list of Elasticsearch domain information.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

amazon-opensearch-domain-api-openapi.yml Raw ↑

Other APIs Amazon OpenSearch Service API publishes across the network.

Amazon OpenSearch Service API Es API
Amazon OpenSearch Service API Packages API
Amazon OpenSearch Service API Tags API
Amazon OpenSearch Service API Tags Removal API
Where this information came from

This is an independent, third-party profile of Amazon OpenSearch Service API Domain API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.