feat(client-backup): AWS Backup - Features: Provide Job Summary for y…

…our backup activity.
aws · Nov 14, 2023 · 5319e55 · 5319e55
1 parent 6c3fba8
commit 5319e55
Show file tree

Hide file tree

Showing 18 changed files with 2,729 additions and 2 deletions.
diff --git a/clients/client-backup/README.md b/clients/client-backup/README.md
@@ -535,6 +535,14 @@ ListBackupJobs
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/classes/listbackupjobscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listbackupjobscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listbackupjobscommandoutput.html)
 
+</details>
+<details>
+<summary>
+ListBackupJobSummaries
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/classes/listbackupjobsummariescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listbackupjobsummariescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listbackupjobsummariescommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -583,6 +591,14 @@ ListCopyJobs
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/classes/listcopyjobscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listcopyjobscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listcopyjobscommandoutput.html)
 
+</details>
+<details>
+<summary>
+ListCopyJobSummaries
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/classes/listcopyjobsummariescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listcopyjobsummariescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listcopyjobsummariescommandoutput.html)
+
 </details>
 <details>
 <summary>
@@ -663,6 +679,14 @@ ListRestoreJobs
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/classes/listrestorejobscommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listrestorejobscommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listrestorejobscommandoutput.html)
 
+</details>
+<details>
+<summary>
+ListRestoreJobSummaries
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/classes/listrestorejobsummariescommand.html) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listrestorejobsummariescommandinput.html) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-backup/interfaces/listrestorejobsummariescommandoutput.html)
+
 </details>
 <details>
 <summary>

diff --git a/clients/client-backup/src/Backup.ts b/clients/client-backup/src/Backup.ts
@@ -208,6 +208,11 @@ import {
   ListBackupJobsCommandInput,
   ListBackupJobsCommandOutput,
 } from "./commands/ListBackupJobsCommand";
+import {
+  ListBackupJobSummariesCommand,
+  ListBackupJobSummariesCommandInput,
+  ListBackupJobSummariesCommandOutput,
+} from "./commands/ListBackupJobSummariesCommand";
 import {
   ListBackupPlansCommand,
   ListBackupPlansCommandInput,
@@ -238,6 +243,11 @@ import {
   ListCopyJobsCommandInput,
   ListCopyJobsCommandOutput,
 } from "./commands/ListCopyJobsCommand";
+import {
+  ListCopyJobSummariesCommand,
+  ListCopyJobSummariesCommandInput,
+  ListCopyJobSummariesCommandOutput,
+} from "./commands/ListCopyJobSummariesCommand";
 import {
   ListFrameworksCommand,
   ListFrameworksCommandInput,
@@ -288,6 +298,11 @@ import {
   ListRestoreJobsCommandInput,
   ListRestoreJobsCommandOutput,
 } from "./commands/ListRestoreJobsCommand";
+import {
+  ListRestoreJobSummariesCommand,
+  ListRestoreJobSummariesCommandInput,
+  ListRestoreJobSummariesCommandOutput,
+} from "./commands/ListRestoreJobSummariesCommand";
 import { ListTagsCommand, ListTagsCommandInput, ListTagsCommandOutput } from "./commands/ListTagsCommand";
 import {
   PutBackupVaultAccessPolicyCommand,
@@ -408,12 +423,14 @@ const commands = {
   GetRecoveryPointRestoreMetadataCommand,
   GetSupportedResourceTypesCommand,
   ListBackupJobsCommand,
+  ListBackupJobSummariesCommand,
   ListBackupPlansCommand,
   ListBackupPlanTemplatesCommand,
   ListBackupPlanVersionsCommand,
   ListBackupSelectionsCommand,
   ListBackupVaultsCommand,
   ListCopyJobsCommand,
+  ListCopyJobSummariesCommand,
   ListFrameworksCommand,
   ListLegalHoldsCommand,
   ListProtectedResourcesCommand,
@@ -424,6 +441,7 @@ const commands = {
   ListReportJobsCommand,
   ListReportPlansCommand,
   ListRestoreJobsCommand,
+  ListRestoreJobSummariesCommand,
   ListTagsCommand,
   PutBackupVaultAccessPolicyCommand,
   PutBackupVaultLockConfigurationCommand,
@@ -1111,6 +1129,23 @@ export interface Backup {
     cb: (err: any, data?: ListBackupJobsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListBackupJobSummariesCommand}
+   */
+  listBackupJobSummaries(
+    args: ListBackupJobSummariesCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListBackupJobSummariesCommandOutput>;
+  listBackupJobSummaries(
+    args: ListBackupJobSummariesCommandInput,
+    cb: (err: any, data?: ListBackupJobSummariesCommandOutput) => void
+  ): void;
+  listBackupJobSummaries(
+    args: ListBackupJobSummariesCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListBackupJobSummariesCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListBackupPlansCommand}
    */
@@ -1204,6 +1239,23 @@ export interface Backup {
     cb: (err: any, data?: ListCopyJobsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListCopyJobSummariesCommand}
+   */
+  listCopyJobSummaries(
+    args: ListCopyJobSummariesCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListCopyJobSummariesCommandOutput>;
+  listCopyJobSummaries(
+    args: ListCopyJobSummariesCommandInput,
+    cb: (err: any, data?: ListCopyJobSummariesCommandOutput) => void
+  ): void;
+  listCopyJobSummaries(
+    args: ListCopyJobSummariesCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListCopyJobSummariesCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListFrameworksCommand}
    */
@@ -1359,6 +1411,23 @@ export interface Backup {
     cb: (err: any, data?: ListRestoreJobsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link ListRestoreJobSummariesCommand}
+   */
+  listRestoreJobSummaries(
+    args: ListRestoreJobSummariesCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<ListRestoreJobSummariesCommandOutput>;
+  listRestoreJobSummaries(
+    args: ListRestoreJobSummariesCommandInput,
+    cb: (err: any, data?: ListRestoreJobSummariesCommandOutput) => void
+  ): void;
+  listRestoreJobSummaries(
+    args: ListRestoreJobSummariesCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: ListRestoreJobSummariesCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link ListTagsCommand}
    */

diff --git a/clients/client-backup/src/BackupClient.ts b/clients/client-backup/src/BackupClient.ts
@@ -154,6 +154,10 @@ import {
   GetSupportedResourceTypesCommandOutput,
 } from "./commands/GetSupportedResourceTypesCommand";
 import { ListBackupJobsCommandInput, ListBackupJobsCommandOutput } from "./commands/ListBackupJobsCommand";
+import {
+  ListBackupJobSummariesCommandInput,
+  ListBackupJobSummariesCommandOutput,
+} from "./commands/ListBackupJobSummariesCommand";
 import { ListBackupPlansCommandInput, ListBackupPlansCommandOutput } from "./commands/ListBackupPlansCommand";
 import {
   ListBackupPlanTemplatesCommandInput,
@@ -169,6 +173,10 @@ import {
 } from "./commands/ListBackupSelectionsCommand";
 import { ListBackupVaultsCommandInput, ListBackupVaultsCommandOutput } from "./commands/ListBackupVaultsCommand";
 import { ListCopyJobsCommandInput, ListCopyJobsCommandOutput } from "./commands/ListCopyJobsCommand";
+import {
+  ListCopyJobSummariesCommandInput,
+  ListCopyJobSummariesCommandOutput,
+} from "./commands/ListCopyJobSummariesCommand";
 import { ListFrameworksCommandInput, ListFrameworksCommandOutput } from "./commands/ListFrameworksCommand";
 import { ListLegalHoldsCommandInput, ListLegalHoldsCommandOutput } from "./commands/ListLegalHoldsCommand";
 import {
@@ -194,6 +202,10 @@ import {
 import { ListReportJobsCommandInput, ListReportJobsCommandOutput } from "./commands/ListReportJobsCommand";
 import { ListReportPlansCommandInput, ListReportPlansCommandOutput } from "./commands/ListReportPlansCommand";
 import { ListRestoreJobsCommandInput, ListRestoreJobsCommandOutput } from "./commands/ListRestoreJobsCommand";
+import {
+  ListRestoreJobSummariesCommandInput,
+  ListRestoreJobSummariesCommandOutput,
+} from "./commands/ListRestoreJobSummariesCommand";
 import { ListTagsCommandInput, ListTagsCommandOutput } from "./commands/ListTagsCommand";
 import {
   PutBackupVaultAccessPolicyCommandInput,
@@ -284,12 +296,14 @@ export type ServiceInputTypes =
   | GetLegalHoldCommandInput
   | GetRecoveryPointRestoreMetadataCommandInput
   | GetSupportedResourceTypesCommandInput
+  | ListBackupJobSummariesCommandInput
   | ListBackupJobsCommandInput
   | ListBackupPlanTemplatesCommandInput
   | ListBackupPlanVersionsCommandInput
   | ListBackupPlansCommandInput
   | ListBackupSelectionsCommandInput
   | ListBackupVaultsCommandInput
+  | ListCopyJobSummariesCommandInput
   | ListCopyJobsCommandInput
   | ListFrameworksCommandInput
   | ListLegalHoldsCommandInput
@@ -300,6 +314,7 @@ export type ServiceInputTypes =
   | ListRecoveryPointsByResourceCommandInput
   | ListReportJobsCommandInput
   | ListReportPlansCommandInput
+  | ListRestoreJobSummariesCommandInput
   | ListRestoreJobsCommandInput
   | ListTagsCommandInput
   | PutBackupVaultAccessPolicyCommandInput
@@ -363,12 +378,14 @@ export type ServiceOutputTypes =
   | GetLegalHoldCommandOutput
   | GetRecoveryPointRestoreMetadataCommandOutput
   | GetSupportedResourceTypesCommandOutput
+  | ListBackupJobSummariesCommandOutput
   | ListBackupJobsCommandOutput
   | ListBackupPlanTemplatesCommandOutput
   | ListBackupPlanVersionsCommandOutput
   | ListBackupPlansCommandOutput
   | ListBackupSelectionsCommandOutput
   | ListBackupVaultsCommandOutput
+  | ListCopyJobSummariesCommandOutput
   | ListCopyJobsCommandOutput
   | ListFrameworksCommandOutput
   | ListLegalHoldsCommandOutput
@@ -379,6 +396,7 @@ export type ServiceOutputTypes =
   | ListRecoveryPointsByResourceCommandOutput
   | ListReportJobsCommandOutput
   | ListReportPlansCommandOutput
+  | ListRestoreJobSummariesCommandOutput
   | ListRestoreJobsCommandOutput
   | ListTagsCommandOutput
   | PutBackupVaultAccessPolicyCommandOutput

diff --git a/clients/client-backup/src/commands/DescribeBackupJobCommand.ts b/clients/client-backup/src/commands/DescribeBackupJobCommand.ts
@@ -84,6 +84,7 @@ export interface DescribeBackupJobCommandOutput extends DescribeBackupJobOutput,
  * //     "<keys>": Number("long"),
  * //   },
  * //   ResourceName: "STRING_VALUE",
+ * //   MessageCategory: "STRING_VALUE",
  * // };
  *
  * ```

diff --git a/clients/client-backup/src/commands/DescribeCopyJobCommand.ts b/clients/client-backup/src/commands/DescribeCopyJobCommand.ts
@@ -79,6 +79,7 @@ export interface DescribeCopyJobCommandOutput extends DescribeCopyJobOutput, __M
  * //       "<keys>": Number("long"),
  * //     },
  * //     ResourceName: "STRING_VALUE",
+ * //     MessageCategory: "STRING_VALUE",
  * //   },
  * // };
  *