@aws-sdk/client-ssm/dist-types/commands/GetExecutionPreviewCommand.d.ts

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

import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { GetExecutionPreviewRequest, GetExecutionPreviewResponse } from "../models/models_0";
/**
 * @public
 */
export type { __MetadataBearer };
/**
 * @public
 *
 * The input for {@link GetExecutionPreviewCommand}.
 */
export interface GetExecutionPreviewCommandInput extends GetExecutionPreviewRequest {
}
/**
 * @public
 *
 * The output of {@link GetExecutionPreviewCommand}.
 */
export interface GetExecutionPreviewCommandOutput extends GetExecutionPreviewResponse, __MetadataBearer {
}
declare const GetExecutionPreviewCommand_base: {
    new (input: GetExecutionPreviewCommandInput): import("@smithy/core/client").CommandImpl<GetExecutionPreviewCommandInput, GetExecutionPreviewCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
    new (input: GetExecutionPreviewCommandInput): import("@smithy/core/client").CommandImpl<GetExecutionPreviewCommandInput, GetExecutionPreviewCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
    getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
 * <p>Initiates the process of retrieving an existing preview that shows the effects that running
 *    a specified Automation runbook would have on the targeted resources.</p>
 * @example
 * Use a bare-bones client and the command you need to make an API call.
 * ```javascript
 * import { SSMClient, GetExecutionPreviewCommand } from "@aws-sdk/client-ssm"; // ES Modules import
 * // const { SSMClient, GetExecutionPreviewCommand } = 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 = { // GetExecutionPreviewRequest
 *   ExecutionPreviewId: "STRING_VALUE", // required
 * };
 * const command = new GetExecutionPreviewCommand(input);
 * const response = await client.send(command);
 * // { // GetExecutionPreviewResponse
 * //   ExecutionPreviewId: "STRING_VALUE",
 * //   EndedAt: new Date("TIMESTAMP"),
 * //   Status: "Pending" || "InProgress" || "Success" || "Failed",
 * //   StatusMessage: "STRING_VALUE",
 * //   ExecutionPreview: { // ExecutionPreview Union: only one key present
 * //     Automation: { // AutomationExecutionPreview
 * //       StepPreviews: { // StepPreviewMap
 * //         "<keys>": Number("int"),
 * //       },
 * //       Regions: [ // RegionList
 * //         "STRING_VALUE",
 * //       ],
 * //       TargetPreviews: [ // TargetPreviewList
 * //         { // TargetPreview
 * //           Count: Number("int"),
 * //           TargetType: "STRING_VALUE",
 * //         },
 * //       ],
 * //       TotalAccounts: Number("int"),
 * //     },
 * //   },
 * // };
 *
 * ```
 *
 * @param GetExecutionPreviewCommandInput - {@link GetExecutionPreviewCommandInput}
 * @returns {@link GetExecutionPreviewCommandOutput}
 * @see {@link GetExecutionPreviewCommandInput} for command's `input` shape.
 * @see {@link GetExecutionPreviewCommandOutput} 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 ResourceNotFoundException} (client fault)
 *  <p>The specified parameter to be shared could not be found.</p>
 *
 * @throws {@link SSMServiceException}
 * <p>Base exception class for all service exceptions from SSM service.</p>
 *
 *
 * @public
 */
export declare class GetExecutionPreviewCommand extends GetExecutionPreviewCommand_base {
    /** @internal type navigation helper, not in runtime. */
    protected static __types: {
        api: {
            input: GetExecutionPreviewRequest;
            output: GetExecutionPreviewResponse;
        };
        sdk: {
            input: GetExecutionPreviewCommandInput;
            output: GetExecutionPreviewCommandOutput;
        };
    };
}