UNPKG

@aws-sdk/client-ssm

Version:

AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native

96 lines (95 loc) 4.11 kB
import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribePatchGroupsRequest, DescribePatchGroupsResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribePatchGroupsCommand}. */ export interface DescribePatchGroupsCommandInput extends DescribePatchGroupsRequest { } /** * @public * * The output of {@link DescribePatchGroupsCommand}. */ export interface DescribePatchGroupsCommandOutput extends DescribePatchGroupsResult, __MetadataBearer { } declare const DescribePatchGroupsCommand_base: { new (input: DescribePatchGroupsCommandInput): import("@smithy/core/client").CommandImpl<DescribePatchGroupsCommandInput, DescribePatchGroupsCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; new (...[input]: [] | [DescribePatchGroupsCommandInput]): import("@smithy/core/client").CommandImpl<DescribePatchGroupsCommandInput, DescribePatchGroupsCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** * <p>Lists all patch groups that have been registered with patch baselines.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, DescribePatchGroupsCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, DescribePatchGroupsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * // import type { SSMClientConfig } from "@aws-sdk/client-ssm"; * const config = {}; // type is SSMClientConfig * const client = new SSMClient(config); * const input = { // DescribePatchGroupsRequest * MaxResults: Number("int"), * Filters: [ // PatchOrchestratorFilterList * { // PatchOrchestratorFilter * Key: "STRING_VALUE", * Values: [ // PatchOrchestratorFilterValues * "STRING_VALUE", * ], * }, * ], * NextToken: "STRING_VALUE", * }; * const command = new DescribePatchGroupsCommand(input); * const response = await client.send(command); * // { // DescribePatchGroupsResult * // Mappings: [ // PatchGroupPatchBaselineMappingList * // { // PatchGroupPatchBaselineMapping * // PatchGroup: "STRING_VALUE", * // BaselineIdentity: { // PatchBaselineIdentity * // BaselineId: "STRING_VALUE", * // BaselineName: "STRING_VALUE", * // OperatingSystem: "WINDOWS" || "AMAZON_LINUX" || "AMAZON_LINUX_2" || "AMAZON_LINUX_2022" || "UBUNTU" || "REDHAT_ENTERPRISE_LINUX" || "SUSE" || "CENTOS" || "ORACLE_LINUX" || "DEBIAN" || "MACOS" || "RASPBIAN" || "ROCKY_LINUX" || "ALMA_LINUX" || "AMAZON_LINUX_2023", * // BaselineDescription: "STRING_VALUE", * // DefaultBaseline: true || false, * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribePatchGroupsCommandInput - {@link DescribePatchGroupsCommandInput} * @returns {@link DescribePatchGroupsCommandOutput} * @see {@link DescribePatchGroupsCommandInput} for command's `input` shape. * @see {@link DescribePatchGroupsCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link InternalServerError} (server fault) * <p>An error occurred on the server side.</p> * * @throws {@link SSMServiceException} * <p>Base exception class for all service exceptions from SSM service.</p> * * * @public */ export declare class DescribePatchGroupsCommand extends DescribePatchGroupsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribePatchGroupsRequest; output: DescribePatchGroupsResult; }; sdk: { input: DescribePatchGroupsCommandInput; output: DescribePatchGroupsCommandOutput; }; }; }