feat(client-backup): Adds optional MaxScheduledRunsPreview input to GetBackupPlan API to provide a preview of up to 10 next scheduled backup plan runs in the GetBackupPlan response.

Author: awstools

clients/client-backup/src/commands/GetBackupPlanCommand.ts

@@ -41,6 +41,7 @@ export interface GetBackupPlanCommandOutput extends GetBackupPlanOutput, __Metad
  * const input = { // GetBackupPlanInput
  *   BackupPlanId: "STRING_VALUE", // required
  *   VersionId: "STRING_VALUE",
+ *   MaxScheduledRunsPreview: Number("int"),
  * };
  * const command = new GetBackupPlanCommand(input);
  * const response = await client.send(command);
@@ -108,6 +109,13 @@ export interface GetBackupPlanCommandOutput extends GetBackupPlanOutput, __Metad
  * //       },
  * //     },
  * //   ],
+ * //   ScheduledRunsPreview: [ // ScheduledRunsPreview
+ * //     { // ScheduledPlanExecutionMember
+ * //       ExecutionTime: new Date("TIMESTAMP"),
+ * //       RuleId: "STRING_VALUE",
+ * //       RuleExecutionType: "CONTINUOUS" || "SNAPSHOTS" || "CONTINUOUS_AND_SNAPSHOTS",
+ * //     },
+ * //   ],
  * // };
  *
  * ```

clients/client-backup/src/commands/StartCopyJobCommand.ts

@@ -30,6 +30,9 @@ export interface StartCopyJobCommandOutput extends StartCopyJobOutput, __Metadat
 /**
  * <p>Starts a job to create a one-time copy of the specified resource.</p>
  *          <p>Does not support continuous backups.</p>
+ *          <p>See <a href="https://docs.aws.amazon.com/aws-backup/latest/devguide/recov-point-create-a-copy.html#backup-copy-retry">Copy
+ *       job retry</a> for information on how Backup retries copy job
+ *       operations.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

clients/client-backup/src/models/models_0.ts

@@ -4149,7 +4149,8 @@ export interface DescribeGlobalSettingsInput {}
  */
 export interface DescribeGlobalSettingsOutput {
   /**
-   * <p>The status of the flag <code>isCrossAccountBackupEnabled</code>.</p>
+   * <p>The status of the flags <code>isCrossAccountBackupEnabled</code> and
+   *           <code>isMpaEnabled</code> ('Mpa' refers to multi-party approval).</p>
    * @public
    */
   GlobalSettings?: Record<string, string> | undefined;
@@ -5144,6 +5145,51 @@ export interface GetBackupPlanInput {
    * @public
    */
   VersionId?: string | undefined;
+
+  /**
+   * <p>Number of future scheduled backup runs to preview. When set to 0 (default), no scheduled runs preview is included in the response. Valid range is 0-10.</p>
+   * @public
+   */
+  MaxScheduledRunsPreview?: number | undefined;
+}
+
+/**
+ * @public
+ * @enum
+ */
+export const RuleExecutionType = {
+  CONTINUOUS: "CONTINUOUS",
+  CONTINUOUS_AND_SNAPSHOTS: "CONTINUOUS_AND_SNAPSHOTS",
+  SNAPSHOTS: "SNAPSHOTS",
+} as const;
+
+/**
+ * @public
+ */
+export type RuleExecutionType = (typeof RuleExecutionType)[keyof typeof RuleExecutionType];
+
+/**
+ * <p>Contains information about a scheduled backup plan execution, including the execution time, rule type, and associated rule identifier.</p>
+ * @public
+ */
+export interface ScheduledPlanExecutionMember {
+  /**
+   * <p>The timestamp when the backup is scheduled to run, in Unix format and Coordinated Universal Time (UTC). The value is accurate to milliseconds.</p>
+   * @public
+   */
+  ExecutionTime?: Date | undefined;
+
+  /**
+   * <p>The unique identifier of the backup rule that will execute at the scheduled time.</p>
+   * @public
+   */
+  RuleId?: string | undefined;
+
+  /**
+   * <p>The type of backup rule execution. Valid values are <code>CONTINUOUS</code> (point-in-time recovery), <code>SNAPSHOTS</code> (snapshot backups), or <code>CONTINUOUS_AND_SNAPSHOTS</code> (both types combined).</p>
+   * @public
+   */
+  RuleExecutionType?: RuleExecutionType | undefined;
 }
 
 /**
@@ -5217,6 +5263,12 @@ export interface GetBackupPlanOutput {
    * @public
    */
   AdvancedBackupSettings?: AdvancedBackupSetting[] | undefined;
+
+  /**
+   * <p>List of upcoming scheduled backup runs. Only included when <code>MaxScheduledRunsPreview</code> parameter is greater than 0. Contains up to 10 future backup executions with their scheduled times, execution types, and associated rule IDs.</p>
+   * @public
+   */
+  ScheduledRunsPreview?: ScheduledPlanExecutionMember[] | undefined;
 }
 
 /**
@@ -9991,9 +10043,14 @@ export interface UpdateFrameworkOutput {
  */
 export interface UpdateGlobalSettingsInput {
   /**
-   * <p>A value for <code>isCrossAccountBackupEnabled</code> and a Region. Example:
+   * <p>Inputs can include:</p>
+   *          <p>A value for <code>isCrossAccountBackupEnabled</code> and a Region. Example:
    *             <code>update-global-settings --global-settings isCrossAccountBackupEnabled=false
    *             --region us-west-2</code>.</p>
+   *          <p>A value for Multi-party approval, styled as "Mpa": <code>isMpaEnabled</code>. Values can
+   *          be true or false. Example:
+   *          <code>update-global-settings --global-settings isMpaEnabled=false
+   *             --region us-west-2</code>.</p>
    * @public
    */
   GlobalSettings?: Record<string, string> | undefined;

clients/client-backup/src/protocols/Aws_restJson1.ts

@@ -369,6 +369,7 @@ import {
   RestoreTestingSelectionForGet,
   RestoreTestingSelectionForList,
   RestoreTestingSelectionForUpdate,
+  ScheduledPlanExecutionMember,
   ServiceUnavailableException,
 } from "../models/models_0";
 
@@ -1117,6 +1118,7 @@ export const se_GetBackupPlanCommand = async (
   b.p("BackupPlanId", () => input.BackupPlanId!, "{BackupPlanId}", false);
   const query: any = map({
     [_vI]: [, input[_VI]!],
+    [_MSRP]: [() => input.MaxScheduledRunsPreview !== void 0, () => input[_MSRP]!.toString()],
   });
   let body: any;
   b.m("GET").h(headers).q(query).b(body);
@@ -3322,6 +3324,7 @@ export const de_GetBackupPlanCommand = async (
     CreatorRequestId: __expectString,
     DeletionDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
     LastExecutionDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+    ScheduledRunsPreview: (_) => de_ScheduledRunsPreview(_, context),
     VersionId: __expectString,
   });
   Object.assign(contents, doc);
@@ -5862,6 +5865,29 @@ const de_RestoreTestingSelections = (output: any, context: __SerdeContext): Rest
   return retVal;
 };
 
+/**
+ * deserializeAws_restJson1ScheduledPlanExecutionMember
+ */
+const de_ScheduledPlanExecutionMember = (output: any, context: __SerdeContext): ScheduledPlanExecutionMember => {
+  return take(output, {
+    ExecutionTime: (_: any) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+    RuleExecutionType: __expectString,
+    RuleId: __expectString,
+  }) as any;
+};
+
+/**
+ * deserializeAws_restJson1ScheduledRunsPreview
+ */
+const de_ScheduledRunsPreview = (output: any, context: __SerdeContext): ScheduledPlanExecutionMember[] => {
+  const retVal = (output || [])
+    .filter((e: any) => e != null)
+    .map((entry: any) => {
+      return de_ScheduledPlanExecutionMember(entry, context);
+    });
+  return retVal;
+};
+
 // de_SensitiveStringMap omitted.
 
 // de_stringList omitted.
@@ -5921,6 +5947,7 @@ const _IS = "IndexStatus";
 const _MBAWSBO = "ManagedByAWSBackupOnly";
 const _MC = "MessageCategory";
 const _MR = "MaxResults";
+const _MSRP = "MaxScheduledRunsPreview";
 const _NT = "NextToken";
 const _RC = "RequesterComment";
 const _RPA = "RecoveryPointArn";