Update Package

opensearchservice_update_package

R Documentation

Updates a package for use with Amazon OpenSearch Service domains

Description

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

Usage

opensearchservice_update_package(PackageID, PackageSource,
  PackageDescription, CommitMessage, PackageConfiguration,
  PackageEncryptionOptions)

Arguments

PackageID

[required] The unique identifier for the package.

PackageSource

[required] Amazon S3 bucket and key for the package.

PackageDescription

A new description of the package.

CommitMessage

Commit message for the updated file, which is shown as part of GetPackageVersionHistoryResponse.

PackageConfiguration

The updated configuration details for a package.

PackageEncryptionOptions

Encryption options for a package.

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$update_package(
  PackageID = "string",
  PackageSource = list(
    S3BucketName = "string",
    S3Key = "string"
  ),
  PackageDescription = "string",
  CommitMessage = "string",
  PackageConfiguration = list(
    LicenseRequirement = "REQUIRED"|"OPTIONAL"|"NONE",
    LicenseFilepath = "string",
    ConfigurationRequirement = "REQUIRED"|"OPTIONAL"|"NONE",
    RequiresRestartForConfigurationUpdate = TRUE|FALSE
  ),
  PackageEncryptionOptions = list(
    KmsKeyIdentifier = "string",
    EncryptionEnabled = TRUE|FALSE
  )
)