@aws-sdk/client-ssm
Version:
AWS SDK for JavaScript Ssm Client for Node.js, Browser and React Native
117 lines (116 loc) • 5.72 kB
TypeScript
import type { MetadataBearer as __MetadataBearer } from "@smithy/types";
import type { DescribeMaintenanceWindowExecutionTasksRequest, DescribeMaintenanceWindowExecutionTasksResult } from "../models/models_0";
/**
* @public
*/
export type { __MetadataBearer };
/**
* @public
*
* The input for {@link DescribeMaintenanceWindowExecutionTasksCommand}.
*/
export interface DescribeMaintenanceWindowExecutionTasksCommandInput extends DescribeMaintenanceWindowExecutionTasksRequest {
}
/**
* @public
*
* The output of {@link DescribeMaintenanceWindowExecutionTasksCommand}.
*/
export interface DescribeMaintenanceWindowExecutionTasksCommandOutput extends DescribeMaintenanceWindowExecutionTasksResult, __MetadataBearer {
}
declare const DescribeMaintenanceWindowExecutionTasksCommand_base: {
new (input: DescribeMaintenanceWindowExecutionTasksCommandInput): import("@smithy/core/client").CommandImpl<DescribeMaintenanceWindowExecutionTasksCommandInput, DescribeMaintenanceWindowExecutionTasksCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
new (input: DescribeMaintenanceWindowExecutionTasksCommandInput): import("@smithy/core/client").CommandImpl<DescribeMaintenanceWindowExecutionTasksCommandInput, DescribeMaintenanceWindowExecutionTasksCommandOutput, import("..").SSMClientResolvedConfig, import("..").ServiceInputTypes, import("..").ServiceOutputTypes>;
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
};
/**
* <p>For a given maintenance window execution, lists the tasks that were run.</p>
* @example
* Use a bare-bones client and the command you need to make an API call.
* ```javascript
* import { SSMClient, DescribeMaintenanceWindowExecutionTasksCommand } from "@aws-sdk/client-ssm"; // ES Modules import
* // const { SSMClient, DescribeMaintenanceWindowExecutionTasksCommand } = 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 = { // DescribeMaintenanceWindowExecutionTasksRequest
* WindowExecutionId: "STRING_VALUE", // required
* Filters: [ // MaintenanceWindowFilterList
* { // MaintenanceWindowFilter
* Key: "STRING_VALUE",
* Values: [ // MaintenanceWindowFilterValues
* "STRING_VALUE",
* ],
* },
* ],
* MaxResults: Number("int"),
* NextToken: "STRING_VALUE",
* };
* const command = new DescribeMaintenanceWindowExecutionTasksCommand(input);
* const response = await client.send(command);
* // { // DescribeMaintenanceWindowExecutionTasksResult
* // WindowExecutionTaskIdentities: [ // MaintenanceWindowExecutionTaskIdentityList
* // { // MaintenanceWindowExecutionTaskIdentity
* // WindowExecutionId: "STRING_VALUE",
* // TaskExecutionId: "STRING_VALUE",
* // Status: "PENDING" || "IN_PROGRESS" || "SUCCESS" || "FAILED" || "TIMED_OUT" || "CANCELLING" || "CANCELLED" || "SKIPPED_OVERLAPPING",
* // StatusDetails: "STRING_VALUE",
* // StartTime: new Date("TIMESTAMP"),
* // EndTime: new Date("TIMESTAMP"),
* // TaskArn: "STRING_VALUE",
* // TaskType: "RUN_COMMAND" || "AUTOMATION" || "STEP_FUNCTIONS" || "LAMBDA",
* // AlarmConfiguration: { // AlarmConfiguration
* // IgnorePollAlarmFailure: true || false,
* // Alarms: [ // AlarmList // required
* // { // Alarm
* // Name: "STRING_VALUE", // required
* // },
* // ],
* // },
* // TriggeredAlarms: [ // AlarmStateInformationList
* // { // AlarmStateInformation
* // Name: "STRING_VALUE", // required
* // State: "UNKNOWN" || "ALARM", // required
* // },
* // ],
* // },
* // ],
* // NextToken: "STRING_VALUE",
* // };
*
* ```
*
* @param DescribeMaintenanceWindowExecutionTasksCommandInput - {@link DescribeMaintenanceWindowExecutionTasksCommandInput}
* @returns {@link DescribeMaintenanceWindowExecutionTasksCommandOutput}
* @see {@link DescribeMaintenanceWindowExecutionTasksCommandInput} for command's `input` shape.
* @see {@link DescribeMaintenanceWindowExecutionTasksCommandOutput} for command's `response` shape.
* @see {@link SSMClientResolvedConfig | config} for SSMClient's `config` shape.
*
* @throws {@link DoesNotExistException} (client fault)
* <p>Error returned when the ID specified for a resource, such as a maintenance window or patch
* baseline, doesn't exist.</p>
* <p>For information about resource quotas in Amazon Web Services Systems Manager, see <a href="https://docs.aws.amazon.com/general/latest/gr/ssm.html#limits_ssm">Systems Manager service quotas</a> in the
* <i>Amazon Web Services General Reference</i>.</p>
*
* @throws {@link InternalServerError} (server fault)
* <p>An error occurred on the server side.</p>
*
* @throws {@link SSMServiceException}
* <p>Base exception class for all service exceptions from SSM service.</p>
*
*
* @public
*/
export declare class DescribeMaintenanceWindowExecutionTasksCommand extends DescribeMaintenanceWindowExecutionTasksCommand_base {
/** @internal type navigation helper, not in runtime. */
protected static __types: {
api: {
input: DescribeMaintenanceWindowExecutionTasksRequest;
output: DescribeMaintenanceWindowExecutionTasksResult;
};
sdk: {
input: DescribeMaintenanceWindowExecutionTasksCommandInput;
output: DescribeMaintenanceWindowExecutionTasksCommandOutput;
};
};
}