List Packages For Domain

opensearchservice_list_packages_for_domain

R Documentation

Lists all packages associated with an Amazon OpenSearch Service domain

Description

Lists all packages associated with an Amazon OpenSearch Service domain. For more information, see Custom packages for Amazon OpenSearch Service.

Usage

opensearchservice_list_packages_for_domain(DomainName, MaxResults,
  NextToken)

Arguments

DomainName

[required] The name of the domain for which you want to list associated packages.

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 list_packages_for_domain operation returns a nextToken, you can include the returned nextToken in subsequent list_packages_for_domain operations, which returns results in the next page.

Value

A list with the following syntax:

list(
  DomainPackageDetailsList = list(
    list(
      PackageID = "string",
      PackageName = "string",
      PackageType = "TXT-DICTIONARY"|"ZIP-PLUGIN",
      LastUpdated = as.POSIXct(
        "2015-01-01"
      ),
      DomainName = "string",
      DomainPackageStatus = "ASSOCIATING"|"ASSOCIATION_FAILED"|"ACTIVE"|"DISSOCIATING"|"DISSOCIATION_FAILED",
      PackageVersion = "string",
      ReferencePath = "string",
      ErrorDetails = list(
        ErrorType = "string",
        ErrorMessage = "string"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_packages_for_domain(
  DomainName = "string",
  MaxResults = 123,
  NextToken = "string"
)