PackageDetails
Basic information about a package.
Contents
- AvailablePackageVersion
-
The package version.
Type: String
Required: No
- AvailablePluginProperties
-
If the package is a
ZIP-PLUGINpackage, additional information about plugin properties.Type: PluginProperties object
Required: No
- CreatedAt
-
The timestamp when the package was created.
Type: Timestamp
Required: No
- EngineVersion
-
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
Type: String
Pattern:
^Elasticsearch_[0-9]{1}\.[0-9]{1,2}$|^OpenSearch_[0-9]{1,2}\.[0-9]{1,2}$Required: No
- ErrorDetails
-
Additional information if the package is in an error state. Null otherwise.
Type: ErrorDetails object
Required: No
- LastUpdatedAt
-
Date and time when the package was last updated.
Type: Timestamp
Required: No
- PackageDescription
-
User-specified description of the package.
Type: String
Length Constraints: Maximum length of 1024.
Required: No
- PackageID
-
The unique identifier of the package.
Type: String
Pattern:
^([FG][0-9]+)$Required: No
- PackageName
-
The user-specified name of the package.
Type: String
Length Constraints: Minimum length of 3. Maximum length of 256.
Pattern:
[a-z][a-z0-9\-]+Required: No
- PackageStatus
-
The current status of the package. The available options are
AVAILABLE,COPYING,COPY_FAILED,VALIDATNG,VALIDATION_FAILED,DELETING, andDELETE_FAILED.Type: String
Valid Values:
COPYING | COPY_FAILED | VALIDATING | VALIDATION_FAILED | AVAILABLE | DELETING | DELETED | DELETE_FAILEDRequired: No
- PackageType
-
The type of package.
Type: String
Valid Values:
TXT-DICTIONARY | ZIP-PLUGINRequired: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
