import { Command as $Command } from "@smithy/smithy-client"; import { MetadataBearer as __MetadataBearer } from "@smithy/types"; import { DescribeAutomationExecutionsRequest, DescribeAutomationExecutionsResult } from "../models/models_0"; import { ServiceInputTypes, ServiceOutputTypes, SSMClientResolvedConfig } from "../SSMClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeAutomationExecutionsCommand}. */ export interface DescribeAutomationExecutionsCommandInput extends DescribeAutomationExecutionsRequest { } /** * @public * * The output of {@link DescribeAutomationExecutionsCommand}. */ export interface DescribeAutomationExecutionsCommandOutput extends DescribeAutomationExecutionsResult, __MetadataBearer { } declare const DescribeAutomationExecutionsCommand_base: { new (input: DescribeAutomationExecutionsCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeAutomationExecutionsCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Provides details about all active and terminated Automation executions.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { SSMClient, DescribeAutomationExecutionsCommand } from "@aws-sdk/client-ssm"; // ES Modules import * // const { SSMClient, DescribeAutomationExecutionsCommand } = require("@aws-sdk/client-ssm"); // CommonJS import * const client = new SSMClient(config); * const input = { // DescribeAutomationExecutionsRequest * Filters: [ // AutomationExecutionFilterList * { // AutomationExecutionFilter * Key: "DocumentNamePrefix" || "ExecutionStatus" || "ExecutionId" || "ParentExecutionId" || "CurrentAction" || "StartTimeBefore" || "StartTimeAfter" || "AutomationType" || "TagKey" || "TargetResourceGroup" || "AutomationSubtype" || "OpsItemId", // required * Values: [ // AutomationExecutionFilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new DescribeAutomationExecutionsCommand(input); * const response = await client.send(command); * // { // DescribeAutomationExecutionsResult * // AutomationExecutionMetadataList: [ // AutomationExecutionMetadataList * // { // AutomationExecutionMetadata * // AutomationExecutionId: "STRING_VALUE", * // DocumentName: "STRING_VALUE", * // DocumentVersion: "STRING_VALUE", * // AutomationExecutionStatus: "Pending" || "InProgress" || "Waiting" || "Success" || "TimedOut" || "Cancelling" || "Cancelled" || "Failed" || "PendingApproval" || "Approved" || "Rejected" || "Scheduled" || "RunbookInProgress" || "PendingChangeCalendarOverride" || "ChangeCalendarOverrideApproved" || "ChangeCalendarOverrideRejected" || "CompletedWithSuccess" || "CompletedWithFailure" || "Exited", * // ExecutionStartTime: new Date("TIMESTAMP"), * // ExecutionEndTime: new Date("TIMESTAMP"), * // ExecutedBy: "STRING_VALUE", * // LogFile: "STRING_VALUE", * // Outputs: { // AutomationParameterMap * // "": [ // AutomationParameterValueList * // "STRING_VALUE", * // ], * // }, * // Mode: "Auto" || "Interactive", * // ParentAutomationExecutionId: "STRING_VALUE", * // CurrentStepName: "STRING_VALUE", * // CurrentAction: "STRING_VALUE", * // FailureMessage: "STRING_VALUE", * // TargetParameterName: "STRING_VALUE", * // Targets: [ // Targets * // { // Target * // Key: "STRING_VALUE", * // Values: [ // TargetValues * // "STRING_VALUE", * // ], * // }, * // ], * // TargetMaps: [ // TargetMaps * // { // TargetMap * // "": [ // TargetMapValueList * // "STRING_VALUE", * // ], * // }, * // ], * // ResolvedTargets: { // ResolvedTargets * // ParameterValues: [ // TargetParameterList * // "STRING_VALUE", * // ], * // Truncated: true || false, * // }, * // MaxConcurrency: "STRING_VALUE", * // MaxErrors: "STRING_VALUE", * // Target: "STRING_VALUE", * // AutomationType: "CrossAccount" || "Local", * // AlarmConfiguration: { // AlarmConfiguration * // IgnorePollAlarmFailure: true || false, * // Alarms: [ // AlarmList // required * // { // Alarm * // Name: "STRING_VALUE", // required * // }, * // ], * // }, * // TriggeredAlarms: [ // AlarmStateInformationList * // { // AlarmStateInformation * // Name: "STRING_VALUE", // required * // State: "UNKNOWN" || "ALARM", // required * // }, * // ], * // TargetLocationsURL: "STRING_VALUE", * // AutomationSubtype: "ChangeRequest" || "AccessRequest", * // ScheduledTime: new Date("TIMESTAMP"), * // Runbooks: [ // Runbooks * // { // Runbook * // DocumentName: "STRING_VALUE", // required * // DocumentVersion: "STRING_VALUE", * // Parameters: { * // "": [ * // "STRING_VALUE", * // ], * // }, * // TargetParameterName: "STRING_VALUE", * // Targets: [ * // { * // Key: "STRING_VALUE", * // Values: [ * // "STRING_VALUE", * // ], * // }, * // ], * // TargetMaps: [ * // { * // "": [ * // "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: { * // IgnorePollAlarmFailure: true || false, * // Alarms: [ // required * // { * // Name: "STRING_VALUE", // required * // }, * // ], * // }, * // IncludeChildOrganizationUnits: true || false, * // ExcludeAccounts: [ // ExcludeAccounts * // "STRING_VALUE", * // ], * // Targets: "", * // TargetsMaxConcurrency: "STRING_VALUE", * // TargetsMaxErrors: "STRING_VALUE", * // }, * // ], * // }, * // ], * // OpsItemId: "STRING_VALUE", * // AssociationId: "STRING_VALUE", * // ChangeRequestName: "STRING_VALUE", * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeAutomationExecutionsCommandInput - {@link DescribeAutomationExecutionsCommandInput} * @returns {@link DescribeAutomationExecutionsCommandOutput} * @see {@link DescribeAutomationExecutionsCommandInput} for command's `input` shape. * @see {@link DescribeAutomationExecutionsCommandOutput} 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 InvalidFilterKey} (client fault) *

The specified key isn't valid.

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

The filter value isn't valid. Verify the value and try again.

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

The specified token isn't valid.

* * @throws {@link SSMServiceException} *

Base exception class for all service exceptions from SSM service.

* * * @public */ export declare class DescribeAutomationExecutionsCommand extends DescribeAutomationExecutionsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeAutomationExecutionsRequest; output: DescribeAutomationExecutionsResult; }; sdk: { input: DescribeAutomationExecutionsCommandInput; output: DescribeAutomationExecutionsCommandOutput; }; }; }