Amazon OpenSearch Service API · JSON Structure

Openapi Domain Package Details Structure

Information on a package that is associated with a domain.

Type: object Properties: 9
AnalyticsElasticsearchSearch

DomainPackageDetails is a JSON Structure definition published by Amazon OpenSearch Service API, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

PackageID PackageName PackageType LastUpdated DomainName DomainPackageStatus PackageVersion ReferencePath ErrorDetails

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-opensearch/refs/heads/main/json-structure/openapi-domain-package-details-structure.json",
  "name": "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."
        }
      ]
    }
  }
}