feat(client-ssm-sap): Added support for application-aware start/stop of SAP applications running on EC2 instances, with SSM for SAP

Author: awstools

clients/client-ssm-sap/README.md

@@ -284,6 +284,14 @@ ListDatabases
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-sap/command/ListDatabasesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/ListDatabasesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/ListDatabasesCommandOutput/)
 
+</details>
+<details>
+<summary>
+ListOperationEvents
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-sap/command/ListOperationEventsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/ListOperationEventsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/ListOperationEventsCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -316,6 +324,14 @@ RegisterApplication
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-sap/command/RegisterApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/RegisterApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/RegisterApplicationCommandOutput/)
 
+</details>
+<details>
+<summary>
+StartApplication
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-sap/command/StartApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/StartApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/StartApplicationCommandOutput/)
+
 </details>
 <details>
 <summary>
@@ -324,6 +340,14 @@ StartApplicationRefresh
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-sap/command/StartApplicationRefreshCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/StartApplicationRefreshCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/StartApplicationRefreshCommandOutput/)
 
+</details>
+<details>
+<summary>
+StopApplication
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ssm-sap/command/StopApplicationCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/StopApplicationCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ssm-sap/Interface/StopApplicationCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-ssm-sap/src/SsmSap.ts

@@ -48,6 +48,11 @@ import {
   ListDatabasesCommandInput,
   ListDatabasesCommandOutput,
 } from "./commands/ListDatabasesCommand";
+import {
+  ListOperationEventsCommand,
+  ListOperationEventsCommandInput,
+  ListOperationEventsCommandOutput,
+} from "./commands/ListOperationEventsCommand";
 import {
   ListOperationsCommand,
   ListOperationsCommandInput,
@@ -68,11 +73,21 @@ import {
   RegisterApplicationCommandInput,
   RegisterApplicationCommandOutput,
 } from "./commands/RegisterApplicationCommand";
+import {
+  StartApplicationCommand,
+  StartApplicationCommandInput,
+  StartApplicationCommandOutput,
+} from "./commands/StartApplicationCommand";
 import {
   StartApplicationRefreshCommand,
   StartApplicationRefreshCommandInput,
   StartApplicationRefreshCommandOutput,
 } from "./commands/StartApplicationRefreshCommand";
+import {
+  StopApplicationCommand,
+  StopApplicationCommandInput,
+  StopApplicationCommandOutput,
+} from "./commands/StopApplicationCommand";
 import { TagResourceCommand, TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
 import {
   UntagResourceCommand,
@@ -97,11 +112,14 @@ const commands = {
   ListApplicationsCommand,
   ListComponentsCommand,
   ListDatabasesCommand,
+  ListOperationEventsCommand,
   ListOperationsCommand,
   ListTagsForResourceCommand,
   PutResourcePermissionCommand,
   RegisterApplicationCommand,
+  StartApplicationCommand,
   StartApplicationRefreshCommand,
+  StopApplicationCommand,
   TagResourceCommand,
   UntagResourceCommand,
   UpdateApplicationSettingsCommand,
@@ -253,6 +271,23 @@ export interface SsmSap {
     cb: (err: any, data?: ListDatabasesCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListOperationEventsCommand}
+   */
+  listOperationEvents(
+    args: ListOperationEventsCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListOperationEventsCommandOutput>;
+  listOperationEvents(
+    args: ListOperationEventsCommandInput,
+    cb: (err: any, data?: ListOperationEventsCommandOutput) => void
+  ): void;
+  listOperationEvents(
+    args: ListOperationEventsCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListOperationEventsCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListOperationsCommand}
    */
@@ -318,6 +353,23 @@ export interface SsmSap {
     cb: (err: any, data?: RegisterApplicationCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link StartApplicationCommand}
+   */
+  startApplication(
+    args: StartApplicationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<StartApplicationCommandOutput>;
+  startApplication(
+    args: StartApplicationCommandInput,
+    cb: (err: any, data?: StartApplicationCommandOutput) => void
+  ): void;
+  startApplication(
+    args: StartApplicationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: StartApplicationCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link StartApplicationRefreshCommand}
    */
@@ -335,6 +387,20 @@ export interface SsmSap {
     cb: (err: any, data?: StartApplicationRefreshCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link StopApplicationCommand}
+   */
+  stopApplication(
+    args: StopApplicationCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<StopApplicationCommandOutput>;
+  stopApplication(args: StopApplicationCommandInput, cb: (err: any, data?: StopApplicationCommandOutput) => void): void;
+  stopApplication(
+    args: StopApplicationCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: StopApplicationCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link TagResourceCommand}
    */

clients/client-ssm-sap/src/SsmSapClient.ts

@@ -72,6 +72,10 @@ import {
 import { ListApplicationsCommandInput, ListApplicationsCommandOutput } from "./commands/ListApplicationsCommand";
 import { ListComponentsCommandInput, ListComponentsCommandOutput } from "./commands/ListComponentsCommand";
 import { ListDatabasesCommandInput, ListDatabasesCommandOutput } from "./commands/ListDatabasesCommand";
+import {
+  ListOperationEventsCommandInput,
+  ListOperationEventsCommandOutput,
+} from "./commands/ListOperationEventsCommand";
 import { ListOperationsCommandInput, ListOperationsCommandOutput } from "./commands/ListOperationsCommand";
 import {
   ListTagsForResourceCommandInput,
@@ -85,10 +89,12 @@ import {
   RegisterApplicationCommandInput,
   RegisterApplicationCommandOutput,
 } from "./commands/RegisterApplicationCommand";
+import { StartApplicationCommandInput, StartApplicationCommandOutput } from "./commands/StartApplicationCommand";
 import {
   StartApplicationRefreshCommandInput,
   StartApplicationRefreshCommandOutput,
 } from "./commands/StartApplicationRefreshCommand";
+import { StopApplicationCommandInput, StopApplicationCommandOutput } from "./commands/StopApplicationCommand";
 import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/TagResourceCommand";
 import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
 import {
@@ -120,11 +126,14 @@ export type ServiceInputTypes =
   | ListApplicationsCommandInput
   | ListComponentsCommandInput
   | ListDatabasesCommandInput
+  | ListOperationEventsCommandInput
   | ListOperationsCommandInput
   | ListTagsForResourceCommandInput
   | PutResourcePermissionCommandInput
   | RegisterApplicationCommandInput
+  | StartApplicationCommandInput
   | StartApplicationRefreshCommandInput
+  | StopApplicationCommandInput
   | TagResourceCommandInput
   | UntagResourceCommandInput
   | UpdateApplicationSettingsCommandInput;
@@ -143,11 +152,14 @@ export type ServiceOutputTypes =
   | ListApplicationsCommandOutput
   | ListComponentsCommandOutput
   | ListDatabasesCommandOutput
+  | ListOperationEventsCommandOutput
   | ListOperationsCommandOutput
   | ListTagsForResourceCommandOutput
   | PutResourcePermissionCommandOutput
   | RegisterApplicationCommandOutput
+  | StartApplicationCommandOutput
   | StartApplicationRefreshCommandOutput
+  | StopApplicationCommandOutput
   | TagResourceCommandOutput
   | UntagResourceCommandOutput
   | UpdateApplicationSettingsCommandOutput;

clients/client-ssm-sap/src/commands/ListOperationEventsCommand.ts

@@ -0,0 +1,111 @@
+// smithy-typescript generated code
+import { getEndpointPlugin } from "@smithy/middleware-endpoint";
+import { getSerdePlugin } from "@smithy/middleware-serde";
+import { Command as $Command } from "@smithy/smithy-client";
+import { MetadataBearer as __MetadataBearer } from "@smithy/types";
+
+import { commonParams } from "../endpoint/EndpointParameters";
+import { ListOperationEventsInput, ListOperationEventsOutput } from "../models/models_0";
+import { de_ListOperationEventsCommand, se_ListOperationEventsCommand } from "../protocols/Aws_restJson1";
+import { ServiceInputTypes, ServiceOutputTypes, SsmSapClientResolvedConfig } from "../SsmSapClient";
+
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link ListOperationEventsCommand}.
+ */
+export interface ListOperationEventsCommandInput extends ListOperationEventsInput {}
+/**
+ * @public
+ *
+ * The output of {@link ListOperationEventsCommand}.
+ */
+export interface ListOperationEventsCommandOutput extends ListOperationEventsOutput, __MetadataBearer {}
+
+/**
+ * <p>Returns a list of operations events.</p>
+ *          <p>Available parameters include <code>OperationID</code>, as well as optional parameters
+ *             <code>MaxResults</code>, <code>NextToken</code>, and
+ *          <code>Filters</code>.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { SsmSapClient, ListOperationEventsCommand } from "@aws-sdk/client-ssm-sap"; // ES Modules import
+ * // const { SsmSapClient, ListOperationEventsCommand } = require("@aws-sdk/client-ssm-sap"); // CommonJS import
+ * const client = new SsmSapClient(config);
+ * const input = { // ListOperationEventsInput
+ *   OperationId: "STRING_VALUE", // required
+ *   MaxResults: Number("int"),
+ *   NextToken: "STRING_VALUE",
+ *   Filters: [ // FilterList
+ *     { // Filter
+ *       Name: "STRING_VALUE", // required
+ *       Value: "STRING_VALUE", // required
+ *       Operator: "Equals" || "GreaterThanOrEquals" || "LessThanOrEquals", // required
+ *     },
+ *   ],
+ * };
+ * const command = new ListOperationEventsCommand(input);
+ * const response = await client.send(command);
+ * // { // ListOperationEventsOutput
+ * //   OperationEvents: [ // OperationEventList
+ * //     { // OperationEvent
+ * //       Description: "STRING_VALUE",
+ * //       Resource: { // Resource
+ * //         ResourceArn: "STRING_VALUE",
+ * //         ResourceType: "STRING_VALUE",
+ * //       },
+ * //       Status: "IN_PROGRESS" || "COMPLETED" || "FAILED",
+ * //       StatusMessage: "STRING_VALUE",
+ * //       Timestamp: new Date("TIMESTAMP"),
+ * //     },
+ * //   ],
+ * //   NextToken: "STRING_VALUE",
+ * // };
+ *
+ * ```
+ *
+ * @param ListOperationEventsCommandInput - {@link ListOperationEventsCommandInput}
+ * @returns {@link ListOperationEventsCommandOutput}
+ * @see {@link ListOperationEventsCommandInput} for command's `input` shape.
+ * @see {@link ListOperationEventsCommandOutput} for command's `response` shape.
+ * @see {@link SsmSapClientResolvedConfig | config} for SsmSapClient's `config` shape.
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>An internal error has occurred.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an AWS service. </p>
+ *
+ * @throws {@link SsmSapServiceException}
+ * <p>Base exception class for all service exceptions from SsmSap service.</p>
+ *
+ * @public
+ */
+export class ListOperationEventsCommand extends $Command
+  .classBuilder<
+    ListOperationEventsCommandInput,
+    ListOperationEventsCommandOutput,
+    SsmSapClientResolvedConfig,
+    ServiceInputTypes,
+    ServiceOutputTypes
+  >()
+  .ep({
+    ...commonParams,
+  })
+  .m(function (this: any, Command: any, cs: any, config: SsmSapClientResolvedConfig, o: any) {
+    return [
+      getSerdePlugin(config, this.serialize, this.deserialize),
+      getEndpointPlugin(config, Command.getEndpointParameterInstructions()),
+    ];
+  })
+  .s("SsmSap", "ListOperationEvents", {})
+  .n("SsmSapClient", "ListOperationEventsCommand")
+  .f(void 0, void 0)
+  .ser(se_ListOperationEventsCommand)
+  .de(de_ListOperationEventsCommand)
+  .build() {}