Lists all Amazon OpenSearch Service domains associated with a given package¶

Description¶

Lists all Amazon OpenSearch Service domains associated with a given package. For more information, see Custom packages for Amazon OpenSearch Service.

Usage¶

opensearchservice_list_domains_for_package(PackageID, MaxResults,
  NextToken)

Arguments¶

PackageID

[required] The unique identifier of the package for which to list associated domains.
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_domains_for_package operation returns a nextToken, you can include the returned nextToken in subsequent list_domains_for_package 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"|"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
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_domains_for_package(
  PackageID = "string",
  MaxResults = 123,
  NextToken = "string"
)