import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribePackagesRequest, DescribePackagesResponse } from "../models/models_0"; import type { OpenSearchClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OpenSearchClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribePackagesCommand}. */ export interface DescribePackagesCommandInput extends DescribePackagesRequest { } /** * @public * * The output of {@link DescribePackagesCommand}. */ export interface DescribePackagesCommandOutput extends DescribePackagesResponse, __MetadataBearer { } declare const DescribePackagesCommand_base: { new (input: DescribePackagesCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribePackagesCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Describes all packages available to OpenSearch Service. 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. * ```javascript * import { OpenSearchClient, DescribePackagesCommand } from "@aws-sdk/client-opensearch"; // ES Modules import * // const { OpenSearchClient, DescribePackagesCommand } = require("@aws-sdk/client-opensearch"); // CommonJS import * // import type { OpenSearchClientConfig } from "@aws-sdk/client-opensearch"; * const config = {}; // type is OpenSearchClientConfig * const client = new OpenSearchClient(config); * const input = { // DescribePackagesRequest * Filters: [ // DescribePackagesFilterList * { // DescribePackagesFilter * Name: "PackageID" || "PackageName" || "PackageStatus" || "PackageType" || "EngineVersion" || "PackageOwner", * Value: [ // DescribePackagesFilterValues * "STRING_VALUE", * ], * }, * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new DescribePackagesCommand(input); * const response = await client.send(command); * // { // DescribePackagesResponse * // PackageDetailsList: [ // PackageDetailsList * // { // PackageDetails * // PackageID: "STRING_VALUE", * // PackageName: "STRING_VALUE", * // PackageType: "TXT-DICTIONARY" || "ZIP-PLUGIN" || "PACKAGE-LICENSE" || "PACKAGE-CONFIG", * // PackageDescription: "STRING_VALUE", * // PackageStatus: "COPYING" || "COPY_FAILED" || "VALIDATING" || "VALIDATION_FAILED" || "AVAILABLE" || "DELETING" || "DELETED" || "DELETE_FAILED", * // CreatedAt: new Date("TIMESTAMP"), * // LastUpdatedAt: new Date("TIMESTAMP"), * // AvailablePackageVersion: "STRING_VALUE", * // ErrorDetails: { // ErrorDetails * // ErrorType: "STRING_VALUE", * // ErrorMessage: "STRING_VALUE", * // }, * // EngineVersion: "STRING_VALUE", * // AvailablePluginProperties: { // PluginProperties * // Name: "STRING_VALUE", * // Description: "STRING_VALUE", * // Version: "STRING_VALUE", * // ClassName: "STRING_VALUE", * // UncompressedSizeInBytes: Number("long"), * // }, * // AvailablePackageConfiguration: { // PackageConfiguration * // LicenseRequirement: "REQUIRED" || "OPTIONAL" || "NONE", // required * // LicenseFilepath: "STRING_VALUE", * // ConfigurationRequirement: "REQUIRED" || "OPTIONAL" || "NONE", // required * // RequiresRestartForConfigurationUpdate: true || false, * // }, * // AllowListedUserList: [ // PackageUserList * // "STRING_VALUE", * // ], * // PackageOwner: "STRING_VALUE", * // PackageVendingOptions: { // PackageVendingOptions * // VendingEnabled: true || false, // required * // }, * // PackageEncryptionOptions: { // PackageEncryptionOptions * // KmsKeyIdentifier: "STRING_VALUE", * // EncryptionEnabled: true || false, // required * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribePackagesCommandInput - {@link DescribePackagesCommandInput} * @returns {@link DescribePackagesCommandOutput} * @see {@link DescribePackagesCommandInput} for command's `input` shape. * @see {@link DescribePackagesCommandOutput} for command's `response` shape. * @see {@link OpenSearchClientResolvedConfig | config} for OpenSearchClient's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

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

* * @throws {@link BaseException} (client fault) *

An error occurred while processing the request.

* * @throws {@link InternalException} (server fault) *

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

* * @throws {@link ResourceNotFoundException} (client fault) *

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

* * @throws {@link ValidationException} (client fault) *

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

* * @throws {@link OpenSearchServiceException} *

Base exception class for all service exceptions from OpenSearch service.

* * * @public */ export declare class DescribePackagesCommand extends DescribePackagesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribePackagesRequest; output: DescribePackagesResponse; }; sdk: { input: DescribePackagesCommandInput; output: DescribePackagesCommandOutput; }; }; }