UNPKG

@aws-sdk/client-ssm

Version:

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

83 lines (82 loc) 4.17 kB
import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CancelMaintenanceWindowExecutionRequest, CancelMaintenanceWindowExecutionResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CancelMaintenanceWindowExecutionCommand}. */ export interface CancelMaintenanceWindowExecutionCommandInput extends CancelMaintenanceWindowExecutionRequest { } /** * @public * * The output of {@link CancelMaintenanceWindowExecutionCommand}. */ export interface CancelMaintenanceWindowExecutionCommandOutput extends CancelMaintenanceWindowExecutionResult, __MetadataBearer { } declare const CancelMaintenanceWindowExecutionCommand_base: { new (input: CancelMaintenanceWindowExecutionCommandInput): import("@smithy/core/client").CommandImpl<CancelMaintenanceWindowExecutionCommandInput, CancelMaintenanceWindowExecutionCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; new (input: CancelMaintenanceWindowExecutionCommandInput): import("@smithy/core/client").CommandImpl<CancelMaintenanceWindowExecutionCommandInput, CancelMaintenanceWindowExecutionCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** * <p>Stops a maintenance window execution that is already in progress and cancels any tasks in * the window that haven't already starting running. Tasks already in progress will continue to * completion.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, CancelMaintenanceWindowExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, CancelMaintenanceWindowExecutionCommand } = 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 = { // CancelMaintenanceWindowExecutionRequest * WindowExecutionId: "STRING_VALUE", // required * }; * const command = new CancelMaintenanceWindowExecutionCommand(input); * const response = await client.send(command); * // { // CancelMaintenanceWindowExecutionResult * // WindowExecutionId: "STRING_VALUE", * // }; * * ``` * * @param CancelMaintenanceWindowExecutionCommandInput - {@link CancelMaintenanceWindowExecutionCommandInput} * @returns {@link CancelMaintenanceWindowExecutionCommandOutput} * @see {@link CancelMaintenanceWindowExecutionCommandInput} for command's `input` shape. * @see {@link CancelMaintenanceWindowExecutionCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link DoesNotExistException} (client fault) * <p>Error returned when the ID specified for a resource, such as a maintenance window or patch * baseline, doesn't exist.</p> * <p>For information about resource quotas in Amazon Web Services Systems Manager, see <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm">Systems Manager service quotas</a> in the * <i>Amazon Web Services General Reference</i>.</p> * * @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 CancelMaintenanceWindowExecutionCommand extends CancelMaintenanceWindowExecutionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CancelMaintenanceWindowExecutionRequest; output: CancelMaintenanceWindowExecutionResult; }; sdk: { input: CancelMaintenanceWindowExecutionCommandInput; output: CancelMaintenanceWindowExecutionCommandOutput; }; }; }