Skip to content

Create Package

opensearchservice_create_package R Documentation

Creates a package for use with Amazon OpenSearch Service domains

Description

Creates a package for use with Amazon OpenSearch Service domains. For more information, see Custom packages for Amazon OpenSearch Service.

Usage

opensearchservice_create_package(PackageName, PackageType,
  PackageDescription, PackageSource, PackageConfiguration, EngineVersion,
  PackageVendingOptions, PackageEncryptionOptions)

Arguments

PackageName

[required] Unique name for the package.

PackageType

[required] The type of package.

PackageDescription

Description of the package.

PackageSource

[required] The Amazon S3 location from which to import the package.

PackageConfiguration

The configuration parameters for the package being created.

EngineVersion

The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN

PackageVendingOptions

The vending options for the package being created. They determine if the package can be vended to other users.

PackageEncryptionOptions

The encryption parameters for the package being created.

Value

A list with the following syntax: 

list(
  PackageDetails = list(
    PackageID = "string",
    PackageName = "string",
    PackageType = "TXT-DICTIONARY"|"ZIP-PLUGIN"|"PACKAGE-LICENSE"|"PACKAGE-CONFIG",
    PackageDescription = "string",
    PackageStatus = "COPYING"|"COPY_FAILED"|"VALIDATING"|"VALIDATION_FAILED"|"AVAILABLE"|"DELETING"|"DELETED"|"DELETE_FAILED",
    CreatedAt = as.POSIXct(
      "2015-01-01"
    ),
    LastUpdatedAt = as.POSIXct(
      "2015-01-01"
    ),
    AvailablePackageVersion = "string",
    ErrorDetails = list(
      ErrorType = "string",
      ErrorMessage = "string"
    ),
    EngineVersion = "string",
    AvailablePluginProperties = list(
      Name = "string",
      Description = "string",
      Version = "string",
      ClassName = "string",
      UncompressedSizeInBytes = 123
    ),
    AvailablePackageConfiguration = list(
      LicenseRequirement = "REQUIRED"|"OPTIONAL"|"NONE",
      LicenseFilepath = "string",
      ConfigurationRequirement = "REQUIRED"|"OPTIONAL"|"NONE",
      RequiresRestartForConfigurationUpdate = TRUE|FALSE
    ),
    AllowListedUserList = list(
      "string"
    ),
    PackageOwner = "string",
    PackageVendingOptions = list(
      VendingEnabled = TRUE|FALSE
    ),
    PackageEncryptionOptions = list(
      KmsKeyIdentifier = "string",
      EncryptionEnabled = TRUE|FALSE
    )
  )
)

Request syntax

svc$create_package(
  PackageName = "string",
  PackageType = "TXT-DICTIONARY"|"ZIP-PLUGIN"|"PACKAGE-LICENSE"|"PACKAGE-CONFIG",
  PackageDescription = "string",
  PackageSource = list(
    S3BucketName = "string",
    S3Key = "string"
  ),
  PackageConfiguration = list(
    LicenseRequirement = "REQUIRED"|"OPTIONAL"|"NONE",
    LicenseFilepath = "string",
    ConfigurationRequirement = "REQUIRED"|"OPTIONAL"|"NONE",
    RequiresRestartForConfigurationUpdate = TRUE|FALSE
  ),
  EngineVersion = "string",
  PackageVendingOptions = list(
    VendingEnabled = TRUE|FALSE
  ),
  PackageEncryptionOptions = list(
    KmsKeyIdentifier = "string",
    EncryptionEnabled = TRUE|FALSE
  )
)