feat(client-arc-zonal-shift): Added support for on-demand practice runs and balanced capacity checks in ARC autoshift practice.

Author: awstools

clients/client-arc-zonal-shift/README.md

@@ -6,40 +6,7 @@
 
 AWS SDK for JavaScript ARCZonalShift Client for Node.js, Browser and React Native.
 
-<p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
-<p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
-help your application recover quickly from an impairment in an Availability Zone. For example,
-you can recover your application from a developer's bad code deployment or from an
-Amazon Web Services infrastructure failure in a single Availability Zone.</p>
-<p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
-is a capability in ARC where you authorize Amazon Web Services to shift away application resource
-traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
-Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
-Zone impairment that could potentially impact customers.</p>
-<p>To help make sure that zonal autoshift is safe for your application, you must
-also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
-weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone.
-Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the
-Availability Zones in an Amazon Web Services Region for your application to continue to operate normally
-when traffic for a resource is shifted away from one Availability Zone.</p>
-<important>
-<p>Before you configure practice runs or enable zonal autoshift, we strongly recommend
-that you prescale your application resource capacity in all Availability Zones in the Region where
-your application resources are deployed. You should not rely on scaling on demand when an
-autoshift or practice run starts. Zonal autoshift, including practice runs, works independently,
-and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of
-pre-scaling, can result in loss of availability.</p>
-<p>If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure
-the minimum capacity of your auto scaling to continue operating normally with the loss of an
-Availability Zone. </p>
-</important>
-<p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
-autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
-potentially impact customers. In some cases, resources might be shifted away that are not experiencing
-impact.</p>
-<p>For more information about using zonal shift and zonal autoshift, see the
-<a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
-Developer Guide</a>.</p>
+<p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Application Recovery Controller (ARC).</p> <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.</p> <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.</p> <p>For more information about using zonal shift and zonal autoshift, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Application Recovery Controller Developer Guide</a>.</p>
 
 ## Installing
 
@@ -236,6 +203,14 @@ see LICENSE for more information.
 
 ## Client Commands (Operations List)
 
+<details>
+<summary>
+CancelPracticeRun
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/arc-zonal-shift/command/CancelPracticeRunCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-zonal-shift/Interface/CancelPracticeRunCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-zonal-shift/Interface/CancelPracticeRunCommandOutput/)
+
+</details>
 <details>
 <summary>
 CancelZonalShift
@@ -299,6 +274,14 @@ ListZonalShifts
 
 [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/arc-zonal-shift/command/ListZonalShiftsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-zonal-shift/Interface/ListZonalShiftsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-zonal-shift/Interface/ListZonalShiftsCommandOutput/)
 
+</details>
+<details>
+<summary>
+StartPracticeRun
+</summary>
+
+[Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/arc-zonal-shift/command/StartPracticeRunCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-zonal-shift/Interface/StartPracticeRunCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-arc-zonal-shift/Interface/StartPracticeRunCommandOutput/)
+
 </details>
 <details>
 <summary>

clients/client-arc-zonal-shift/src/ARCZonalShift.ts

@@ -3,6 +3,11 @@ import { createAggregatedClient } from "@smithy/smithy-client";
 import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
 
 import { ARCZonalShiftClient, ARCZonalShiftClientConfig } from "./ARCZonalShiftClient";
+import {
+  CancelPracticeRunCommand,
+  CancelPracticeRunCommandInput,
+  CancelPracticeRunCommandOutput,
+} from "./commands/CancelPracticeRunCommand";
 import {
   CancelZonalShiftCommand,
   CancelZonalShiftCommandInput,
@@ -43,6 +48,11 @@ import {
   ListZonalShiftsCommandInput,
   ListZonalShiftsCommandOutput,
 } from "./commands/ListZonalShiftsCommand";
+import {
+  StartPracticeRunCommand,
+  StartPracticeRunCommandInput,
+  StartPracticeRunCommandOutput,
+} from "./commands/StartPracticeRunCommand";
 import {
   StartZonalShiftCommand,
   StartZonalShiftCommandInput,
@@ -70,6 +80,7 @@ import {
 } from "./commands/UpdateZonalShiftCommand";
 
 const commands = {
+  CancelPracticeRunCommand,
   CancelZonalShiftCommand,
   CreatePracticeRunConfigurationCommand,
   DeletePracticeRunConfigurationCommand,
@@ -78,6 +89,7 @@ const commands = {
   ListAutoshiftsCommand,
   ListManagedResourcesCommand,
   ListZonalShiftsCommand,
+  StartPracticeRunCommand,
   StartZonalShiftCommand,
   UpdateAutoshiftObserverNotificationStatusCommand,
   UpdatePracticeRunConfigurationCommand,
@@ -86,6 +98,23 @@ const commands = {
 };
 
 export interface ARCZonalShift {
+  /**
+   * @see {@link CancelPracticeRunCommand}
+   */
+  cancelPracticeRun(
+    args: CancelPracticeRunCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<CancelPracticeRunCommandOutput>;
+  cancelPracticeRun(
+    args: CancelPracticeRunCommandInput,
+    cb: (err: any, data?: CancelPracticeRunCommandOutput) => void
+  ): void;
+  cancelPracticeRun(
+    args: CancelPracticeRunCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: CancelPracticeRunCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link CancelZonalShiftCommand}
    */
@@ -220,6 +249,23 @@ export interface ARCZonalShift {
     cb: (err: any, data?: ListZonalShiftsCommandOutput) => void
   ): void;
 
+  /**
+   * @see {@link StartPracticeRunCommand}
+   */
+  startPracticeRun(
+    args: StartPracticeRunCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<StartPracticeRunCommandOutput>;
+  startPracticeRun(
+    args: StartPracticeRunCommandInput,
+    cb: (err: any, data?: StartPracticeRunCommandOutput) => void
+  ): void;
+  startPracticeRun(
+    args: StartPracticeRunCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: StartPracticeRunCommandOutput) => void
+  ): void;
+
   /**
    * @see {@link StartZonalShiftCommand}
    */
@@ -304,40 +350,7 @@ export interface ARCZonalShift {
 }
 
 /**
- * <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
- *          <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
- * 			help your application recover quickly from an impairment in an Availability Zone. For example,
- * 			you can recover your application from a developer's bad code deployment or from an
- * 			Amazon Web Services infrastructure failure in a single Availability Zone.</p>
- *          <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
- * 			is a capability in ARC where you authorize Amazon Web Services to shift away application resource
- * 			traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
- * 			Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
- * 			Zone impairment that could potentially impact customers.</p>
- *          <p>To help make sure that zonal autoshift is safe for your application, you must
- * 			also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
- * 			weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone.
- * 			Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the
- * 			Availability Zones in an Amazon Web Services Region for your application to continue to operate normally
- * 			when traffic for a resource is shifted away from one Availability Zone.</p>
- *          <important>
- *             <p>Before you configure practice runs or enable zonal autoshift, we strongly recommend
- * 			that you prescale your application resource capacity in all Availability Zones in the Region where
- * 			your application resources are deployed. You should not rely on scaling on demand when an
- * 			autoshift or practice run starts. Zonal autoshift, including practice runs, works independently,
- * 			and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of
- * 			pre-scaling, can result in loss of availability.</p>
- *             <p>If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure
- * 				the minimum capacity of your auto scaling to continue operating normally with the loss of an
- * 				Availability Zone. </p>
- *          </important>
- *          <p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
- * 			autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
- * 			potentially impact customers. In some cases, resources might be shifted away that are not experiencing
- * 			impact.</p>
- *          <p>For more information about using zonal shift and zonal autoshift, see the
- * 			<a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
- * 				Developer Guide</a>.</p>
+ * <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Application Recovery Controller (ARC).</p> <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.</p> <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.</p> <p>For more information about using zonal shift and zonal autoshift, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Application Recovery Controller Developer Guide</a>.</p>
  * @public
  */
 export class ARCZonalShift extends ARCZonalShiftClient implements ARCZonalShift {}

clients/client-arc-zonal-shift/src/ARCZonalShiftClient.ts

@@ -53,6 +53,7 @@ import {
   HttpAuthSchemeResolvedConfig,
   resolveHttpAuthSchemeConfig,
 } from "./auth/httpAuthSchemeProvider";
+import { CancelPracticeRunCommandInput, CancelPracticeRunCommandOutput } from "./commands/CancelPracticeRunCommand";
 import { CancelZonalShiftCommandInput, CancelZonalShiftCommandOutput } from "./commands/CancelZonalShiftCommand";
 import {
   CreatePracticeRunConfigurationCommandInput,
@@ -73,6 +74,7 @@ import {
   ListManagedResourcesCommandOutput,
 } from "./commands/ListManagedResourcesCommand";
 import { ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput } from "./commands/ListZonalShiftsCommand";
+import { StartPracticeRunCommandInput, StartPracticeRunCommandOutput } from "./commands/StartPracticeRunCommand";
 import { StartZonalShiftCommandInput, StartZonalShiftCommandOutput } from "./commands/StartZonalShiftCommand";
 import {
   UpdateAutoshiftObserverNotificationStatusCommandInput,
@@ -102,6 +104,7 @@ export { __Client };
  * @public
  */
 export type ServiceInputTypes =
+  | CancelPracticeRunCommandInput
   | CancelZonalShiftCommandInput
   | CreatePracticeRunConfigurationCommandInput
   | DeletePracticeRunConfigurationCommandInput
@@ -110,6 +113,7 @@ export type ServiceInputTypes =
   | ListAutoshiftsCommandInput
   | ListManagedResourcesCommandInput
   | ListZonalShiftsCommandInput
+  | StartPracticeRunCommandInput
   | StartZonalShiftCommandInput
   | UpdateAutoshiftObserverNotificationStatusCommandInput
   | UpdatePracticeRunConfigurationCommandInput
@@ -120,6 +124,7 @@ export type ServiceInputTypes =
  * @public
  */
 export type ServiceOutputTypes =
+  | CancelPracticeRunCommandOutput
   | CancelZonalShiftCommandOutput
   | CreatePracticeRunConfigurationCommandOutput
   | DeletePracticeRunConfigurationCommandOutput
@@ -128,6 +133,7 @@ export type ServiceOutputTypes =
   | ListAutoshiftsCommandOutput
   | ListManagedResourcesCommandOutput
   | ListZonalShiftsCommandOutput
+  | StartPracticeRunCommandOutput
   | StartZonalShiftCommandOutput
   | UpdateAutoshiftObserverNotificationStatusCommandOutput
   | UpdatePracticeRunConfigurationCommandOutput
@@ -325,40 +331,7 @@ export type ARCZonalShiftClientResolvedConfigType = __SmithyResolvedConfiguratio
 export interface ARCZonalShiftClientResolvedConfig extends ARCZonalShiftClientResolvedConfigType {}
 
 /**
- * <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
- *          <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
- * 			help your application recover quickly from an impairment in an Availability Zone. For example,
- * 			you can recover your application from a developer's bad code deployment or from an
- * 			Amazon Web Services infrastructure failure in a single Availability Zone.</p>
- *          <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
- * 			is a capability in ARC where you authorize Amazon Web Services to shift away application resource
- * 			traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
- * 			Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
- * 			Zone impairment that could potentially impact customers.</p>
- *          <p>To help make sure that zonal autoshift is safe for your application, you must
- * 			also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
- * 			weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone.
- * 			Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the
- * 			Availability Zones in an Amazon Web Services Region for your application to continue to operate normally
- * 			when traffic for a resource is shifted away from one Availability Zone.</p>
- *          <important>
- *             <p>Before you configure practice runs or enable zonal autoshift, we strongly recommend
- * 			that you prescale your application resource capacity in all Availability Zones in the Region where
- * 			your application resources are deployed. You should not rely on scaling on demand when an
- * 			autoshift or practice run starts. Zonal autoshift, including practice runs, works independently,
- * 			and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of
- * 			pre-scaling, can result in loss of availability.</p>
- *             <p>If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure
- * 				the minimum capacity of your auto scaling to continue operating normally with the loss of an
- * 				Availability Zone. </p>
- *          </important>
- *          <p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
- * 			autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
- * 			potentially impact customers. In some cases, resources might be shifted away that are not experiencing
- * 			impact.</p>
- *          <p>For more information about using zonal shift and zonal autoshift, see the
- * 			<a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
- * 				Developer Guide</a>.</p>
+ * <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Application Recovery Controller (ARC).</p> <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to help your application recover quickly from an impairment in an Availability Zone. For example, you can recover your application from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone.</p> <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift is a capability in ARC where you authorize Amazon Web Services to shift away application resource traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery. Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability Zone impairment that could potentially impact customers.</p> <p>For more information about using zonal shift and zonal autoshift, see the <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Application Recovery Controller Developer Guide</a>.</p>
  * @public
  */
 export class ARCZonalShiftClient extends __Client<