OpenSearchService / Client / create_package
create_package#
- OpenSearchService.Client.create_package(**kwargs)#
Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.
See also: AWS API Documentation
Request Syntax
response = client.create_package( PackageName='string', PackageType='TXT-DICTIONARY'|'ZIP-PLUGIN', PackageDescription='string', PackageSource={ 'S3BucketName': 'string', 'S3Key': 'string' } )
- Parameters:
PackageName (string) –
[REQUIRED]
Unique name for the package.
PackageType (string) –
[REQUIRED]
The type of package.
PackageDescription (string) – Description of the package.
PackageSource (dict) –
[REQUIRED]
The Amazon S3 location from which to import the package.
S3BucketName (string) –
The name of the Amazon S3 bucket containing the package.
S3Key (string) –
Key (file name) of the package.
- Return type:
dict
- Returns:
Response Syntax
{ 'PackageDetails': { 'PackageID': 'string', 'PackageName': 'string', 'PackageType': 'TXT-DICTIONARY'|'ZIP-PLUGIN', 'PackageDescription': 'string', 'PackageStatus': 'COPYING'|'COPY_FAILED'|'VALIDATING'|'VALIDATION_FAILED'|'AVAILABLE'|'DELETING'|'DELETED'|'DELETE_FAILED', 'CreatedAt': datetime(2015, 1, 1), 'LastUpdatedAt': datetime(2015, 1, 1), 'AvailablePackageVersion': 'string', 'ErrorDetails': { 'ErrorType': 'string', 'ErrorMessage': 'string' }, 'EngineVersion': 'string', 'AvailablePluginProperties': { 'Name': 'string', 'Description': 'string', 'Version': 'string', 'ClassName': 'string', 'UncompressedSizeInBytes': 123 } } }
Response Structure
(dict) –
Container for the response returned by the
CreatePackage
operation.PackageDetails (dict) –
Basic information about an OpenSearch Service package.
PackageID (string) –
The unique identifier of the package.
PackageName (string) –
The user-specified name of the package.
PackageType (string) –
The type of package.
PackageDescription (string) –
User-specified description of the package.
PackageStatus (string) –
The current status of the package. The available options are
AVAILABLE
,COPYING
,COPY_FAILED
,VALIDATNG
,VALIDATION_FAILED
,DELETING
, andDELETE_FAILED
.CreatedAt (datetime) –
The timestamp when the package was created.
LastUpdatedAt (datetime) –
Date and time when the package was last updated.
AvailablePackageVersion (string) –
The package version.
ErrorDetails (dict) –
Additional information if the package is in an error state. Null otherwise.
ErrorType (string) –
The type of error that occurred.
ErrorMessage (string) –
A message describing the error.
EngineVersion (string) –
Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.
AvailablePluginProperties (dict) –
If the package is a
ZIP-PLUGIN
package, additional information about plugin properties.Name (string) –
The name of the plugin.
Description (string) –
The description of the plugin.
Version (string) –
The version of the plugin.
ClassName (string) –
The name of the class to load.
UncompressedSizeInBytes (integer) –
The uncompressed size of the plugin.
Exceptions