@aws-sdk/client-arc-zonal-shift 3.462.0 → 3.464.0

package/dist-types/commands/UpdatePracticeRunConfigurationCommand.d.ts

@@ -0,0 +1,133 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
+import { UpdatePracticeRunConfigurationRequest, UpdatePracticeRunConfigurationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdatePracticeRunConfigurationCommand}.
+ */
+export interface UpdatePracticeRunConfigurationCommandInput extends UpdatePracticeRunConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdatePracticeRunConfigurationCommand}.
+ */
+export interface UpdatePracticeRunConfigurationCommandOutput extends UpdatePracticeRunConfigurationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>Update a practice run configuration to change one or more of the following: add,
+ * 			change, or remove the blocking alarm; change the outcome alarm; or add, change,
+ * 			or remove blocking dates or time windows.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ARCZonalShiftClient, UpdatePracticeRunConfigurationCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
+ * // const { ARCZonalShiftClient, UpdatePracticeRunConfigurationCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
+ * const client = new ARCZonalShiftClient(config);
+ * const input = { // UpdatePracticeRunConfigurationRequest
+ *   resourceIdentifier: "STRING_VALUE", // required
+ *   blockedWindows: [ // BlockedWindows
+ *     "STRING_VALUE",
+ *   ],
+ *   blockedDates: [ // BlockedDates
+ *     "STRING_VALUE",
+ *   ],
+ *   blockingAlarms: [ // ControlConditions
+ *     { // ControlCondition
+ *       type: "CLOUDWATCH", // required
+ *       alarmIdentifier: "STRING_VALUE", // required
+ *     },
+ *   ],
+ *   outcomeAlarms: [
+ *     {
+ *       type: "CLOUDWATCH", // required
+ *       alarmIdentifier: "STRING_VALUE", // required
+ *     },
+ *   ],
+ * };
+ * const command = new UpdatePracticeRunConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdatePracticeRunConfigurationResponse
+ * //   arn: "STRING_VALUE", // required
+ * //   name: "STRING_VALUE", // required
+ * //   zonalAutoshiftStatus: "ENABLED" || "DISABLED", // required
+ * //   practiceRunConfiguration: { // PracticeRunConfiguration
+ * //     blockingAlarms: [ // ControlConditions
+ * //       { // ControlCondition
+ * //         type: "CLOUDWATCH", // required
+ * //         alarmIdentifier: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     outcomeAlarms: [ // required
+ * //       {
+ * //         type: "CLOUDWATCH", // required
+ * //         alarmIdentifier: "STRING_VALUE", // required
+ * //       },
+ * //     ],
+ * //     blockedWindows: [ // BlockedWindows
+ * //       "STRING_VALUE",
+ * //     ],
+ * //     blockedDates: [ // BlockedDates
+ * //       "STRING_VALUE",
+ * //     ],
+ * //   },
+ * // };
+ *
+ * ```
+ *
+ * @param UpdatePracticeRunConfigurationCommandInput - {@link UpdatePracticeRunConfigurationCommandInput}
+ * @returns {@link UpdatePracticeRunConfigurationCommandOutput}
+ * @see {@link UpdatePracticeRunConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdatePracticeRunConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be processed because of conflict in the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The input requested a resource that was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link ARCZonalShiftServiceException}
+ * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
+ *
+ */
+export declare class UpdatePracticeRunConfigurationCommand extends $Command<UpdatePracticeRunConfigurationCommandInput, UpdatePracticeRunConfigurationCommandOutput, ARCZonalShiftClientResolvedConfig> {
+    readonly input: UpdatePracticeRunConfigurationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdatePracticeRunConfigurationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdatePracticeRunConfigurationCommandInput, UpdatePracticeRunConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts

@@ -0,0 +1,96 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
+import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
+import { UpdateZonalAutoshiftConfigurationRequest, UpdateZonalAutoshiftConfigurationResponse } from "../models/models_0";
+/**
+ * @public
+ */
+export { __MetadataBearer, $Command };
+/**
+ * @public
+ *
+ * The input for {@link UpdateZonalAutoshiftConfigurationCommand}.
+ */
+export interface UpdateZonalAutoshiftConfigurationCommandInput extends UpdateZonalAutoshiftConfigurationRequest {
+}
+/**
+ * @public
+ *
+ * The output of {@link UpdateZonalAutoshiftConfigurationCommand}.
+ */
+export interface UpdateZonalAutoshiftConfigurationCommandOutput extends UpdateZonalAutoshiftConfigurationResponse, __MetadataBearer {
+}
+/**
+ * @public
+ * <p>You can update the zonal autoshift status for a resource, to enable or disable zonal
+ * 			autoshift. When zonal autoshift is <code>ENABLED</code>, Amazon Web Services shifts away
+ * 			resource traffic from an Availability Zone, on your behalf, when Amazon Web Services
+ * 			determines that there's an issue in the Availability Zone that could potentially affect customers.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { ARCZonalShiftClient, UpdateZonalAutoshiftConfigurationCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
+ * // const { ARCZonalShiftClient, UpdateZonalAutoshiftConfigurationCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
+ * const client = new ARCZonalShiftClient(config);
+ * const input = { // UpdateZonalAutoshiftConfigurationRequest
+ *   resourceIdentifier: "STRING_VALUE", // required
+ *   zonalAutoshiftStatus: "ENABLED" || "DISABLED", // required
+ * };
+ * const command = new UpdateZonalAutoshiftConfigurationCommand(input);
+ * const response = await client.send(command);
+ * // { // UpdateZonalAutoshiftConfigurationResponse
+ * //   resourceIdentifier: "STRING_VALUE", // required
+ * //   zonalAutoshiftStatus: "ENABLED" || "DISABLED", // required
+ * // };
+ *
+ * ```
+ *
+ * @param UpdateZonalAutoshiftConfigurationCommandInput - {@link UpdateZonalAutoshiftConfigurationCommandInput}
+ * @returns {@link UpdateZonalAutoshiftConfigurationCommandOutput}
+ * @see {@link UpdateZonalAutoshiftConfigurationCommandInput} for command's `input` shape.
+ * @see {@link UpdateZonalAutoshiftConfigurationCommandOutput} for command's `response` shape.
+ * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
+ *
+ * @throws {@link AccessDeniedException} (client fault)
+ *  <p>You do not have sufficient access to perform this action.</p>
+ *
+ * @throws {@link ConflictException} (client fault)
+ *  <p>The request could not be processed because of conflict in the current state of the resource.</p>
+ *
+ * @throws {@link InternalServerException} (server fault)
+ *  <p>There was an internal server error.</p>
+ *
+ * @throws {@link ResourceNotFoundException} (client fault)
+ *  <p>The input requested a resource that was not found.</p>
+ *
+ * @throws {@link ThrottlingException} (client fault)
+ *  <p>The request was denied due to request throttling.</p>
+ *
+ * @throws {@link ValidationException} (client fault)
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
+ *
+ * @throws {@link ARCZonalShiftServiceException}
+ * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
+ *
+ */
+export declare class UpdateZonalAutoshiftConfigurationCommand extends $Command<UpdateZonalAutoshiftConfigurationCommandInput, UpdateZonalAutoshiftConfigurationCommandOutput, ARCZonalShiftClientResolvedConfig> {
+    readonly input: UpdateZonalAutoshiftConfigurationCommandInput;
+    static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
+    constructor(input: UpdateZonalAutoshiftConfigurationCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateZonalAutoshiftConfigurationCommandInput, UpdateZonalAutoshiftConfigurationCommandOutput>;
+    /**
+     * @internal
+     */
+    private serialize;
+    /**
+     * @internal
+     */
+    private deserialize;
+}

package/dist-types/commands/UpdateZonalShiftCommand.d.ts

@@ -23,7 +23,7 @@ export interface UpdateZonalShiftCommandOutput extends ZonalShift, __MetadataBea
 }
 /**
  * @public
- * <p>Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your AWS account. You can update a zonal shift to set a new expiration, or
+ * <p>Update an active zonal shift in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account. You can update a zonal shift to set a new expiration, or
  *    	edit or replace the comment for the zonal shift. </p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -72,7 +72,7 @@ export interface UpdateZonalShiftCommandOutput extends ZonalShift, __MetadataBea
  *  <p>The request was denied due to request throttling.</p>
  *
  * @throws {@link ValidationException} (client fault)
- *  <p>The input fails to satisfy the constraints specified by an AWS service.</p>
+ *  <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
  *
  * @throws {@link ARCZonalShiftServiceException}
  * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>

package/dist-types/commands/index.d.ts

@@ -1,6 +1,11 @@
 export * from "./CancelZonalShiftCommand";
+export * from "./CreatePracticeRunConfigurationCommand";
+export * from "./DeletePracticeRunConfigurationCommand";
 export * from "./GetManagedResourceCommand";
+export * from "./ListAutoshiftsCommand";
 export * from "./ListManagedResourcesCommand";
 export * from "./ListZonalShiftsCommand";
 export * from "./StartZonalShiftCommand";
+export * from "./UpdatePracticeRunConfigurationCommand";
+export * from "./UpdateZonalAutoshiftConfigurationCommand";
 export * from "./UpdateZonalShiftCommand";

package/dist-types/index.d.ts

@@ -1,19 +1,31 @@
 /**
- * <p>This is the API Reference Guide for the zonal shift feature of Amazon Route 53 Application Recovery Controller. This guide is for developers who need detailed information about
- * 			zonal shift API actions, data types, and errors.</p>
- * 		       <p>Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.</p>
- * 		       <p>Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting
- * 			a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment
- * 			or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue
- * 			in one zone. </p>
- * 		       <p>Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts
- * 			in Route 53 ARC are managed resources in Route 53 ARC. You can start a zonal shift for any managed resource in your account in a Region.
- * 			At this time, you can only start a zonal shift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
- * 		       <p>Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially.
- * 			If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration.
- * 			You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.</p>
- * 		       <p>For more information about using zonal shift, 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 Zonal Shift API Reference Guide for Amazon Route 53 Application Recovery Controller (Route 53 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 a load balancer resource. Zonal autoshift
+ * 			is a capability in Route 53 ARC where Amazon Web Services shifts away application resource
+ * 			traffic from an Availability Zone, on your behalf, to help reduce your time to recovery during events.
+ * 			Amazon Web Services shifts away traffic for resources that are enabled for zonal autoshift whenever Amazon Web Services
+ * 			determines that there's an issue in the Availability Zone that could potentially affect
+ * 			customers.</p>
+ *          <p>To ensure 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 out of an Availability Zone. Practice runs 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>You must prescale resource capacity in all Availability Zones in the Region
+ * 			where your application is deployed, before you configure practice runs or enable zonal autoshift
+ * 			for a resource. You should not rely on scaling on demand when an autoshift or practice run
+ * 			starts. </p>
+ *          </important>
+ *          <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>
  *
  * @packageDocumentation
  */