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

Initiates execution of an Automation runbook.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, StartAutomationExecutionCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, StartAutomationExecutionCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * const client = new SSMClient(config); * const input = { // StartAutomationExecutionRequest * DocumentName: "STRING_VALUE", // required * DocumentVersion: "STRING_VALUE", * Parameters: { // AutomationParameterMap * "": [ // AutomationParameterValueList * "STRING_VALUE", * ], * }, * ClientToken: "STRING_VALUE", * Mode: "Auto" || "Interactive", * TargetParameterName: "STRING_VALUE", * Targets: [ // Targets * { // Target * Key: "STRING_VALUE", * Values: [ // TargetValues * "STRING_VALUE", * ], * }, * ], * TargetMaps: [ // TargetMaps * { // TargetMap * "": [ // TargetMapValueList * "STRING_VALUE", * ], * }, * ], * MaxConcurrency: "STRING_VALUE", * MaxErrors: "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", * }, * ], * Tags: [ // TagList * { // Tag * Key: "STRING_VALUE", // required * Value: "STRING_VALUE", // required * }, * ], * AlarmConfiguration: { * IgnorePollAlarmFailure: true || false, * Alarms: [ // required * { * Name: "STRING_VALUE", // required * }, * ], * }, * TargetLocationsURL: "STRING_VALUE", * }; * const command = new StartAutomationExecutionCommand(input); * const response = await client.send(command); * // { // StartAutomationExecutionResult * // AutomationExecutionId: "STRING_VALUE", * // }; * * ``` * * @param StartAutomationExecutionCommandInput - {@link StartAutomationExecutionCommandInput} * @returns {@link StartAutomationExecutionCommandOutput} * @see {@link StartAutomationExecutionCommandInput} for command's `input` shape. * @see {@link StartAutomationExecutionCommandOutput} for command's `response` shape. * @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape. * * @throws {@link AutomationDefinitionNotFoundException} (client fault) *

An Automation runbook with the specified name couldn't be found.

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

An Automation runbook with the specified name and version couldn't be found.

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

The number of simultaneously running Automation executions exceeded the allowable * limit.

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

Error returned when an idempotent operation is retried and the parameters don't match the * original call to the API with the same idempotency token.

* * @throws {@link InternalServerError} (server fault) *

An error occurred on the server side.

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

The supplied parameters for invoking the specified Automation runbook are incorrect. For * example, they may not match the set of parameters permitted for the specified Automation * document.

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

The target isn't valid or doesn't exist. It might not be configured for Systems Manager or you might * not have permission to perform the operation.

* * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* * * @public */ export declare class StartAutomationExecutionCommand extends StartAutomationExecutionCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StartAutomationExecutionRequest; output: StartAutomationExecutionResult; }; sdk: { input: StartAutomationExecutionCommandInput; output: StartAutomationExecutionCommandOutput; }; }; }