Class ListPackagesForDomainCommandProtected

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

Example

Use a bare-bones client and the command you need to make an API call.

import { OpenSearchClient, ListPackagesForDomainCommand } from "@aws-sdk/client-opensearch"; // ES Modules import
// const { OpenSearchClient, ListPackagesForDomainCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import
const client = new OpenSearchClient(config);
const input = { // ListPackagesForDomainRequest
  DomainName: "STRING_VALUE", // required
  MaxResults: Number("int"),
  NextToken: "STRING_VALUE",
};
const command = new ListPackagesForDomainCommand(input);
const response = await client.send(command);
// { // ListPackagesForDomainResponse
//   DomainPackageDetailsList: [ // DomainPackageDetailsList
//     { // DomainPackageDetails
//       PackageID: "STRING_VALUE",
//       PackageName: "STRING_VALUE",
//       PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN",
//       LastUpdated: new Date("TIMESTAMP"),
//       DomainName: "STRING_VALUE",
//       DomainPackageStatus: "ASSOCIATING" || "ASSOCIATION_FAILED" || "ACTIVE" || "DISSOCIATING" || "DISSOCIATION_FAILED",
//       PackageVersion: "STRING_VALUE",
//       ReferencePath: "STRING_VALUE",
//       ErrorDetails: { // ErrorDetails
//         ErrorType: "STRING_VALUE",
//         ErrorMessage: "STRING_VALUE",
//       },
//     },
//   ],
//   NextToken: "STRING_VALUE",
// };

Param

ListPackagesForDomainCommandInput

Returns

ListPackagesForDomainCommandOutput

See

• ListPackagesForDomainCommandInput for command's input shape.
• ListPackagesForDomainCommandOutput for command's response shape.
• config for OpenSearchClient's config shape.

Throws

AccessDeniedException (client fault)

An error occurred because you don't have permissions to access the resource.

Throws

BaseException (client fault)

An error occurred while processing the request.

Throws

InternalException (server fault)

Request processing failed because of an unknown error, exception, or internal failure.

Throws

ResourceNotFoundException (client fault)

An exception for accessing or deleting a resource that doesn't exist.

Throws

ValidationException (client fault)

An exception for accessing or deleting a resource that doesn't exist.

Throws

OpenSearchServiceException

Base exception class for all service exceptions from OpenSearch service.