import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { StartExecutionPreviewRequest, StartExecutionPreviewResponse } from "../models/models_2"; import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StartExecutionPreviewCommand}. */ export interface StartExecutionPreviewCommandInput extends StartExecutionPreviewRequest { } /** * @public * * The output of {@link StartExecutionPreviewCommand}. */ export interface StartExecutionPreviewCommandOutput extends StartExecutionPreviewResponse, __MetadataBearer { } declare const StartExecutionPreviewCommand_base: { new (input: StartExecutionPreviewCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StartExecutionPreviewCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Initiates the process of creating a preview showing the effects that running a specified * Automation runbook would have on the targeted resources.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, StartExecutionPreviewCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, StartExecutionPreviewCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * const client = new SSMClient(config); * const input = { // StartExecutionPreviewRequest * DocumentName: "STRING_VALUE", // required * DocumentVersion: "STRING_VALUE", * ExecutionInputs: { // ExecutionInputs Union: only one key present * Automation: { // AutomationExecutionInputs * Parameters: { // AutomationParameterMap * "": [ // AutomationParameterValueList * "STRING_VALUE", * ], * }, * TargetParameterName: "STRING_VALUE", * Targets: [ // Targets * { // Target * Key: "STRING_VALUE", * Values: [ // TargetValues * "STRING_VALUE", * ], * }, * ], * TargetMaps: [ // TargetMaps * { // TargetMap * "": [ // TargetMapValueList * "STRING_VALUE", * ], * }, * ], * TargetLocations: [ // TargetLocations * { // TargetLocation * Accounts: [ // Accounts * "STRING_VALUE", * ], * Regions: [ // Regions * "STRING_VALUE", * ], * TargetLocationMaxConcurrency: "STRING_VALUE", * TargetLocationMaxErrors: "STRING_VALUE", * ExecutionRoleName: "STRING_VALUE", * TargetLocationAlarmConfiguration: { // AlarmConfiguration * IgnorePollAlarmFailure: true || false, * Alarms: [ // AlarmList // required * { // Alarm * Name: "STRING_VALUE", // required * }, * ], * }, * IncludeChildOrganizationUnits: true || false, * ExcludeAccounts: [ // ExcludeAccounts * "STRING_VALUE", * ], * Targets: [ * { * Key: "STRING_VALUE", * Values: [ * "STRING_VALUE", * ], * }, * ], * TargetsMaxConcurrency: "STRING_VALUE", * TargetsMaxErrors: "STRING_VALUE", * }, * ], * TargetLocationsURL: "STRING_VALUE", * }, * }, * }; * const command = new StartExecutionPreviewCommand(input); * const response = await client.send(command); * // { // StartExecutionPreviewResponse * // ExecutionPreviewId: "STRING_VALUE", * // }; * * ``` * * @param StartExecutionPreviewCommandInput - {@link StartExecutionPreviewCommandInput} * @returns {@link StartExecutionPreviewCommandOutput} * @see {@link StartExecutionPreviewCommandInput} for command's `input` shape. * @see {@link StartExecutionPreviewCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

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

The request isn't valid. Verify that you entered valid contents for the command and try * again.

* * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* * * @example StartExecutionPreview * ```javascript * // This example illustrates one usage of StartExecutionPreview * const input = { * DocumentName: "AWS-StartEC2Instance" * }; * const command = new StartExecutionPreviewCommand(input); * const response = await client.send(command); * /* response is * { * ExecutionPreviewId: "2f27d6e5-9676-4708-b8bd-aef0ab47bb26" * } * *\/ * ``` * * @public */ export declare class StartExecutionPreviewCommand extends StartExecutionPreviewCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartExecutionPreviewRequest; output: StartExecutionPreviewResponse; }; sdk: { input: StartExecutionPreviewCommandInput; output: StartExecutionPreviewCommandOutput; }; }; }