Amazon OpenSearch Service API
Amazon OpenSearch Service is a managed service that makes it easy to deploy, operate, and scale OpenSearch clusters in the AWS Cloud. It offers visualization capabilities powered by OpenSearch Dashboards and Kibana, and provides direct access to the OpenSearch API so that existing code and applications work seamlessly. It supports log analytics, full-text search, application monitoring, and clickstream analytics.
agent ready
Solid contracts, transparent operations, and an easy start — typically complete on four or five facets with one clear soft spot.
API Evangelist profiles Amazon OpenSearch Service API the way a machine reads it — 975 machine-readable artifacts across 5 APIs, pulled from the provider's own public surface and indexed so a developer, an analyst, or an AI agent can evaluate it against every other provider on the network.
Every provider in the network is reduced to the same set of machine-readable artifacts — OpenAPI contracts, event specifications, GraphQL schemas, runnable collections, pricing and rate-limit signals, security posture, OAuth scopes, and the agent surfaces (MCP servers and skills) that let software drive the API on its own. We profile them because the interface is the part of a company you can actually inspect: it is a truer signal of what a provider does than any marketing page. From those artifacts we compute the Kin Score — Amazon OpenSearch Service API scores 67.6/100 (strong), with a separate agent-readiness read of 48/100 (agent ready). The full breakdown is below, followed by every artifact we hold — each card links through to its machine-readable definition on apis.io.
Kin Score
This is the API Evangelist rating — a single, repeatable read computed from the artifacts on this page. Green fill is points earned; the red track is points possible, so every bar shows earned-versus-possible at a glance.
Kin Score
How this is scored →scored 2026-07-27 · rubric v0.5
Composite quality — 67.6/100 · strong
Contract Quality
17.5 / 25
Developer Ergonomics
7.8 / 20
Commercial Clarity
16.3 / 20
Operational Transparency
6.8 / 13
Governance
10.4 / 12
Discoverability
8.8 / 10
Agent readiness — 48/100 · agent ready
Machine-Readable Contract
18 / 18
Agentic Access Contract
15 / 15
MCP Server
0 / 12
Machine-Readable Auth
10 / 10
Idempotency
0 / 9
Stable Error Semantics
0 / 8
Request/Response Examples
0 / 7
Rate-Limit Signaling
7 / 7
Typed Event Surface
0 / 6
Agent Skills
0 / 5
Well-Known Catalog
0 / 4
Consent & Bot Identity
0 / 3
How we profile Amazon OpenSearch Service API
Each block below is one kind of artifact we hold for Amazon OpenSearch Service API. For each we say what it is and why it earns a place in the profile, then list every one we've indexed — capped at two rows, scroll within the panel for the rest.
APIs 5
Each API is captured as its own OpenAPI definition — every operation, parameter, and response. This is the single most useful machine-readable description of what an API does, and it's what lets us score, lint, mock, and generate against it without asking the provider for anything.
Individual APIs this provider publishes, each with its own machine-readable definition.
Amazon OpenSearch Service API Domain API
The Domain API from Amazon OpenSearch Service API — 2 operation(s) for domain.
Amazon OpenSearch Service API Es API
The Es API from Amazon OpenSearch Service API — 34 operation(s) for es.
Amazon OpenSearch Service API Packages API
The Packages API from Amazon OpenSearch Service API — 8 operation(s) for packages.
Amazon OpenSearch Service API Tags API
The Tags API from Amazon OpenSearch Service API — 2 operation(s) for tags.
Amazon OpenSearch Service API Tags Removal API
The Tags Removal API from Amazon OpenSearch Service API — 1 operation(s) for tags removal.
Open Collections 1
Open, tool-agnostic collections carry the same runnable value as Postman without locking you to one client — the portable, forkable form of the same exercise.
Open, tool-agnostic API collections (OpenAPI-derived and Bruno).
Amazon Elasticsearch Service
OPEN COLLECTIONPricing Plans 1
Pricing is part of the interface. Machine-readable plans tell you what a tier costs and includes before you commit — one of the six things the Kin Score reads for commercial clarity.
Published pricing tiers and plan structures.
Rate Limits 1
Rate limits are the difference between a demo that works and a production integration that doesn't fall over. Publishing them is an operational-transparency signal — and a hard requirement for any agent that plans its own throughput.
Documented rate limits and quota policies.
Amazon Opensearch Rate Limits
RATE LIMITSFinOps 1
Cost, billing, and metering signals let a buyer model the financial operations of an API before it's live. We profile them for the same reason we profile pricing: the money is part of the contract.
Cost, billing, and metering signals for API financial operations.
Amazon Opensearch Finops
FINOPSSemantic Vocabularies 1
JSON-LD contexts give the data shared meaning across APIs. We profile them because semantics are what let a machine reconcile 'customer' here with 'customer' somewhere else.
JSON-LD contexts and semantic vocabularies used across these APIs.
Spectral Rules 2
Governance rulesets we run against this provider's specs — the automated checks behind parts of the score. Profiling them makes the quality bar explicit and re-runnable, not a matter of opinion.
JSON Schema 331
Standalone JSON Schema definitions describe the data models behind the API. We profile them so the shapes are validatable on their own — useful long after a single request is forgotten.
Standalone JSON Schema definitions for this provider's data models.
AccessDeniedException
JSON SCHEMAAccessPoliciesStatus
JSON SCHEMAAddTagsRequest
JSON SCHEMAAdditionalLimitList
JSON SCHEMAAdditionalLimit
JSON SCHEMAAdvancedOptions
JSON SCHEMAAdvancedOptionsStatus
JSON SCHEMAAdvancedSecurityOptionsInput
JSON SCHEMAAdvancedSecurityOptions
JSON SCHEMAAdvancedSecurityOptionsStatus
JSON SCHEMAARN
JSON SCHEMAAssociatePackageRequest
JSON SCHEMAAssociatePackageResponse
JSON SCHEMAAuthorizeVpcEndpointAccessRequest
JSON SCHEMAAuthorizeVpcEndpointAccessResponse
JSON SCHEMAAuthorizedPrincipalList
JSON SCHEMAAuthorizedPrincipal
JSON SCHEMAAutoTuneDate
JSON SCHEMAAutoTuneDesiredState
JSON SCHEMAAutoTuneDetails
JSON SCHEMAAutoTuneList
JSON SCHEMAAutoTuneMaintenanceScheduleList
JSON SCHEMAAutoTuneMaintenanceSchedule
JSON SCHEMAAutoTuneOptionsInput
JSON SCHEMAAutoTuneOptionsOutput
JSON SCHEMAAutoTuneOptions
JSON SCHEMAAutoTuneOptionsStatus
JSON SCHEMAAutoTune
JSON SCHEMAAutoTuneState
JSON SCHEMAAutoTuneStatus
JSON SCHEMAAutoTuneType
JSON SCHEMAAWSAccount
JSON SCHEMABackendRole
JSON SCHEMABaseException
JSON SCHEMABoolean
JSON SCHEMAChangeProgressDetails
JSON SCHEMAChangeProgressStageList
JSON SCHEMAChangeProgressStageName
JSON SCHEMAChangeProgressStage
JSON SCHEMAChangeProgressStageStatus
JSON SCHEMAChangeProgressStatusDetails
JSON SCHEMAClientToken
JSON SCHEMACloudWatchLogsLogGroupArn
JSON SCHEMACognitoOptions
JSON SCHEMACognitoOptionsStatus
JSON SCHEMAColdStorageOptions
JSON SCHEMACommitMessage
JSON SCHEMACompatibleElasticsearchVersionsList
JSON SCHEMACompatibleVersionsMap
JSON SCHEMAConflictException
JSON SCHEMAConnectionAlias
JSON SCHEMACreateElasticsearchDomainRequest
JSON SCHEMACreateElasticsearchDomainResponse
JSON SCHEMACreatePackageRequest
JSON SCHEMACreatePackageResponse
JSON SCHEMACreateVpcEndpointRequest
JSON SCHEMACreateVpcEndpointResponse
JSON SCHEMACreatedAt
JSON SCHEMACrossClusterSearchConnectionId
JSON SCHEMACrossClusterSearchConnectionStatusMessage
JSON SCHEMADeleteElasticsearchDomainRequest
JSON SCHEMADeleteElasticsearchDomainResponse
JSON SCHEMADeletePackageRequest
JSON SCHEMADeletePackageResponse
JSON SCHEMADeleteVpcEndpointRequest
JSON SCHEMADeleteVpcEndpointResponse
JSON SCHEMADeploymentCloseDateTimeStamp
JSON SCHEMADeploymentStatus
JSON SCHEMADeploymentType
JSON SCHEMADescribeDomainAutoTunesRequest
JSON SCHEMADescribeDomainAutoTunesResponse
JSON SCHEMADescribeDomainChangeProgressRequest
JSON SCHEMADescribeDomainChangeProgressResponse
JSON SCHEMADescribeElasticsearchDomainConfigRequest
JSON SCHEMADescribeElasticsearchDomainConfigResponse
JSON SCHEMADescribeElasticsearchDomainRequest
JSON SCHEMADescribeElasticsearchDomainResponse
JSON SCHEMADescribeElasticsearchDomainsRequest
JSON SCHEMADescribeElasticsearchDomainsResponse
JSON SCHEMADescribePackagesFilterList
JSON SCHEMADescribePackagesFilterName
JSON SCHEMADescribePackagesFilter
JSON SCHEMADescribePackagesFilterValue
JSON SCHEMADescribePackagesFilterValues
JSON SCHEMADescribePackagesRequest
JSON SCHEMADescribePackagesResponse
JSON SCHEMADescribeVpcEndpointsRequest
JSON SCHEMADescribeVpcEndpointsResponse
JSON SCHEMADescription
JSON SCHEMADisableTimestamp
JSON SCHEMADisabledOperationException
JSON SCHEMADissociatePackageRequest
JSON SCHEMADissociatePackageResponse
JSON SCHEMADomainArn
JSON SCHEMADomainEndpointOptions
JSON SCHEMADomainEndpointOptionsStatus
JSON SCHEMADomainId
JSON SCHEMADomainInfoList
JSON SCHEMADomainInfo
JSON SCHEMADomainInformation
JSON SCHEMADomainNameFqdn
JSON SCHEMADomainNameList
JSON SCHEMADomainName
JSON SCHEMADomainPackageDetailsList
JSON SCHEMADomainPackageDetails
JSON SCHEMADomainPackageStatus
JSON SCHEMADouble
JSON SCHEMADryRunResults
JSON SCHEMADryRun
JSON SCHEMADuration
JSON SCHEMADurationValue
JSON SCHEMAEBSOptions
JSON SCHEMAEBSOptionsStatus
JSON SCHEMAElasticsearchClusterConfig
JSON SCHEMAElasticsearchClusterConfigStatus
JSON SCHEMAElasticsearchDomainConfig
JSON SCHEMAElasticsearchDomainStatusList
JSON SCHEMAElasticsearchDomainStatus
JSON SCHEMAElasticsearchInstanceTypeList
JSON SCHEMAElasticsearchVersionList
JSON SCHEMAElasticsearchVersionStatus
JSON SCHEMAElasticsearchVersionString
JSON SCHEMAEncryptionAtRestOptions
JSON SCHEMAEncryptionAtRestOptionsStatus
JSON SCHEMAEndpoint
JSON SCHEMAEndpointsMap
JSON SCHEMAEngineType
JSON SCHEMAErrorDetails
JSON SCHEMAErrorMessage
JSON SCHEMAErrorType
JSON SCHEMAESPartitionInstanceType
JSON SCHEMAESWarmPartitionInstanceType
JSON SCHEMAFilterList
JSON SCHEMAFilter
JSON SCHEMAGetCompatibleElasticsearchVersionsRequest
JSON SCHEMAGetCompatibleElasticsearchVersionsResponse
JSON SCHEMAGetPackageVersionHistoryRequest
JSON SCHEMAGetPackageVersionHistoryResponse
JSON SCHEMAGetUpgradeHistoryRequest
JSON SCHEMAGetUpgradeHistoryResponse
JSON SCHEMAGetUpgradeStatusRequest
JSON SCHEMAGetUpgradeStatusResponse
JSON SCHEMAGUID
JSON SCHEMAIdentityPoolId
JSON SCHEMAInboundCrossClusterSearchConnection
JSON SCHEMAInboundCrossClusterSearchConnectionStatus
JSON SCHEMAInboundCrossClusterSearchConnections
JSON SCHEMAInstanceCountLimits
JSON SCHEMAInstanceCount
JSON SCHEMAInstanceLimits
JSON SCHEMAInstanceRole
JSON SCHEMAIntegerClass
JSON SCHEMAInteger
JSON SCHEMAInternalException
JSON SCHEMAInvalidPaginationTokenException
JSON SCHEMAInvalidTypeException
JSON SCHEMAIssue
JSON SCHEMAIssues
JSON SCHEMAKmsKeyId
JSON SCHEMALastUpdated
JSON SCHEMALimitExceededException
JSON SCHEMALimitName
JSON SCHEMALimitValueList
JSON SCHEMALimitValue
JSON SCHEMALimitsByRole
JSON SCHEMALimits
JSON SCHEMAListDomainNamesRequest
JSON SCHEMAListDomainNamesResponse
JSON SCHEMAListDomainsForPackageRequest
JSON SCHEMAListDomainsForPackageResponse
JSON SCHEMAListElasticsearchInstanceTypesRequest
JSON SCHEMAListElasticsearchInstanceTypesResponse
JSON SCHEMAListElasticsearchVersionsRequest
JSON SCHEMAListElasticsearchVersionsResponse
JSON SCHEMAListPackagesForDomainRequest
JSON SCHEMAListPackagesForDomainResponse
JSON SCHEMAListTagsRequest
JSON SCHEMAListTagsResponse
JSON SCHEMAListVpcEndpointAccessRequest
JSON SCHEMAListVpcEndpointAccessResponse
JSON SCHEMAListVpcEndpointsForDomainRequest
JSON SCHEMAListVpcEndpointsForDomainResponse
JSON SCHEMAListVpcEndpointsRequest
JSON SCHEMAListVpcEndpointsResponse
JSON SCHEMALogPublishingOption
JSON SCHEMALogPublishingOptions
JSON SCHEMALogPublishingOptionsStatus
JSON SCHEMALogType
JSON SCHEMAMasterUserOptions
JSON SCHEMAMaxResults
JSON SCHEMAMaximumInstanceCount
JSON SCHEMAMessage
JSON SCHEMAMinimumInstanceCount
JSON SCHEMANextToken
JSON SCHEMANodeToNodeEncryptionOptions
JSON SCHEMANodeToNodeEncryptionOptionsStatus
JSON SCHEMANonEmptyString
JSON SCHEMAOptionState
JSON SCHEMAOptionStatus
JSON SCHEMAOutboundCrossClusterSearchConnection
JSON SCHEMAOutboundCrossClusterSearchConnectionStatus
JSON SCHEMAOutboundCrossClusterSearchConnections
JSON SCHEMAOverallChangeStatus
JSON SCHEMAOwnerId
JSON SCHEMAPackageDescription
JSON SCHEMAPackageDetailsList
JSON SCHEMAPackageDetails
JSON SCHEMAPackageID
JSON SCHEMAPackageName
JSON SCHEMAPackageSource
JSON SCHEMAPackageStatus
JSON SCHEMAPackageType
JSON SCHEMAPackageVersionHistoryList
JSON SCHEMAPackageVersionHistory
JSON SCHEMAPackageVersion
JSON SCHEMAPassword
JSON SCHEMAPolicyDocument
JSON SCHEMAPrincipalType
JSON SCHEMARecurringChargeList
JSON SCHEMARecurringCharge
JSON SCHEMAReferencePath
JSON SCHEMARegion
JSON SCHEMARemoveTagsRequest
JSON SCHEMAReservationToken
JSON SCHEMAReservedElasticsearchInstanceList
JSON SCHEMAReservedElasticsearchInstanceOfferingList
JSON SCHEMAReservedElasticsearchInstanceOffering
JSON SCHEMAReservedElasticsearchInstancePaymentOption
JSON SCHEMAReservedElasticsearchInstance
JSON SCHEMAResourceAlreadyExistsException
JSON SCHEMAResourceNotFoundException
JSON SCHEMARevokeVpcEndpointAccessRequest
JSON SCHEMARevokeVpcEndpointAccessResponse
JSON SCHEMARoleArn
JSON SCHEMARollbackOnDisable
JSON SCHEMAS3BucketName
JSON SCHEMAS3Key
JSON SCHEMASAMLEntityId
JSON SCHEMASAMLIdp
JSON SCHEMASAMLMetadata
JSON SCHEMASAMLOptionsInput
JSON SCHEMASAMLOptionsOutput
JSON SCHEMAScheduledAutoTuneActionType
JSON SCHEMAScheduledAutoTuneDescription
JSON SCHEMAScheduledAutoTuneDetails
JSON SCHEMAScheduledAutoTuneSeverityType
JSON SCHEMAServiceSoftwareOptions
JSON SCHEMAServiceUrl
JSON SCHEMASnapshotOptions
JSON SCHEMASnapshotOptionsStatus
JSON SCHEMAStartAt
JSON SCHEMAStartTimestamp
JSON SCHEMAStorageSubTypeName
JSON SCHEMAStorageTypeLimitList
JSON SCHEMAStorageTypeLimit
JSON SCHEMAStorageTypeList
JSON SCHEMAStorageTypeName
JSON SCHEMAStorageType
JSON SCHEMAStringList
JSON SCHEMAString
JSON SCHEMATagKey
JSON SCHEMATagList
JSON SCHEMATag
JSON SCHEMATagValue
JSON SCHEMATimeUnit
JSON SCHEMATLSSecurityPolicy
JSON SCHEMATotalNumberOfStages
JSON SCHEMAUIntValue
JSON SCHEMAUpdateElasticsearchDomainConfigRequest
JSON SCHEMAUpdateElasticsearchDomainConfigResponse
JSON SCHEMAUpdatePackageRequest
JSON SCHEMAUpdatePackageResponse
JSON SCHEMAUpdateTimestamp
JSON SCHEMAUpdateVpcEndpointRequest
JSON SCHEMAUpdateVpcEndpointResponse
JSON SCHEMAUpgradeElasticsearchDomainRequest
JSON SCHEMAUpgradeElasticsearchDomainResponse
JSON SCHEMAUpgradeHistoryList
JSON SCHEMAUpgradeHistory
JSON SCHEMAUpgradeName
JSON SCHEMAUpgradeStatus
JSON SCHEMAUpgradeStepItem
JSON SCHEMAUpgradeStep
JSON SCHEMAUpgradeStepsList
JSON SCHEMAUserPoolId
JSON SCHEMAUsername
JSON SCHEMAValidationException
JSON SCHEMAValueStringList
JSON SCHEMAVolumeType
JSON SCHEMAVPCDerivedInfo
JSON SCHEMAVPCDerivedInfoStatus
JSON SCHEMAVpcEndpointErrorCode
JSON SCHEMAVpcEndpointErrorList
JSON SCHEMAVpcEndpointError
JSON SCHEMAVpcEndpointIdList
JSON SCHEMAVpcEndpointId
JSON SCHEMAVpcEndpoint
JSON SCHEMAVpcEndpointStatus
JSON SCHEMAVpcEndpointSummaryList
JSON SCHEMAVpcEndpointSummary
JSON SCHEMAVpcEndpoints
JSON SCHEMAVPCOptions
JSON SCHEMAZoneAwarenessConfig
JSON SCHEMAScroll within the panel for all 331 ·
JSON Structure 331
JSON Structure captures the data shapes in a form built for tooling — a complement to JSON Schema that keeps the model machine-legible.
JSON Structure definitions describing this provider's data shapes.
Openapi Access Denied Exception Structure
JSON STRUCTUREOpenapi Access Policies Status Structure
JSON STRUCTUREOpenapi Add Tags Request Structure
JSON STRUCTUREOpenapi Additional Limit List Structure
JSON STRUCTUREOpenapi Additional Limit Structure
JSON STRUCTUREOpenapi Advanced Options Status Structure
JSON STRUCTUREOpenapi Advanced Options Structure
JSON STRUCTUREOpenapi Advanced Security Options Input Structure
JSON STRUCTUREOpenapi Advanced Security Options Status Structure
JSON STRUCTUREOpenapi Advanced Security Options Structure
JSON STRUCTUREOpenapi Arn Structure
JSON STRUCTUREOpenapi Associate Package Request Structure
JSON STRUCTUREOpenapi Associate Package Response Structure
JSON STRUCTUREOpenapi Authorize Vpc Endpoint Access Request Structure
JSON STRUCTUREOpenapi Authorize Vpc Endpoint Access Response Structure
JSON STRUCTUREOpenapi Authorized Principal List Structure
JSON STRUCTUREOpenapi Authorized Principal Structure
JSON STRUCTUREOpenapi Auto Tune Date Structure
JSON STRUCTUREOpenapi Auto Tune Desired State Structure
JSON STRUCTUREOpenapi Auto Tune Details Structure
JSON STRUCTUREOpenapi Auto Tune List Structure
JSON STRUCTUREOpenapi Auto Tune Maintenance Schedule List Structure
JSON STRUCTUREOpenapi Auto Tune Maintenance Schedule Structure
JSON STRUCTUREOpenapi Auto Tune Options Input Structure
JSON STRUCTUREOpenapi Auto Tune Options Output Structure
JSON STRUCTUREOpenapi Auto Tune Options Status Structure
JSON STRUCTUREOpenapi Auto Tune Options Structure
JSON STRUCTUREOpenapi Auto Tune State Structure
JSON STRUCTUREOpenapi Auto Tune Status Structure
JSON STRUCTUREOpenapi Auto Tune Structure
JSON STRUCTUREOpenapi Auto Tune Type Structure
JSON STRUCTUREOpenapi Aws Account Structure
JSON STRUCTUREOpenapi Backend Role Structure
JSON STRUCTUREOpenapi Base Exception Structure
JSON STRUCTUREOpenapi Boolean Structure
JSON STRUCTUREOpenapi Change Progress Details Structure
JSON STRUCTUREOpenapi Change Progress Stage List Structure
JSON STRUCTUREOpenapi Change Progress Stage Name Structure
JSON STRUCTUREOpenapi Change Progress Stage Status Structure
JSON STRUCTUREOpenapi Change Progress Stage Structure
JSON STRUCTUREOpenapi Change Progress Status Details Structure
JSON STRUCTUREOpenapi Client Token Structure
JSON STRUCTUREOpenapi Cloud Watch Logs Log Group Arn Structure
JSON STRUCTUREOpenapi Cognito Options Status Structure
JSON STRUCTUREOpenapi Cognito Options Structure
JSON STRUCTUREOpenapi Cold Storage Options Structure
JSON STRUCTUREOpenapi Commit Message Structure
JSON STRUCTUREOpenapi Compatible Elasticsearch Versions List Structure
JSON STRUCTUREOpenapi Compatible Versions Map Structure
JSON STRUCTUREOpenapi Conflict Exception Structure
JSON STRUCTUREOpenapi Connection Alias Structure
JSON STRUCTUREOpenapi Create Elasticsearch Domain Request Structure
JSON STRUCTUREOpenapi Create Elasticsearch Domain Response Structure
JSON STRUCTUREOpenapi Create Package Request Structure
JSON STRUCTUREOpenapi Create Package Response Structure
JSON STRUCTUREOpenapi Create Vpc Endpoint Request Structure
JSON STRUCTUREOpenapi Create Vpc Endpoint Response Structure
JSON STRUCTUREOpenapi Created At Structure
JSON STRUCTUREOpenapi Cross Cluster Search Connection Id Structure
JSON STRUCTUREOpenapi Delete Elasticsearch Domain Request Structure
JSON STRUCTUREOpenapi Delete Elasticsearch Domain Response Structure
JSON STRUCTUREOpenapi Delete Package Request Structure
JSON STRUCTUREOpenapi Delete Package Response Structure
JSON STRUCTUREOpenapi Delete Vpc Endpoint Request Structure
JSON STRUCTUREOpenapi Delete Vpc Endpoint Response Structure
JSON STRUCTUREOpenapi Deployment Close Date Time Stamp Structure
JSON STRUCTUREOpenapi Deployment Status Structure
JSON STRUCTUREOpenapi Deployment Type Structure
JSON STRUCTUREOpenapi Describe Domain Auto Tunes Request Structure
JSON STRUCTUREOpenapi Describe Domain Auto Tunes Response Structure
JSON STRUCTUREOpenapi Describe Elasticsearch Domain Request Structure
JSON STRUCTUREOpenapi Describe Elasticsearch Domain Response Structure
JSON STRUCTUREOpenapi Describe Elasticsearch Domains Request Structure
JSON STRUCTUREOpenapi Describe Packages Filter List Structure
JSON STRUCTUREOpenapi Describe Packages Filter Name Structure
JSON STRUCTUREOpenapi Describe Packages Filter Structure
JSON STRUCTUREOpenapi Describe Packages Filter Value Structure
JSON STRUCTUREOpenapi Describe Packages Filter Values Structure
JSON STRUCTUREOpenapi Describe Packages Request Structure
JSON STRUCTUREOpenapi Describe Packages Response Structure
JSON STRUCTUREOpenapi Describe Vpc Endpoints Request Structure
JSON STRUCTUREOpenapi Describe Vpc Endpoints Response Structure
JSON STRUCTUREOpenapi Description Structure
JSON STRUCTUREOpenapi Disable Timestamp Structure
JSON STRUCTUREOpenapi Disabled Operation Exception Structure
JSON STRUCTUREOpenapi Dissociate Package Request Structure
JSON STRUCTUREOpenapi Dissociate Package Response Structure
JSON STRUCTUREOpenapi Domain Arn Structure
JSON STRUCTUREOpenapi Domain Endpoint Options Status Structure
JSON STRUCTUREOpenapi Domain Endpoint Options Structure
JSON STRUCTUREOpenapi Domain Id Structure
JSON STRUCTUREOpenapi Domain Info List Structure
JSON STRUCTUREOpenapi Domain Info Structure
JSON STRUCTUREOpenapi Domain Information Structure
JSON STRUCTUREOpenapi Domain Name Fqdn Structure
JSON STRUCTUREOpenapi Domain Name List Structure
JSON STRUCTUREOpenapi Domain Name Structure
JSON STRUCTUREOpenapi Domain Package Details List Structure
JSON STRUCTUREOpenapi Domain Package Details Structure
JSON STRUCTUREOpenapi Domain Package Status Structure
JSON STRUCTUREOpenapi Double Structure
JSON STRUCTUREOpenapi Dry Run Results Structure
JSON STRUCTUREOpenapi Dry Run Structure
JSON STRUCTUREOpenapi Duration Structure
JSON STRUCTUREOpenapi Duration Value Structure
JSON STRUCTUREOpenapi Ebs Options Status Structure
JSON STRUCTUREOpenapi Ebs Options Structure
JSON STRUCTUREOpenapi Elasticsearch Cluster Config Status Structure
JSON STRUCTUREOpenapi Elasticsearch Cluster Config Structure
JSON STRUCTUREOpenapi Elasticsearch Domain Config Structure
JSON STRUCTUREOpenapi Elasticsearch Domain Status List Structure
JSON STRUCTUREOpenapi Elasticsearch Domain Status Structure
JSON STRUCTUREOpenapi Elasticsearch Instance Type List Structure
JSON STRUCTUREOpenapi Elasticsearch Version List Structure
JSON STRUCTUREOpenapi Elasticsearch Version Status Structure
JSON STRUCTUREOpenapi Elasticsearch Version String Structure
JSON STRUCTUREOpenapi Encryption At Rest Options Status Structure
JSON STRUCTUREOpenapi Encryption At Rest Options Structure
JSON STRUCTUREOpenapi Endpoint Structure
JSON STRUCTUREOpenapi Endpoints Map Structure
JSON STRUCTUREOpenapi Engine Type Structure
JSON STRUCTUREOpenapi Error Details Structure
JSON STRUCTUREOpenapi Error Message Structure
JSON STRUCTUREOpenapi Error Type Structure
JSON STRUCTUREOpenapi Es Partition Instance Type Structure
JSON STRUCTUREOpenapi Es Warm Partition Instance Type Structure
JSON STRUCTUREOpenapi Filter List Structure
JSON STRUCTUREOpenapi Filter Structure
JSON STRUCTUREOpenapi Get Package Version History Request Structure
JSON STRUCTUREOpenapi Get Package Version History Response Structure
JSON STRUCTUREOpenapi Get Upgrade History Request Structure
JSON STRUCTUREOpenapi Get Upgrade History Response Structure
JSON STRUCTUREOpenapi Get Upgrade Status Request Structure
JSON STRUCTUREOpenapi Get Upgrade Status Response Structure
JSON STRUCTUREOpenapi Guid Structure
JSON STRUCTUREOpenapi Identity Pool Id Structure
JSON STRUCTUREOpenapi Instance Count Limits Structure
JSON STRUCTUREOpenapi Instance Count Structure
JSON STRUCTUREOpenapi Instance Limits Structure
JSON STRUCTUREOpenapi Instance Role Structure
JSON STRUCTUREOpenapi Integer Class Structure
JSON STRUCTUREOpenapi Integer Structure
JSON STRUCTUREOpenapi Internal Exception Structure
JSON STRUCTUREOpenapi Invalid Pagination Token Exception Structure
JSON STRUCTUREOpenapi Invalid Type Exception Structure
JSON STRUCTUREOpenapi Issue Structure
JSON STRUCTUREOpenapi Issues Structure
JSON STRUCTUREOpenapi Kms Key Id Structure
JSON STRUCTUREOpenapi Last Updated Structure
JSON STRUCTUREOpenapi Limit Exceeded Exception Structure
JSON STRUCTUREOpenapi Limit Name Structure
JSON STRUCTUREOpenapi Limit Value List Structure
JSON STRUCTUREOpenapi Limit Value Structure
JSON STRUCTUREOpenapi Limits By Role Structure
JSON STRUCTUREOpenapi Limits Structure
JSON STRUCTUREOpenapi List Domain Names Request Structure
JSON STRUCTUREOpenapi List Domain Names Response Structure
JSON STRUCTUREOpenapi List Domains For Package Request Structure
JSON STRUCTUREOpenapi List Domains For Package Response Structure
JSON STRUCTUREOpenapi List Elasticsearch Versions Request Structure
JSON STRUCTUREOpenapi List Elasticsearch Versions Response Structure
JSON STRUCTUREOpenapi List Packages For Domain Request Structure
JSON STRUCTUREOpenapi List Packages For Domain Response Structure
JSON STRUCTUREOpenapi List Tags Request Structure
JSON STRUCTUREOpenapi List Tags Response Structure
JSON STRUCTUREOpenapi List Vpc Endpoint Access Request Structure
JSON STRUCTUREOpenapi List Vpc Endpoint Access Response Structure
JSON STRUCTUREOpenapi List Vpc Endpoints For Domain Request Structure
JSON STRUCTUREOpenapi List Vpc Endpoints For Domain Response Structure
JSON STRUCTUREOpenapi List Vpc Endpoints Request Structure
JSON STRUCTUREOpenapi List Vpc Endpoints Response Structure
JSON STRUCTUREOpenapi Log Publishing Option Structure
JSON STRUCTUREOpenapi Log Publishing Options Status Structure
JSON STRUCTUREOpenapi Log Publishing Options Structure
JSON STRUCTUREOpenapi Log Type Structure
JSON STRUCTUREOpenapi Master User Options Structure
JSON STRUCTUREOpenapi Max Results Structure
JSON STRUCTUREOpenapi Maximum Instance Count Structure
JSON STRUCTUREOpenapi Message Structure
JSON STRUCTUREOpenapi Minimum Instance Count Structure
JSON STRUCTUREOpenapi Next Token Structure
JSON STRUCTUREOpenapi Node To Node Encryption Options Status Structure
JSON STRUCTUREOpenapi Node To Node Encryption Options Structure
JSON STRUCTUREOpenapi Non Empty String Structure
JSON STRUCTUREOpenapi Option State Structure
JSON STRUCTUREOpenapi Option Status Structure
JSON STRUCTUREOpenapi Overall Change Status Structure
JSON STRUCTUREOpenapi Owner Id Structure
JSON STRUCTUREOpenapi Package Description Structure
JSON STRUCTUREOpenapi Package Details List Structure
JSON STRUCTUREOpenapi Package Details Structure
JSON STRUCTUREOpenapi Package Id Structure
JSON STRUCTUREOpenapi Package Name Structure
JSON STRUCTUREOpenapi Package Source Structure
JSON STRUCTUREOpenapi Package Status Structure
JSON STRUCTUREOpenapi Package Type Structure
JSON STRUCTUREOpenapi Package Version History List Structure
JSON STRUCTUREOpenapi Package Version History Structure
JSON STRUCTUREOpenapi Package Version Structure
JSON STRUCTUREOpenapi Password Structure
JSON STRUCTUREOpenapi Policy Document Structure
JSON STRUCTUREOpenapi Principal Type Structure
JSON STRUCTUREOpenapi Recurring Charge List Structure
JSON STRUCTUREOpenapi Recurring Charge Structure
JSON STRUCTUREOpenapi Reference Path Structure
JSON STRUCTUREOpenapi Region Structure
JSON STRUCTUREOpenapi Remove Tags Request Structure
JSON STRUCTUREOpenapi Reservation Token Structure
JSON STRUCTUREOpenapi Reserved Elasticsearch Instance List Structure
JSON STRUCTUREOpenapi Reserved Elasticsearch Instance Structure
JSON STRUCTUREOpenapi Resource Already Exists Exception Structure
JSON STRUCTUREOpenapi Resource Not Found Exception Structure
JSON STRUCTUREOpenapi Revoke Vpc Endpoint Access Request Structure
JSON STRUCTUREOpenapi Revoke Vpc Endpoint Access Response Structure
JSON STRUCTUREOpenapi Role Arn Structure
JSON STRUCTUREOpenapi Rollback On Disable Structure
JSON STRUCTUREOpenapi S3 Bucket Name Structure
JSON STRUCTUREOpenapi S3 Key Structure
JSON STRUCTUREOpenapi Saml Entity Id Structure
JSON STRUCTUREOpenapi Saml Idp Structure
JSON STRUCTUREOpenapi Saml Metadata Structure
JSON STRUCTUREOpenapi Saml Options Input Structure
JSON STRUCTUREOpenapi Saml Options Output Structure
JSON STRUCTUREOpenapi Scheduled Auto Tune Action Type Structure
JSON STRUCTUREOpenapi Scheduled Auto Tune Description Structure
JSON STRUCTUREOpenapi Scheduled Auto Tune Details Structure
JSON STRUCTUREOpenapi Scheduled Auto Tune Severity Type Structure
JSON STRUCTUREOpenapi Service Software Options Structure
JSON STRUCTUREOpenapi Service Url Structure
JSON STRUCTUREOpenapi Snapshot Options Status Structure
JSON STRUCTUREOpenapi Snapshot Options Structure
JSON STRUCTUREOpenapi Start At Structure
JSON STRUCTUREOpenapi Start Timestamp Structure
JSON STRUCTUREOpenapi Storage Sub Type Name Structure
JSON STRUCTUREOpenapi Storage Type Limit List Structure
JSON STRUCTUREOpenapi Storage Type Limit Structure
JSON STRUCTUREOpenapi Storage Type List Structure
JSON STRUCTUREOpenapi Storage Type Name Structure
JSON STRUCTUREOpenapi Storage Type Structure
JSON STRUCTUREOpenapi String List Structure
JSON STRUCTUREOpenapi String Structure
JSON STRUCTUREOpenapi Tag Key Structure
JSON STRUCTUREOpenapi Tag List Structure
JSON STRUCTUREOpenapi Tag Structure
JSON STRUCTUREOpenapi Tag Value Structure
JSON STRUCTUREOpenapi Time Unit Structure
JSON STRUCTUREOpenapi Tls Security Policy Structure
JSON STRUCTUREOpenapi Total Number Of Stages Structure
JSON STRUCTUREOpenapi U Int Value Structure
JSON STRUCTUREOpenapi Update Package Request Structure
JSON STRUCTUREOpenapi Update Package Response Structure
JSON STRUCTUREOpenapi Update Timestamp Structure
JSON STRUCTUREOpenapi Update Vpc Endpoint Request Structure
JSON STRUCTUREOpenapi Update Vpc Endpoint Response Structure
JSON STRUCTUREOpenapi Upgrade Elasticsearch Domain Request Structure
JSON STRUCTUREOpenapi Upgrade Elasticsearch Domain Response Structure
JSON STRUCTUREOpenapi Upgrade History List Structure
JSON STRUCTUREOpenapi Upgrade History Structure
JSON STRUCTUREOpenapi Upgrade Name Structure
JSON STRUCTUREOpenapi Upgrade Status Structure
JSON STRUCTUREOpenapi Upgrade Step Item Structure
JSON STRUCTUREOpenapi Upgrade Step Structure
JSON STRUCTUREOpenapi Upgrade Steps List Structure
JSON STRUCTUREOpenapi User Pool Id Structure
JSON STRUCTUREOpenapi Username Structure
JSON STRUCTUREOpenapi Validation Exception Structure
JSON STRUCTUREOpenapi Value String List Structure
JSON STRUCTUREOpenapi Volume Type Structure
JSON STRUCTUREOpenapi Vpc Derived Info Status Structure
JSON STRUCTUREOpenapi Vpc Derived Info Structure
JSON STRUCTUREOpenapi Vpc Endpoint Error Code Structure
JSON STRUCTUREOpenapi Vpc Endpoint Error List Structure
JSON STRUCTUREOpenapi Vpc Endpoint Error Structure
JSON STRUCTUREOpenapi Vpc Endpoint Id List Structure
JSON STRUCTUREOpenapi Vpc Endpoint Id Structure
JSON STRUCTUREOpenapi Vpc Endpoint Status Structure
JSON STRUCTUREOpenapi Vpc Endpoint Structure
JSON STRUCTUREOpenapi Vpc Endpoint Summary List Structure
JSON STRUCTUREOpenapi Vpc Endpoint Summary Structure
JSON STRUCTUREOpenapi Vpc Endpoints Structure
JSON STRUCTUREOpenapi Vpc Options Structure
JSON STRUCTUREOpenapi Zone Awareness Config Structure
JSON STRUCTUREScroll within the panel for all 331 ·
Examples 296
Real request and response payloads are what turn a spec from abstract into obvious — and they're one of the twelve things an agent needs to call an API correctly on the first try.
Example request and response payloads for these APIs.
Openapi Arn Example
EXAMPLEOpenapi Auto Tune Example
EXAMPLEOpenapi Aws Account Example
EXAMPLEOpenapi Backend Role Example
EXAMPLEOpenapi Boolean Example
EXAMPLEOpenapi Client Token Example
EXAMPLEOpenapi Created At Example
EXAMPLEOpenapi Description Example
EXAMPLEOpenapi Domain Arn Example
EXAMPLEOpenapi Domain Id Example
EXAMPLEOpenapi Domain Info Example
EXAMPLEOpenapi Domain Name Example
EXAMPLEOpenapi Double Example
EXAMPLEOpenapi Dry Run Example
EXAMPLEOpenapi Duration Example
EXAMPLEOpenapi Ebs Options Example
EXAMPLEOpenapi Endpoint Example
EXAMPLEOpenapi Engine Type Example
EXAMPLEOpenapi Error Type Example
EXAMPLEOpenapi Filter Example
EXAMPLEOpenapi Guid Example
EXAMPLEOpenapi Integer Example
EXAMPLEOpenapi Issue Example
EXAMPLEOpenapi Kms Key Id Example
EXAMPLEOpenapi Last Updated Example
EXAMPLEOpenapi Limit Name Example
EXAMPLEOpenapi Limit Value Example
EXAMPLEOpenapi Limits Example
EXAMPLEOpenapi Log Type Example
EXAMPLEOpenapi Max Results Example
EXAMPLEOpenapi Message Example
EXAMPLEOpenapi Next Token Example
EXAMPLEOpenapi Option State Example
EXAMPLEOpenapi Owner Id Example
EXAMPLEOpenapi Package Id Example
EXAMPLEOpenapi Package Name Example
EXAMPLEOpenapi Package Type Example
EXAMPLEOpenapi Password Example
EXAMPLEOpenapi Region Example
EXAMPLEOpenapi Role Arn Example
EXAMPLEOpenapi S3 Key Example
EXAMPLEOpenapi Saml Idp Example
EXAMPLEOpenapi Service Url Example
EXAMPLEOpenapi Start At Example
EXAMPLEOpenapi Storage Type Example
EXAMPLEOpenapi String Example
EXAMPLEOpenapi Tag Example
EXAMPLEOpenapi Tag Key Example
EXAMPLEOpenapi Tag Value Example
EXAMPLEOpenapi Time Unit Example
EXAMPLEOpenapi U Int Value Example
EXAMPLEOpenapi Upgrade Name Example
EXAMPLEOpenapi Upgrade Step Example
EXAMPLEOpenapi User Pool Id Example
EXAMPLEOpenapi Username Example
EXAMPLEOpenapi Volume Type Example
EXAMPLEOpenapi Vpc Endpoint Example
EXAMPLEOpenapi Vpc Options Example
EXAMPLEScroll within the panel for all 296 ·
Security Posture 4
Authentication, domain security, vulnerability disclosure, and trust-center signals — the evidence that a provider takes security seriously enough to document it. We profile it because you can't govern what you can't see.
Authentication, domain security, vulnerability disclosure, and trust-center signals.
Agentic Access 1
An x-agentic-access contract marks which operations are safe for an agent to run on its own and which need a human in the loop. It is the difference between an API an agent can use and one it can use safely.
Recommended x-agentic-access execution contracts for AI agents.
Resources
Every other property we hold for Amazon OpenSearch Service API — documentation, portals, status pages, policies, and corporate surface — grouped by the job it does, following the integrator's arc from getting started to running in production.
Get Started 4
Portal, sign-up, and the first successful call
Documentation 6
Reference material describing how the API behaves
Agent Surfaces 1
MCP servers, agent skills, and machine-readable catalogs
Design & Contract 3
Pagination, idempotency, versioning, errors, and events
Build 1
SDKs, sample code, and the tooling you integrate with
Access & Security 4
Authentication, authorization, and security posture
Operate 3
Status, limits, changes, and where to get help
Commercial 2
Pricing, plans, and the legal terms of use
Company 1
The organization behind the API
← All providers · Data indexed from github.com/api-evangelist/amazon-opensearch · machine-readable index on apis.io