Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Interface PackageDetails

Basic information about a package.

Hierarchy

  • PackageDetails

Properties

AvailablePackageVersion? AvailablePluginProperties? CreatedAt? EngineVersion? ErrorDetails? LastUpdatedAt? PackageDescription? PackageID? PackageName? PackageStatus? PackageType?

Properties

Optional AvailablePackageVersion

AvailablePackageVersion?: string

The package version.

Optional AvailablePluginProperties

AvailablePluginProperties?: PluginProperties

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

Optional CreatedAt

CreatedAt?: Date

The timestamp when the package was created.

Optional EngineVersion

EngineVersion?: string

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Optional ErrorDetails

ErrorDetails?: ErrorDetails

Additional information if the package is in an error state. Null otherwise.

Optional LastUpdatedAt

LastUpdatedAt?: Date

Date and time when the package was last updated.

Optional PackageDescription

PackageDescription?: string

User-specified description of the package.

Optional PackageID

PackageID?: string

The unique identifier of the package.

Optional PackageName

PackageName?: string

The user-specified name of the package.

Optional PackageStatus

PackageStatus?: PackageStatus

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

Optional PackageType

PackageType?: PackageType

The type of package.

Settings

Member Visibility

Theme