Describes all packages available to OpenSearch Service¶

Description¶

Describes all packages available to OpenSearch Service. For more information, see Custom packages for Amazon OpenSearch Service.

Usage¶

opensearchservice_describe_packages(Filters, MaxResults, NextToken)

Arguments¶

Filters

Only returns packages that match the DescribePackagesFilterList values.
MaxResults

An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results.
NextToken

If your initial DescribePackageFilters operation returns a nextToken, you can include the returned nextToken in subsequent DescribePackageFilters operations, which returns results in the next page.

Value¶

A list with the following syntax:

list(
  PackageDetailsList = list(
    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
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$describe_packages(
  Filters = list(
    list(
      Name = "PackageID"|"PackageName"|"PackageStatus"|"PackageType"|"EngineVersion"|"PackageOwner",
      Value = list(
        "string"
      )
    )
  ),
  MaxResults = 123,
  NextToken = "string"
)