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 Packages API

The Packages API from Amazon OpenSearch Service API — 8 operation(s) for packages.

Amazon OpenSearch Service API Packages 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 Packages. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, pricing, and a getting-started guide.

This API exposes 8 operations across 8 paths, and defines 45 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.

8 operations 8 paths 45 schemas 1 DELETE2 GET5 POST

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 Packages 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 8

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

Packages 8
POST
/2015-01-01/packages/associate/{PackageID}/{DomainName}
Amazon OpenSearch Associate Package
AssociatePackage 9 params → 200480481482483484485
POST
/2015-01-01/packages
Amazon OpenSearch Create Package
CreatePackage 7 params body → 200480481482483484485486
DELETE
/2015-01-01/packages/{PackageID}
Amazon OpenSearch Delete Package
DeletePackage 8 params → 200480481482483484485
POST
/2015-01-01/packages/describe
Amazon OpenSearch Describe Packages
DescribePackages 9 params body → 200480481482483484
POST
/2015-01-01/packages/dissociate/{PackageID}/{DomainName}
Amazon OpenSearch Dissociate Package
DissociatePackage 9 params → 200480481482483484485
GET
/2015-01-01/packages/{PackageID}/history
Amazon OpenSearch Get Package Version History
GetPackageVersionHistory 12 params → 200480481482483484
GET
/2015-01-01/packages/{PackageID}/domains
Amazon OpenSearch List Domains for Package
ListDomainsForPackage 12 params → 200480481482483484
POST
/2015-01-01/packages/update
Amazon OpenSearch Update Package
UpdatePackage 7 params body → 200480481482483484485

Schemas 45

The contract defines 45 schemas that model the data the API accepts and returns. The most detailed are DomainPackageDetails (9 properties), PackageDetails (9 properties), PackageVersionHistory (3 properties), GetPackageVersionHistoryResponse (3 properties). Each schema is shown below with its type and property counts.

PackageDetails
object
Basic information about a package.
9 properties
ConflictException
ListDomainsForPackageResponse
object
Container for response parameters to ListDomainsForPackage operation.
2 properties
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…
CreatedAt
string
PackageName
string
PackageVersion
string
DescribePackagesFilterName
string
UpdatePackageResponse
object
Container for response returned by UpdatePackage operation.
1 property
AssociatePackageResponse
object
Container for response returned by AssociatePackage operation.
1 property
DescribePackagesFilter
object
Filter to apply in DescribePackage response.
2 properties
PackageID
string
PackageVersionHistory
object
Details of a package version.
3 properties
DomainPackageDetails
object
Information on a package that is associated with a domain.
9 properties
CreatePackageResponse
object
Container for response returned by CreatePackage operation.
1 property
CommitMessage
string
ResourceNotFoundException
PackageStatus
string
ErrorMessage
string
PackageDescription
string
DomainPackageDetailsList
array
GetPackageVersionHistoryResponse
object
Container for response returned by GetPackageVersionHistory operation.
3 properties
PackageDetailsList
array
String
string
ResourceAlreadyExistsException
S3Key
string
LastUpdated
string
DissociatePackageResponse
object
Container for response returned by DissociatePackage operation.
1 property
ErrorDetails
object
2 properties
DescribePackagesFilterValues
array
ReferencePath
string
PackageVersionHistoryList
array
ErrorType
string
DeletePackageResponse
object
Container for response parameters to DeletePackage operation.
1 property
AccessDeniedException
InvalidTypeException
PackageType
string
ValidationException
BaseException
DescribePackagesResponse
object
Container for response returned by DescribePackages operation.
2 properties
DomainPackageStatus
string
InternalException
S3BucketName
string
DescribePackagesFilterValue
string
LimitExceededException

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Amazon OpenSearch Service API publishes across the network.

Amazon OpenSearch Service API Domain API
Amazon OpenSearch Service API Es 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 Packages 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.