UNPKG

@aws-sdk/client-ssm

Version:

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

88 lines (87 loc) 4.3 kB
import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { GetMaintenanceWindowExecutionRequest, GetMaintenanceWindowExecutionResult } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link GetMaintenanceWindowExecutionCommand}. */ export interface GetMaintenanceWindowExecutionCommandInput extends GetMaintenanceWindowExecutionRequest { } /** * @public * * The output of {@link GetMaintenanceWindowExecutionCommand}. */ export interface GetMaintenanceWindowExecutionCommandOutput extends GetMaintenanceWindowExecutionResult, __MetadataBearer { } declare const GetMaintenanceWindowExecutionCommand_base: { new (input: GetMaintenanceWindowExecutionCommandInput): import("@smithy/core/client").CommandImpl<GetMaintenanceWindowExecutionCommandInput, GetMaintenanceWindowExecutionCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; new (input: GetMaintenanceWindowExecutionCommandInput): import("@smithy/core/client").CommandImpl<GetMaintenanceWindowExecutionCommandInput, GetMaintenanceWindowExecutionCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** * <p>Retrieves details about a specific a maintenance window execution.</p> * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, GetMaintenanceWindowExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, GetMaintenanceWindowExecutionCommand } = 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 = { // GetMaintenanceWindowExecutionRequest * WindowExecutionId: "STRING_VALUE", // required * }; * const command = new GetMaintenanceWindowExecutionCommand(input); * const response = await client.send(command); * // { // GetMaintenanceWindowExecutionResult * // WindowExecutionId: "STRING_VALUE", * // TaskIds: [ // MaintenanceWindowExecutionTaskIdList * // "STRING_VALUE", * // ], * // Status: "PENDING" || "IN_PROGRESS" || "SUCCESS" || "FAILED" || "TIMED_OUT" || "CANCELLING" || "CANCELLED" || "SKIPPED_OVERLAPPING", * // StatusDetails: "STRING_VALUE", * // StartTime: new Date("TIMESTAMP"), * // EndTime: new Date("TIMESTAMP"), * // }; * * ``` * * @param GetMaintenanceWindowExecutionCommandInput - {@link GetMaintenanceWindowExecutionCommandInput} * @returns {@link GetMaintenanceWindowExecutionCommandOutput} * @see {@link GetMaintenanceWindowExecutionCommandInput} for command's `input` shape. * @see {@link GetMaintenanceWindowExecutionCommandOutput} 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 GetMaintenanceWindowExecutionCommand extends GetMaintenanceWindowExecutionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: GetMaintenanceWindowExecutionRequest; output: GetMaintenanceWindowExecutionResult; }; sdk: { input: GetMaintenanceWindowExecutionCommandInput; output: GetMaintenanceWindowExecutionCommandOutput; }; }; }