@aws-sdk/client-ssm
Version:
AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native
150 lines (149 loc) • 8.05 kB
TypeScript
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { GetDeployablePatchSnapshotForInstanceRequest, GetDeployablePatchSnapshotForInstanceResult } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
/**
* @public
*
* The input for {@link GetDeployablePatchSnapshotForInstanceCommand}.
*/
export interface GetDeployablePatchSnapshotForInstanceCommandInput extends GetDeployablePatchSnapshotForInstanceRequest {
}
/**
* @public
*
* The output of {@link GetDeployablePatchSnapshotForInstanceCommand}.
*/
export interface GetDeployablePatchSnapshotForInstanceCommandOutput extends GetDeployablePatchSnapshotForInstanceResult, __MetadataBearer {
}
declare const GetDeployablePatchSnapshotForInstanceCommand_base: {
new (input: GetDeployablePatchSnapshotForInstanceCommandInput): import("@smithy/core/client").CommandImpl<GetDeployablePatchSnapshotForInstanceCommandInput, GetDeployablePatchSnapshotForInstanceCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
new (input: GetDeployablePatchSnapshotForInstanceCommandInput): import("@smithy/core/client").CommandImpl<GetDeployablePatchSnapshotForInstanceCommandInput, GetDeployablePatchSnapshotForInstanceCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
* <p>Retrieves the current snapshot for the patch baseline the managed node uses. This API is
* primarily used by the <code>AWS-RunPatchBaseline</code> Systems Manager document (SSM document).</p>
* <note>
* <p>If you run the command locally, such as with the Command Line Interface (CLI), the system attempts to use your local Amazon Web Services credentials and the operation fails. To avoid
* this, you can run the command in the Amazon Web Services Systems Manager console. Use Run Command, a tool in Amazon Web Services Systems Manager,
* with an SSM document that enables you to target a managed node with a script or command. For
* example, run the command using the <code>AWS-RunShellScript</code> document or the
* <code>AWS-RunPowerShellScript</code> document.</p>
* </note>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SSMClient, GetDeployablePatchSnapshotForInstanceCommand } from "@aws-sdk/client-ssm"; // ES Modules import
* // const { SSMClient, GetDeployablePatchSnapshotForInstanceCommand } = 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 = { // GetDeployablePatchSnapshotForInstanceRequest
* InstanceId: "STRING_VALUE", // required
* SnapshotId: "STRING_VALUE", // required
* BaselineOverride: { // BaselineOverride
* 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",
* GlobalFilters: { // PatchFilterGroup
* PatchFilters: [ // PatchFilterList // required
* { // PatchFilter
* Key: "ARCH" || "ADVISORY_ID" || "BUGZILLA_ID" || "PATCH_SET" || "PRODUCT" || "PRODUCT_FAMILY" || "CLASSIFICATION" || "CVE_ID" || "EPOCH" || "MSRC_SEVERITY" || "NAME" || "PATCH_ID" || "SECTION" || "PRIORITY" || "REPOSITORY" || "RELEASE" || "SEVERITY" || "SECURITY" || "VERSION", // required
* Values: [ // PatchFilterValueList // required
* "STRING_VALUE",
* ],
* },
* ],
* },
* ApprovalRules: { // PatchRuleGroup
* PatchRules: [ // PatchRuleList // required
* { // PatchRule
* PatchFilterGroup: {
* PatchFilters: [ // required
* {
* Key: "ARCH" || "ADVISORY_ID" || "BUGZILLA_ID" || "PATCH_SET" || "PRODUCT" || "PRODUCT_FAMILY" || "CLASSIFICATION" || "CVE_ID" || "EPOCH" || "MSRC_SEVERITY" || "NAME" || "PATCH_ID" || "SECTION" || "PRIORITY" || "REPOSITORY" || "RELEASE" || "SEVERITY" || "SECURITY" || "VERSION", // required
* Values: [ // required
* "STRING_VALUE",
* ],
* },
* ],
* },
* ComplianceLevel: "CRITICAL" || "HIGH" || "MEDIUM" || "LOW" || "INFORMATIONAL" || "UNSPECIFIED",
* ApproveAfterDays: Number("int"),
* ApproveUntilDate: "STRING_VALUE",
* EnableNonSecurity: true || false,
* },
* ],
* },
* ApprovedPatches: [ // PatchIdList
* "STRING_VALUE",
* ],
* ApprovedPatchesComplianceLevel: "CRITICAL" || "HIGH" || "MEDIUM" || "LOW" || "INFORMATIONAL" || "UNSPECIFIED",
* RejectedPatches: [
* "STRING_VALUE",
* ],
* RejectedPatchesAction: "ALLOW_AS_DEPENDENCY" || "BLOCK",
* ApprovedPatchesEnableNonSecurity: true || false,
* Sources: [ // PatchSourceList
* { // PatchSource
* Name: "STRING_VALUE", // required
* Products: [ // PatchSourceProductList // required
* "STRING_VALUE",
* ],
* Configuration: "STRING_VALUE", // required
* },
* ],
* AvailableSecurityUpdatesComplianceStatus: "COMPLIANT" || "NON_COMPLIANT",
* },
* UseS3DualStackEndpoint: true || false,
* };
* const command = new GetDeployablePatchSnapshotForInstanceCommand(input);
* const response = await client.send(command);
* // { // GetDeployablePatchSnapshotForInstanceResult
* // InstanceId: "STRING_VALUE",
* // SnapshotId: "STRING_VALUE",
* // SnapshotDownloadUrl: "STRING_VALUE",
* // Product: "STRING_VALUE",
* // };
*
* ```
*
* @param GetDeployablePatchSnapshotForInstanceCommandInput - {@link GetDeployablePatchSnapshotForInstanceCommandInput}
* @returns {@link GetDeployablePatchSnapshotForInstanceCommandOutput}
* @see {@link GetDeployablePatchSnapshotForInstanceCommandInput} for command's `input` shape.
* @see {@link GetDeployablePatchSnapshotForInstanceCommandOutput} 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 UnsupportedFeatureRequiredException} (client fault)
* <p>Patching for applications released by Microsoft is only available on EC2 instances and
* advanced instances. To patch applications released by Microsoft on on-premises servers and VMs,
* you must enable advanced instances. For more information, see <a href="https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-managedinstances-advanced.html">Turning on
* the advanced-instances tier</a> in the <i>Amazon Web Services Systems Manager User Guide</i>.</p>
*
* @throws {@link UnsupportedOperatingSystem} (client fault)
* <p>The operating systems you specified isn't supported, or the operation isn't supported for
* the operating system.</p>
*
* @throws {@link SSMServiceException}
* <p>Base exception class for all service exceptions from SSM service.</p>
*
*
* @public
*/
export declare class GetDeployablePatchSnapshotForInstanceCommand extends GetDeployablePatchSnapshotForInstanceCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: GetDeployablePatchSnapshotForInstanceRequest;
output: GetDeployablePatchSnapshotForInstanceResult;
};
sdk: {
input: GetDeployablePatchSnapshotForInstanceCommandInput;
output: GetDeployablePatchSnapshotForInstanceCommandOutput;
};
};
}