Amazon OpenSearch Service API · Schema
DomainPackageDetails
Information on a package that is associated with a domain.
AnalyticsElasticsearchSearch
Properties
| Name | Type | Description |
|---|---|---|
| PackageID | object | |
| PackageName | object | |
| PackageType | object | |
| LastUpdated | object | |
| DomainName | object | |
| DomainPackageStatus | object | |
| PackageVersion | object | |
| ReferencePath | object | |
| ErrorDetails | object |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-schema/openapi-domain-package-details-schema.json",
"title": "DomainPackageDetails",
"description": "Information on a package that is associated with a domain.",
"type": "object",
"properties": {
"PackageID": {
"allOf": [
{
"$ref": "#/components/schemas/PackageID"
},
{
"description": "Internal ID of the package."
}
]
},
"PackageName": {
"allOf": [
{
"$ref": "#/components/schemas/PackageName"
},
{
"description": "User specified name of the package."
}
]
},
"PackageType": {
"allOf": [
{
"$ref": "#/components/schemas/PackageType"
},
{
"description": "Currently supports only TXT-DICTIONARY."
}
]
},
"LastUpdated": {
"allOf": [
{
"$ref": "#/components/schemas/LastUpdated"
},
{
"description": "Timestamp of the most-recent update to the association status."
}
]
},
"DomainName": {
"allOf": [
{
"$ref": "#/components/schemas/DomainName"
},
{
"description": "Name of the domain you've associated a package with."
}
]
},
"DomainPackageStatus": {
"allOf": [
{
"$ref": "#/components/schemas/DomainPackageStatus"
},
{
"description": "State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED."
}
]
},
"PackageVersion": {
"$ref": "#/components/schemas/PackageVersion"
},
"ReferencePath": {
"allOf": [
{
"$ref": "#/components/schemas/ReferencePath"
},
{
"description": "The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file."
}
]
},
"ErrorDetails": {
"allOf": [
{
"$ref": "#/components/schemas/ErrorDetails"
},
{
"description": "Additional information if the package is in an error state. Null otherwise."
}
]
}
}
}