@aws-sdk/client-arc-zonal-shift 3.839.0 → 3.840.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/README.md +17 -34
  2. package/dist-cjs/index.js +116 -8
  3. package/dist-es/ARCZonalShift.js +4 -0
  4. package/dist-es/commands/CancelPracticeRunCommand.js +22 -0
  5. package/dist-es/commands/StartPracticeRunCommand.js +22 -0
  6. package/dist-es/commands/index.js +2 -0
  7. package/dist-es/models/models_0.js +11 -5
  8. package/dist-es/protocols/Aws_restJson1.js +64 -0
  9. package/dist-types/ARCZonalShift.d.ts +15 -34
  10. package/dist-types/ARCZonalShiftClient.d.ts +5 -36
  11. package/dist-types/commands/CancelPracticeRunCommand.d.ts +96 -0
  12. package/dist-types/commands/CancelZonalShiftCommand.d.ts +1 -4
  13. package/dist-types/commands/CreatePracticeRunConfigurationCommand.d.ts +1 -11
  14. package/dist-types/commands/DeletePracticeRunConfigurationCommand.d.ts +1 -3
  15. package/dist-types/commands/GetAutoshiftObserverNotificationStatusCommand.d.ts +1 -2
  16. package/dist-types/commands/GetManagedResourceCommand.d.ts +2 -3
  17. package/dist-types/commands/ListAutoshiftsCommand.d.ts +1 -4
  18. package/dist-types/commands/ListManagedResourcesCommand.d.ts +2 -5
  19. package/dist-types/commands/ListZonalShiftsCommand.d.ts +2 -2
  20. package/dist-types/commands/StartPracticeRunCommand.d.ts +98 -0
  21. package/dist-types/commands/StartZonalShiftCommand.d.ts +1 -11
  22. package/dist-types/commands/UpdateAutoshiftObserverNotificationStatusCommand.d.ts +1 -11
  23. package/dist-types/commands/UpdatePracticeRunConfigurationCommand.d.ts +1 -3
  24. package/dist-types/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts +1 -8
  25. package/dist-types/commands/UpdateZonalShiftCommand.d.ts +1 -2
  26. package/dist-types/commands/index.d.ts +2 -0
  27. package/dist-types/index.d.ts +1 -34
  28. package/dist-types/models/models_0.d.ts +204 -417
  29. package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
  30. package/dist-types/ts3.4/ARCZonalShift.d.ts +34 -0
  31. package/dist-types/ts3.4/ARCZonalShiftClient.d.ts +12 -0
  32. package/dist-types/ts3.4/commands/CancelPracticeRunCommand.d.ts +51 -0
  33. package/dist-types/ts3.4/commands/StartPracticeRunCommand.d.ts +50 -0
  34. package/dist-types/ts3.4/commands/index.d.ts +2 -0
  35. package/dist-types/ts3.4/models/models_0.d.ts +40 -8
  36. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +24 -0
  37. package/package.json +12 -12
@@ -7,6 +7,7 @@ import { HttpHandlerUserInput as __HttpHandlerUserInput } from "@smithy/protocol
7
7
  import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
8
8
  import { AwsCredentialIdentityProvider, BodyLengthCalculator as __BodyLengthCalculator, CheckOptionalClientConfig as __CheckOptionalClientConfig, ChecksumConstructor as __ChecksumConstructor, Decoder as __Decoder, Encoder as __Encoder, HashConstructor as __HashConstructor, HttpHandlerOptions as __HttpHandlerOptions, Logger as __Logger, Provider as __Provider, Provider, StreamCollector as __StreamCollector, UrlParser as __UrlParser, UserAgent as __UserAgent } from "@smithy/types";
9
9
  import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/httpAuthSchemeProvider";
10
+ import { CancelPracticeRunCommandInput, CancelPracticeRunCommandOutput } from "./commands/CancelPracticeRunCommand";
10
11
  import { CancelZonalShiftCommandInput, CancelZonalShiftCommandOutput } from "./commands/CancelZonalShiftCommand";
11
12
  import { CreatePracticeRunConfigurationCommandInput, CreatePracticeRunConfigurationCommandOutput } from "./commands/CreatePracticeRunConfigurationCommand";
12
13
  import { DeletePracticeRunConfigurationCommandInput, DeletePracticeRunConfigurationCommandOutput } from "./commands/DeletePracticeRunConfigurationCommand";
@@ -15,6 +16,7 @@ import { GetManagedResourceCommandInput, GetManagedResourceCommandOutput } from
15
16
  import { ListAutoshiftsCommandInput, ListAutoshiftsCommandOutput } from "./commands/ListAutoshiftsCommand";
16
17
  import { ListManagedResourcesCommandInput, ListManagedResourcesCommandOutput } from "./commands/ListManagedResourcesCommand";
17
18
  import { ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput } from "./commands/ListZonalShiftsCommand";
19
+ import { StartPracticeRunCommandInput, StartPracticeRunCommandOutput } from "./commands/StartPracticeRunCommand";
18
20
  import { StartZonalShiftCommandInput, StartZonalShiftCommandOutput } from "./commands/StartZonalShiftCommand";
19
21
  import { UpdateAutoshiftObserverNotificationStatusCommandInput, UpdateAutoshiftObserverNotificationStatusCommandOutput } from "./commands/UpdateAutoshiftObserverNotificationStatusCommand";
20
22
  import { UpdatePracticeRunConfigurationCommandInput, UpdatePracticeRunConfigurationCommandOutput } from "./commands/UpdatePracticeRunConfigurationCommand";
@@ -26,11 +28,11 @@ export { __Client };
26
28
  /**
27
29
  * @public
28
30
  */
29
- export type ServiceInputTypes = CancelZonalShiftCommandInput | CreatePracticeRunConfigurationCommandInput | DeletePracticeRunConfigurationCommandInput | GetAutoshiftObserverNotificationStatusCommandInput | GetManagedResourceCommandInput | ListAutoshiftsCommandInput | ListManagedResourcesCommandInput | ListZonalShiftsCommandInput | StartZonalShiftCommandInput | UpdateAutoshiftObserverNotificationStatusCommandInput | UpdatePracticeRunConfigurationCommandInput | UpdateZonalAutoshiftConfigurationCommandInput | UpdateZonalShiftCommandInput;
31
+ export type ServiceInputTypes = CancelPracticeRunCommandInput | CancelZonalShiftCommandInput | CreatePracticeRunConfigurationCommandInput | DeletePracticeRunConfigurationCommandInput | GetAutoshiftObserverNotificationStatusCommandInput | GetManagedResourceCommandInput | ListAutoshiftsCommandInput | ListManagedResourcesCommandInput | ListZonalShiftsCommandInput | StartPracticeRunCommandInput | StartZonalShiftCommandInput | UpdateAutoshiftObserverNotificationStatusCommandInput | UpdatePracticeRunConfigurationCommandInput | UpdateZonalAutoshiftConfigurationCommandInput | UpdateZonalShiftCommandInput;
30
32
  /**
31
33
  * @public
32
34
  */
33
- export type ServiceOutputTypes = CancelZonalShiftCommandOutput | CreatePracticeRunConfigurationCommandOutput | DeletePracticeRunConfigurationCommandOutput | GetAutoshiftObserverNotificationStatusCommandOutput | GetManagedResourceCommandOutput | ListAutoshiftsCommandOutput | ListManagedResourcesCommandOutput | ListZonalShiftsCommandOutput | StartZonalShiftCommandOutput | UpdateAutoshiftObserverNotificationStatusCommandOutput | UpdatePracticeRunConfigurationCommandOutput | UpdateZonalAutoshiftConfigurationCommandOutput | UpdateZonalShiftCommandOutput;
35
+ export type ServiceOutputTypes = CancelPracticeRunCommandOutput | CancelZonalShiftCommandOutput | CreatePracticeRunConfigurationCommandOutput | DeletePracticeRunConfigurationCommandOutput | GetAutoshiftObserverNotificationStatusCommandOutput | GetManagedResourceCommandOutput | ListAutoshiftsCommandOutput | ListManagedResourcesCommandOutput | ListZonalShiftsCommandOutput | StartPracticeRunCommandOutput | StartZonalShiftCommandOutput | UpdateAutoshiftObserverNotificationStatusCommandOutput | UpdatePracticeRunConfigurationCommandOutput | UpdateZonalAutoshiftConfigurationCommandOutput | UpdateZonalShiftCommandOutput;
34
36
  /**
35
37
  * @public
36
38
  */
@@ -182,40 +184,7 @@ export type ARCZonalShiftClientResolvedConfigType = __SmithyResolvedConfiguratio
182
184
  export interface ARCZonalShiftClientResolvedConfig extends ARCZonalShiftClientResolvedConfigType {
183
185
  }
184
186
  /**
185
- * <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
186
- * <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
187
- * help your application recover quickly from an impairment in an Availability Zone. For example,
188
- * you can recover your application from a developer's bad code deployment or from an
189
- * Amazon Web Services infrastructure failure in a single Availability Zone.</p>
190
- * <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
191
- * is a capability in ARC where you authorize Amazon Web Services to shift away application resource
192
- * traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
193
- * Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
194
- * Zone impairment that could potentially impact customers.</p>
195
- * <p>To help make sure that zonal autoshift is safe for your application, you must
196
- * also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
197
- * weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone.
198
- * Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the
199
- * Availability Zones in an Amazon Web Services Region for your application to continue to operate normally
200
- * when traffic for a resource is shifted away from one Availability Zone.</p>
201
- * <important>
202
- * <p>Before you configure practice runs or enable zonal autoshift, we strongly recommend
203
- * that you prescale your application resource capacity in all Availability Zones in the Region where
204
- * your application resources are deployed. You should not rely on scaling on demand when an
205
- * autoshift or practice run starts. Zonal autoshift, including practice runs, works independently,
206
- * and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of
207
- * pre-scaling, can result in loss of availability.</p>
208
- * <p>If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure
209
- * the minimum capacity of your auto scaling to continue operating normally with the loss of an
210
- * Availability Zone. </p>
211
- * </important>
212
- * <p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
213
- * autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
214
- * potentially impact customers. In some cases, resources might be shifted away that are not experiencing
215
- * impact.</p>
216
- * <p>For more information about using zonal shift and zonal autoshift, see the
217
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
218
- * Developer Guide</a>.</p>
187
+ * <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>
219
188
  * @public
220
189
  */
221
190
  export declare class ARCZonalShiftClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ARCZonalShiftClientResolvedConfig> {
@@ -0,0 +1,96 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
4
+ import { CancelPracticeRunRequest, CancelPracticeRunResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CancelPracticeRunCommand}.
14
+ */
15
+ export interface CancelPracticeRunCommandInput extends CancelPracticeRunRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CancelPracticeRunCommand}.
21
+ */
22
+ export interface CancelPracticeRunCommandOutput extends CancelPracticeRunResponse, __MetadataBearer {
23
+ }
24
+ declare const CancelPracticeRunCommand_base: {
25
+ new (input: CancelPracticeRunCommandInput): import("@smithy/smithy-client").CommandImpl<CancelPracticeRunCommandInput, CancelPracticeRunCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: CancelPracticeRunCommandInput): import("@smithy/smithy-client").CommandImpl<CancelPracticeRunCommandInput, CancelPracticeRunCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Cancel an in-progress practice run zonal shift in Amazon Application Recovery Controller.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ARCZonalShiftClient, CancelPracticeRunCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
35
+ * // const { ARCZonalShiftClient, CancelPracticeRunCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
36
+ * const client = new ARCZonalShiftClient(config);
37
+ * const input = { // CancelPracticeRunRequest
38
+ * zonalShiftId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new CancelPracticeRunCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // CancelPracticeRunResponse
43
+ * // zonalShiftId: "STRING_VALUE", // required
44
+ * // resourceIdentifier: "STRING_VALUE", // required
45
+ * // awayFrom: "STRING_VALUE", // required
46
+ * // expiryTime: new Date("TIMESTAMP"), // required
47
+ * // startTime: new Date("TIMESTAMP"), // required
48
+ * // status: "ACTIVE" || "EXPIRED" || "CANCELED", // required
49
+ * // comment: "STRING_VALUE", // required
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param CancelPracticeRunCommandInput - {@link CancelPracticeRunCommandInput}
55
+ * @returns {@link CancelPracticeRunCommandOutput}
56
+ * @see {@link CancelPracticeRunCommandInput} for command's `input` shape.
57
+ * @see {@link CancelPracticeRunCommandOutput} for command's `response` shape.
58
+ * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
59
+ *
60
+ * @throws {@link AccessDeniedException} (client fault)
61
+ * <p>You do not have sufficient access to perform this action.</p>
62
+ *
63
+ * @throws {@link ConflictException} (client fault)
64
+ * <p>The request could not be processed because of conflict in the current state of the resource.</p>
65
+ *
66
+ * @throws {@link InternalServerException} (server fault)
67
+ * <p>There was an internal server error.</p>
68
+ *
69
+ * @throws {@link ResourceNotFoundException} (client fault)
70
+ * <p>The input requested a resource that was not found.</p>
71
+ *
72
+ * @throws {@link ThrottlingException} (client fault)
73
+ * <p>The request was denied due to request throttling.</p>
74
+ *
75
+ * @throws {@link ValidationException} (client fault)
76
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
77
+ *
78
+ * @throws {@link ARCZonalShiftServiceException}
79
+ * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
80
+ *
81
+ *
82
+ * @public
83
+ */
84
+ export declare class CancelPracticeRunCommand extends CancelPracticeRunCommand_base {
85
+ /** @internal type navigation helper, not in runtime. */
86
+ protected static __types: {
87
+ api: {
88
+ input: CancelPracticeRunRequest;
89
+ output: CancelPracticeRunResponse;
90
+ };
91
+ sdk: {
92
+ input: CancelPracticeRunCommandInput;
93
+ output: CancelPracticeRunCommandOutput;
94
+ };
95
+ };
96
+ }
@@ -27,10 +27,7 @@ declare const CancelZonalShiftCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.</p>
31
- * <p>A zonal shift can be one that you've started for a resource in your Amazon Web Services account
32
- * in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal
33
- * autoshift. </p>
30
+ * <p>Cancel a zonal shift in Amazon Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.</p> <p>A zonal shift can be one that you've started for a resource in your Amazon Web Services account in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal autoshift. </p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -27,17 +27,7 @@ declare const CreatePracticeRunConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>A practice run configuration for zonal autoshift is required when you enable zonal autoshift.
31
- * A practice run configuration includes specifications for blocked dates and blocked time windows,
32
- * and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an
33
- * <i>outcome alarm</i>, to monitor application health during practice runs and,
34
- * optionally, a <i>blocking alarm</i>, to block practice runs from starting.</p>
35
- * <p>When a resource has a practice run configuration, ARC starts zonal shifts for the resource
36
- * weekly, to shift traffic for practice runs. Practice runs help you to ensure that
37
- * shifting away traffic from an Availability Zone during an autoshift is safe for your application.</p>
38
- * <p>For more information, see
39
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html">
40
- * Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
30
+ * <p>A practice run configuration for zonal autoshift is required when you enable zonal autoshift. A practice run configuration includes specifications for blocked dates and blocked time windows, and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an <i>outcome alarm</i>, to monitor application health during practice runs and, optionally, a <i>blocking alarm</i>, to block practice runs from starting.</p> <p>When a resource has a practice run configuration, ARC starts zonal shifts for the resource weekly, to shift traffic for practice runs. Practice runs help you to ensure that shifting away traffic from an Availability Zone during an autoshift is safe for your application.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html"> Considerations when you configure zonal autoshift</a> in the Amazon Application Recovery Controller Developer Guide.</p>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const DeletePracticeRunConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Deletes the practice run configuration for a resource. Before you can delete
31
- * a practice run configuration for a resource., you must disable zonal autoshift for
32
- * the resource. Practice runs must be configured for zonal autoshift to be enabled.</p>
30
+ * <p>Deletes the practice run configuration for a resource. Before you can delete a practice run configuration for a resource., you must disable zonal autoshift for the resource. Practice runs must be configured for zonal autoshift to be enabled.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const GetAutoshiftObserverNotificationStatusCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be <code>ENABLED</code> or <code>DISABLED</code>. When <code>ENABLED</code>, a notification is sent when an autoshift is triggered. When <code>DISABLED</code>, notifications are not sent.
31
- * </p>
30
+ * <p>Returns the status of the autoshift observer notification. Autoshift observer notifications notify you through Amazon EventBridge when there is an autoshift event for zonal autoshift. The status can be <code>ENABLED</code> or <code>DISABLED</code>. When <code>ENABLED</code>, a notification is sent when an autoshift is triggered. When <code>DISABLED</code>, notifications are not sent. </p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const GetManagedResourceCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for
31
- * zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.</p>
30
+ * <p>Get information about a resource that's been registered for zonal shifts with Amazon Application Recovery Controller in this Amazon Web Services Region. Resources that are registered for zonal shifts are managed resources in ARC. You can start zonal shifts and configure zonal autoshift for managed resources.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -56,7 +55,7 @@ declare const GetManagedResourceCommand_base: {
56
55
  * // startTime: new Date("TIMESTAMP"), // required
57
56
  * // comment: "STRING_VALUE", // required
58
57
  * // shiftType: "ZONAL_SHIFT" || "PRACTICE_RUN" || "FIS_EXPERIMENT" || "ZONAL_AUTOSHIFT",
59
- * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
58
+ * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED" || "CAPACITY_CHECK_FAILED",
60
59
  * // },
61
60
  * // ],
62
61
  * // autoshifts: [ // AutoshiftsInResource
@@ -27,10 +27,7 @@ declare const ListAutoshiftsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the autoshifts for an Amazon Web Services Region. By default, the call returns
31
- * only <code>ACTIVE</code> autoshifts. Optionally, you can specify the <code>status</code> parameter to return
32
- * <code>COMPLETED</code> autoshifts.
33
- * </p>
30
+ * <p>Returns the autoshifts for an Amazon Web Services Region. By default, the call returns only <code>ACTIVE</code> autoshifts. Optionally, you can specify the <code>status</code> parameter to return <code>COMPLETED</code> autoshifts. </p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -27,10 +27,7 @@ declare const ListManagedResourcesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for
31
- * zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource,
32
- * as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and
33
- * the resource name.</p>
30
+ * <p>Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for zonal shifts in Amazon Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and the resource name.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -64,7 +61,7 @@ declare const ListManagedResourcesCommand_base: {
64
61
  * // startTime: new Date("TIMESTAMP"), // required
65
62
  * // comment: "STRING_VALUE", // required
66
63
  * // shiftType: "ZONAL_SHIFT" || "PRACTICE_RUN" || "FIS_EXPERIMENT" || "ZONAL_AUTOSHIFT",
67
- * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
64
+ * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED" || "CAPACITY_CHECK_FAILED",
68
65
  * // },
69
66
  * // ],
70
67
  * // autoshifts: [ // AutoshiftsInResource
@@ -27,7 +27,7 @@ declare const ListZonalShiftsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists all active and completed zonal shifts in Amazon Route 53 Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region.</p>
30
+ * <p>Lists all active and completed zonal shifts in Amazon Application Recovery Controller in your Amazon Web Services account in this Amazon Web Services Region. <code>ListZonalShifts</code> returns customer-initiated zonal shifts, as well as practice run zonal shifts that ARC started on your behalf for zonal autoshift.</p> <p>For more information about listing autoshifts, see <a href="https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html">"&gt;ListAutoshifts</a>.</p>
31
31
  * @example
32
32
  * Use a bare-bones client and the command you need to make an API call.
33
33
  * ```javascript
@@ -53,7 +53,7 @@ declare const ListZonalShiftsCommand_base: {
53
53
  * // status: "ACTIVE" || "EXPIRED" || "CANCELED", // required
54
54
  * // comment: "STRING_VALUE", // required
55
55
  * // shiftType: "ZONAL_SHIFT" || "PRACTICE_RUN" || "FIS_EXPERIMENT" || "ZONAL_AUTOSHIFT",
56
- * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
56
+ * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED" || "CAPACITY_CHECK_FAILED",
57
57
  * // },
58
58
  * // ],
59
59
  * // nextToken: "STRING_VALUE",
@@ -0,0 +1,98 @@
1
+ import { Command as $Command } from "@smithy/smithy-client";
2
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
3
+ import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
4
+ import { StartPracticeRunRequest, StartPracticeRunResponse } from "../models/models_0";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link StartPracticeRunCommand}.
14
+ */
15
+ export interface StartPracticeRunCommandInput extends StartPracticeRunRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link StartPracticeRunCommand}.
21
+ */
22
+ export interface StartPracticeRunCommandOutput extends StartPracticeRunResponse, __MetadataBearer {
23
+ }
24
+ declare const StartPracticeRunCommand_base: {
25
+ new (input: StartPracticeRunCommandInput): import("@smithy/smithy-client").CommandImpl<StartPracticeRunCommandInput, StartPracticeRunCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (input: StartPracticeRunCommandInput): import("@smithy/smithy-client").CommandImpl<StartPracticeRunCommandInput, StartPracticeRunCommandOutput, ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * <p>Start an on-demand practice run zonal shift in Amazon Application Recovery Controller. With zonal autoshift enabled, you can start an on-demand practice run to verify preparedness at any time. Amazon Web Services also runs automated practice runs about weekly when you have enabled zonal autoshift.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html"> Considerations when you configure zonal autoshift</a> in the Amazon Application Recovery Controller Developer Guide.</p>
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { ARCZonalShiftClient, StartPracticeRunCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
35
+ * // const { ARCZonalShiftClient, StartPracticeRunCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
36
+ * const client = new ARCZonalShiftClient(config);
37
+ * const input = { // StartPracticeRunRequest
38
+ * resourceIdentifier: "STRING_VALUE", // required
39
+ * awayFrom: "STRING_VALUE", // required
40
+ * comment: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new StartPracticeRunCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // StartPracticeRunResponse
45
+ * // zonalShiftId: "STRING_VALUE", // required
46
+ * // resourceIdentifier: "STRING_VALUE", // required
47
+ * // awayFrom: "STRING_VALUE", // required
48
+ * // expiryTime: new Date("TIMESTAMP"), // required
49
+ * // startTime: new Date("TIMESTAMP"), // required
50
+ * // status: "ACTIVE" || "EXPIRED" || "CANCELED", // required
51
+ * // comment: "STRING_VALUE", // required
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param StartPracticeRunCommandInput - {@link StartPracticeRunCommandInput}
57
+ * @returns {@link StartPracticeRunCommandOutput}
58
+ * @see {@link StartPracticeRunCommandInput} for command's `input` shape.
59
+ * @see {@link StartPracticeRunCommandOutput} for command's `response` shape.
60
+ * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
61
+ *
62
+ * @throws {@link AccessDeniedException} (client fault)
63
+ * <p>You do not have sufficient access to perform this action.</p>
64
+ *
65
+ * @throws {@link ConflictException} (client fault)
66
+ * <p>The request could not be processed because of conflict in the current state of the resource.</p>
67
+ *
68
+ * @throws {@link InternalServerException} (server fault)
69
+ * <p>There was an internal server error.</p>
70
+ *
71
+ * @throws {@link ResourceNotFoundException} (client fault)
72
+ * <p>The input requested a resource that was not found.</p>
73
+ *
74
+ * @throws {@link ThrottlingException} (client fault)
75
+ * <p>The request was denied due to request throttling.</p>
76
+ *
77
+ * @throws {@link ValidationException} (client fault)
78
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
79
+ *
80
+ * @throws {@link ARCZonalShiftServiceException}
81
+ * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
82
+ *
83
+ *
84
+ * @public
85
+ */
86
+ export declare class StartPracticeRunCommand extends StartPracticeRunCommand_base {
87
+ /** @internal type navigation helper, not in runtime. */
88
+ protected static __types: {
89
+ api: {
90
+ input: StartPracticeRunRequest;
91
+ output: StartPracticeRunResponse;
92
+ };
93
+ sdk: {
94
+ input: StartPracticeRunCommandInput;
95
+ output: StartPracticeRunCommandOutput;
96
+ };
97
+ };
98
+ }
@@ -27,17 +27,7 @@ declare const StartZonalShiftCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region,
31
- * to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services
32
- * infrastructure failure in a single Availability Zone. You can start a zonal shift in ARC only for managed
33
- * resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with ARC
34
- * by Amazon Web Services services.</p>
35
- * <p>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>
36
- * <p>When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The
37
- * zonal shift is created immediately in ARC. However, it can take a short time, typically up to a few minutes,
38
- * for existing, in-progress connections in the Availability Zone to complete.</p>
39
- * <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html">Zonal shift</a>
40
- * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
30
+ * <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region, to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services infrastructure failure in a single Availability Zone. You can start a zonal shift in ARC only for managed resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with ARC by Amazon Web Services services.</p> <p>Amazon Application Recovery Controller currently supports enabling the following resources for zonal shift and zonal autoshift:</p> <ul> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.ec2-auto-scaling-groups.html">Amazon EC2 Auto Scaling groups</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.eks.html">Amazon Elastic Kubernetes Service</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.app-load-balancers.html">Application Load Balancer</a> </p> </li> <li> <p> <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.resource-types.network-load-balancers.html">Network Load Balancer</a> </p> </li> </ul> <p>When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The zonal shift is created immediately in ARC. However, it can take a short time, typically up to a few minutes, for existing, in-progress connections in the Availability Zone to complete.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html">Zonal shift</a> in the Amazon Application Recovery Controller Developer Guide.</p>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -27,17 +27,7 @@ declare const UpdateAutoshiftObserverNotificationStatusCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Update the status of autoshift observer notification. Autoshift observer
31
- * notification enables you to be notified, through Amazon EventBridge, when
32
- * there is an autoshift event for zonal autoshift.</p>
33
- * <p>If the status is <code>ENABLED</code>,
34
- * ARC includes all autoshift events when you use the EventBridge pattern
35
- * <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>,
36
- * ARC includes only autoshift events for autoshifts when one or more of your
37
- * resources is included in the autoshift.</p>
38
- * <p>For more information, see
39
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html#ZAShiftNotification">
40
- * Notifications for practice runs and autoshifts</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
30
+ * <p>Update the status of autoshift observer notification. Autoshift observer notification enables you to be notified, through Amazon EventBridge, when there is an autoshift event for zonal autoshift.</p> <p>If the status is <code>ENABLED</code>, ARC includes all autoshift events when you use the EventBridge pattern <code>Autoshift In Progress</code>. When the status is <code>DISABLED</code>, ARC includes only autoshift events for autoshifts when one or more of your resources is included in the autoshift.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html#ZAShiftNotification"> Notifications for practice runs and autoshifts</a> in the Amazon Application Recovery Controller Developer Guide.</p>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const UpdatePracticeRunConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Update a practice run configuration to change one or more of the following: add,
31
- * change, or remove the blocking alarm; change the outcome alarm; or add, change,
32
- * or remove blocking dates or time windows.</p>
30
+ * <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>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,14 +27,7 @@ declare const UpdateZonalAutoshiftConfigurationCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>The zonal autoshift configuration for a resource includes the practice run configuration and the status for
31
- * running autoshifts, zonal autoshift status. When a resource has a practice run configuation, Route 53 ARC
32
- * starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice
33
- * runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.</p>
34
- * <p>You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal
35
- * autoshift is <code>ENABLED</code>, you authorize Amazon Web Services to shift away resource traffic for
36
- * an application from an Availability Zone during events, on your behalf, to help reduce time to recovery.
37
- * Traffic is also shifted away for the required weekly practice runs.</p>
30
+ * <p>The zonal autoshift configuration for a resource includes the practice run configuration and the status for running autoshifts, zonal autoshift status. When a resource has a practice run configuation, ARC starts weekly zonal shifts for the resource, to shift traffic away from an Availability Zone. Weekly practice runs help you to make sure that your application can continue to operate normally with the loss of one Availability Zone.</p> <p>You can update the zonal autoshift autoshift status to enable or disable zonal autoshift. When zonal autoshift is <code>ENABLED</code>, you authorize Amazon Web Services to shift away resource traffic for an application from an Availability Zone during events, on your behalf, to help reduce time to recovery. Traffic is also shifted away for the required weekly practice runs.</p>
38
31
  * @example
39
32
  * Use a bare-bones client and the command you need to make an API call.
40
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const UpdateZonalShiftCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <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
31
- * edit or replace the comment for the zonal shift.</p>
30
+ * <p>Update an active zonal shift in Amazon 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>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -1,3 +1,4 @@
1
+ export * from "./CancelPracticeRunCommand";
1
2
  export * from "./CancelZonalShiftCommand";
2
3
  export * from "./CreatePracticeRunConfigurationCommand";
3
4
  export * from "./DeletePracticeRunConfigurationCommand";
@@ -6,6 +7,7 @@ export * from "./GetManagedResourceCommand";
6
7
  export * from "./ListAutoshiftsCommand";
7
8
  export * from "./ListManagedResourcesCommand";
8
9
  export * from "./ListZonalShiftsCommand";
10
+ export * from "./StartPracticeRunCommand";
9
11
  export * from "./StartZonalShiftCommand";
10
12
  export * from "./UpdateAutoshiftObserverNotificationStatusCommand";
11
13
  export * from "./UpdatePracticeRunConfigurationCommand";
@@ -1,38 +1,5 @@
1
1
  /**
2
- * <p>Welcome to the API Reference Guide for zonal shift and zonal autoshift in Amazon Route 53 Application Recovery Controller (ARC).</p>
3
- * <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
4
- * help your application recover quickly from an impairment in an Availability Zone. For example,
5
- * you can recover your application from a developer's bad code deployment or from an
6
- * Amazon Web Services infrastructure failure in a single Availability Zone.</p>
7
- * <p>You can also configure zonal autoshift for supported load balancer resources. Zonal autoshift
8
- * is a capability in ARC where you authorize Amazon Web Services to shift away application resource
9
- * traffic from an Availability Zone during events, on your behalf, to help reduce your time to recovery.
10
- * Amazon Web Services starts an autoshift when internal telemetry indicates that there is an Availability
11
- * Zone impairment that could potentially impact customers.</p>
12
- * <p>To help make sure that zonal autoshift is safe for your application, you must
13
- * also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
14
- * weekly zonal shifts for a resource, to shift traffic for the resource away from an Availability Zone.
15
- * Practice runs help you to make sure, on a regular basis, that you have enough capacity in all the
16
- * Availability Zones in an Amazon Web Services Region for your application to continue to operate normally
17
- * when traffic for a resource is shifted away from one Availability Zone.</p>
18
- * <important>
19
- * <p>Before you configure practice runs or enable zonal autoshift, we strongly recommend
20
- * that you prescale your application resource capacity in all Availability Zones in the Region where
21
- * your application resources are deployed. You should not rely on scaling on demand when an
22
- * autoshift or practice run starts. Zonal autoshift, including practice runs, works independently,
23
- * and does not wait for auto scaling actions to complete. Relying on auto scaling, instead of
24
- * pre-scaling, can result in loss of availability.</p>
25
- * <p>If you use auto scaling to handle regular cycles of traffic, we strongly recommend that you configure
26
- * the minimum capacity of your auto scaling to continue operating normally with the loss of an
27
- * Availability Zone. </p>
28
- * </important>
29
- * <p>Be aware that ARC does not inspect the health of individual resources. Amazon Web Services only starts an
30
- * autoshift when Amazon Web Services telemetry detects that there is an Availability Zone impairment that could
31
- * potentially impact customers. In some cases, resources might be shifted away that are not experiencing
32
- * impact.</p>
33
- * <p>For more information about using zonal shift and zonal autoshift, see the
34
- * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
35
- * Developer Guide</a>.</p>
2
+ * <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>
36
3
  *
37
4
  * @packageDocumentation
38
5
  */