Amazon OpenSearch Service API · JSON Structure

Openapi Package Details Structure

Basic information about a package.

Type: object Properties: 9
AnalyticsElasticsearchSearch

PackageDetails 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 PackageDescription PackageStatus CreatedAt LastUpdatedAt AvailablePackageVersion 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-package-details-structure.json",
  "name": "PackageDetails",
  "description": "Basic information about a package.",
  "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."
        }
      ]
    },
    "PackageDescription": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageDescription"
        },
        {
          "description": "User-specified description of the package."
        }
      ]
    },
    "PackageStatus": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PackageStatus"
        },
        {
          "description": "Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED"
        }
      ]
    },
    "CreatedAt": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CreatedAt"
        },
        {
          "description": "Timestamp which tells creation date of the package."
        }
      ]
    },
    "LastUpdatedAt": {
      "$ref": "#/components/schemas/LastUpdated"
    },
    "AvailablePackageVersion": {
      "$ref": "#/components/schemas/PackageVersion"
    },
    "ErrorDetails": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ErrorDetails"
        },
        {
          "description": "Additional information if the package is in an error state. Null otherwise."
        }
      ]
    }
  }
}