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)

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.

Value

A list with the following syntax:

list(
  PackageDetails = list(
    PackageID = "string",
    PackageName = "string",
    PackageType = "TXT-DICTIONARY"|"ZIP-PLUGIN",
    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
    )
  )
)

Request syntax

svc$create_package(
  PackageName = "string",
  PackageType = "TXT-DICTIONARY"|"ZIP-PLUGIN",
  PackageDescription = "string",
  PackageSource = list(
    S3BucketName = "string",
    S3Key = "string"
  )
)