Associate Package

opensearchservice_associate_package

R Documentation

Associates a package with an Amazon OpenSearch Service domain¶

Description¶

Associates a package with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Usage¶

opensearchservice_associate_package(PackageID, DomainName,
  PrerequisitePackageIDList, AssociationConfiguration)

Arguments¶

PackageID

[required] Internal ID of the package to associate with a domain. Use describe_packages to find this value.

DomainName

[required] Name of the domain to associate the package with.

PrerequisitePackageIDList

A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

AssociationConfiguration

The configuration for associating a package with an Amazon OpenSearch Service domain.

Value¶

A list with the following syntax:

list(
  DomainPackageDetails = list(
    PackageID = "string",
    PackageName = "string",
    PackageType = "TXT-DICTIONARY"|"ZIP-PLUGIN"|"PACKAGE-LICENSE"|"PACKAGE-CONFIG",
    LastUpdated = as.POSIXct(
      "2015-01-01"
    ),
    DomainName = "string",
    DomainPackageStatus = "ASSOCIATING"|"ASSOCIATION_FAILED"|"ACTIVE"|"DISSOCIATING"|"DISSOCIATION_FAILED",
    PackageVersion = "string",
    PrerequisitePackageIDList = list(
      "string"
    ),
    ReferencePath = "string",
    ErrorDetails = list(
      ErrorType = "string",
      ErrorMessage = "string"
    ),
    AssociationConfiguration = list(
      KeyStoreAccessOption = list(
        KeyAccessRoleArn = "string",
        KeyStoreAccessEnabled = TRUE|FALSE
      )
    )
  )
)

Request syntax¶

svc$associate_package(
  PackageID = "string",
  DomainName = "string",
  PrerequisitePackageIDList = list(
    "string"
  ),
  AssociationConfiguration = list(
    KeyStoreAccessOption = list(
      KeyAccessRoleArn = "string",
      KeyStoreAccessEnabled = TRUE|FALSE
    )
  )
)