@aws-sdk/client-ssm
Version:
AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native
221 lines (220 loc) • 9.41 kB
TypeScript
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { DescribeAutomationExecutionsRequest, DescribeAutomationExecutionsResult } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
/**
* @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/core/client").CommandImpl<DescribeAutomationExecutionsCommandInput, DescribeAutomationExecutionsCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
new (...[input]: [] | [DescribeAutomationExecutionsCommandInput]): import("@smithy/core/client").CommandImpl<DescribeAutomationExecutionsCommandInput, DescribeAutomationExecutionsCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
* <p>Provides details about all active and terminated Automation executions.</p>
* @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
* // import type { SSMClientConfig } from "@aws-sdk/client-ssm";
* const config = {}; // type is SSMClientConfig
* 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
* // "<keys>": [ // AutomationParameterValueList
* // "STRING_VALUE",
* // ],
* // },
* // Mode: "Auto" || "Interactive",
* // ParentAutomationExecutionId: "STRING_VALUE",
* // CurrentStepName: "STRING_VALUE",
* // CurrentAction: "STRING_VALUE",
* // FailureMessage: "STRING_VALUE",
* // WarningMessage: "STRING_VALUE",
* // TargetParameterName: "STRING_VALUE",
* // Targets: [ // Targets
* // { // Target
* // Key: "STRING_VALUE",
* // Values: [ // TargetValues
* // "STRING_VALUE",
* // ],
* // },
* // ],
* // TargetMaps: [ // TargetMaps
* // { // TargetMap
* // "<keys>": [ // 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: {
* // "<keys>": [
* // "STRING_VALUE",
* // ],
* // },
* // TargetParameterName: "STRING_VALUE",
* // Targets: [
* // {
* // Key: "STRING_VALUE",
* // Values: [
* // "STRING_VALUE",
* // ],
* // },
* // ],
* // TargetMaps: [
* // {
* // "<keys>": [
* // "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: [ // AutomationTargets
* // "<Target>",
* // ],
* // 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)
* <p>An error occurred on the server side.</p>
*
* @throws {@link InvalidFilterKey} (client fault)
* <p>The specified key isn't valid.</p>
*
* @throws {@link InvalidFilterValue} (client fault)
* <p>The filter value isn't valid. Verify the value and try again.</p>
*
* @throws {@link InvalidNextToken} (client fault)
* <p>The specified token isn't valid.</p>
*
* @throws {@link SSMServiceException}
* <p>Base exception class for all service exceptions from SSM service.</p>
*
*
* @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;
};
};
}