@aws-sdk/client-arc-zonal-shift 3.461.0 → 3.464.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 (55) hide show
  1. package/README.md +74 -22
  2. package/dist-cjs/ARCZonalShift.js +10 -0
  3. package/dist-cjs/commands/CreatePracticeRunConfigurationCommand.js +51 -0
  4. package/dist-cjs/commands/DeletePracticeRunConfigurationCommand.js +51 -0
  5. package/dist-cjs/commands/ListAutoshiftsCommand.js +51 -0
  6. package/dist-cjs/commands/UpdatePracticeRunConfigurationCommand.js +51 -0
  7. package/dist-cjs/commands/UpdateZonalAutoshiftConfigurationCommand.js +51 -0
  8. package/dist-cjs/commands/index.js +5 -0
  9. package/dist-cjs/models/models_0.js +61 -34
  10. package/dist-cjs/pagination/ListAutoshiftsPaginator.js +29 -0
  11. package/dist-cjs/pagination/index.js +1 -0
  12. package/dist-cjs/protocols/Aws_restJson1.js +419 -2
  13. package/dist-es/ARCZonalShift.js +10 -0
  14. package/dist-es/commands/CreatePracticeRunConfigurationCommand.js +47 -0
  15. package/dist-es/commands/DeletePracticeRunConfigurationCommand.js +47 -0
  16. package/dist-es/commands/ListAutoshiftsCommand.js +47 -0
  17. package/dist-es/commands/UpdatePracticeRunConfigurationCommand.js +47 -0
  18. package/dist-es/commands/UpdateZonalAutoshiftConfigurationCommand.js +47 -0
  19. package/dist-es/commands/index.js +5 -0
  20. package/dist-es/models/models_0.js +58 -31
  21. package/dist-es/pagination/ListAutoshiftsPaginator.js +25 -0
  22. package/dist-es/pagination/index.js +1 -0
  23. package/dist-es/protocols/Aws_restJson1.js +408 -1
  24. package/dist-types/ARCZonalShift.d.ts +62 -15
  25. package/dist-types/ARCZonalShiftClient.d.ts +34 -17
  26. package/dist-types/commands/CancelZonalShiftCommand.d.ts +5 -2
  27. package/dist-types/commands/CreatePracticeRunConfigurationCommand.d.ts +138 -0
  28. package/dist-types/commands/DeletePracticeRunConfigurationCommand.d.ts +95 -0
  29. package/dist-types/commands/GetManagedResourceCommand.d.ts +33 -4
  30. package/dist-types/commands/ListAutoshiftsCommand.d.ts +95 -0
  31. package/dist-types/commands/ListManagedResourcesCommand.d.ts +28 -3
  32. package/dist-types/commands/ListZonalShiftsCommand.d.ts +8 -2
  33. package/dist-types/commands/StartZonalShiftCommand.d.ts +8 -7
  34. package/dist-types/commands/UpdatePracticeRunConfigurationCommand.d.ts +133 -0
  35. package/dist-types/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts +96 -0
  36. package/dist-types/commands/UpdateZonalShiftCommand.d.ts +2 -2
  37. package/dist-types/commands/index.d.ts +5 -0
  38. package/dist-types/index.d.ts +27 -15
  39. package/dist-types/models/models_0.d.ts +698 -95
  40. package/dist-types/pagination/ListAutoshiftsPaginator.d.ts +7 -0
  41. package/dist-types/pagination/index.d.ts +1 -0
  42. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  43. package/dist-types/ts3.4/ARCZonalShift.d.ts +91 -0
  44. package/dist-types/ts3.4/ARCZonalShiftClient.d.ts +30 -0
  45. package/dist-types/ts3.4/commands/CreatePracticeRunConfigurationCommand.d.ts +42 -0
  46. package/dist-types/ts3.4/commands/DeletePracticeRunConfigurationCommand.d.ts +42 -0
  47. package/dist-types/ts3.4/commands/ListAutoshiftsCommand.d.ts +38 -0
  48. package/dist-types/ts3.4/commands/UpdatePracticeRunConfigurationCommand.d.ts +42 -0
  49. package/dist-types/ts3.4/commands/UpdateZonalAutoshiftConfigurationCommand.d.ts +42 -0
  50. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  51. package/dist-types/ts3.4/models/models_0.d.ts +143 -23
  52. package/dist-types/ts3.4/pagination/ListAutoshiftsPaginator.d.ts +11 -0
  53. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  54. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  55. package/package.json +2 -2
@@ -9,10 +9,15 @@ import { HttpHandler as __HttpHandler } from "@smithy/protocol-http";
9
9
  import { Client as __Client, DefaultsMode as __DefaultsMode, SmithyConfiguration as __SmithyConfiguration, SmithyResolvedConfiguration as __SmithyResolvedConfiguration } from "@smithy/smithy-client";
10
10
  import { 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";
11
11
  import { CancelZonalShiftCommandInput, CancelZonalShiftCommandOutput } from "./commands/CancelZonalShiftCommand";
12
+ import { CreatePracticeRunConfigurationCommandInput, CreatePracticeRunConfigurationCommandOutput } from "./commands/CreatePracticeRunConfigurationCommand";
13
+ import { DeletePracticeRunConfigurationCommandInput, DeletePracticeRunConfigurationCommandOutput } from "./commands/DeletePracticeRunConfigurationCommand";
12
14
  import { GetManagedResourceCommandInput, GetManagedResourceCommandOutput } from "./commands/GetManagedResourceCommand";
15
+ import { ListAutoshiftsCommandInput, ListAutoshiftsCommandOutput } from "./commands/ListAutoshiftsCommand";
13
16
  import { ListManagedResourcesCommandInput, ListManagedResourcesCommandOutput } from "./commands/ListManagedResourcesCommand";
14
17
  import { ListZonalShiftsCommandInput, ListZonalShiftsCommandOutput } from "./commands/ListZonalShiftsCommand";
15
18
  import { StartZonalShiftCommandInput, StartZonalShiftCommandOutput } from "./commands/StartZonalShiftCommand";
19
+ import { UpdatePracticeRunConfigurationCommandInput, UpdatePracticeRunConfigurationCommandOutput } from "./commands/UpdatePracticeRunConfigurationCommand";
20
+ import { UpdateZonalAutoshiftConfigurationCommandInput, UpdateZonalAutoshiftConfigurationCommandOutput } from "./commands/UpdateZonalAutoshiftConfigurationCommand";
16
21
  import { UpdateZonalShiftCommandInput, UpdateZonalShiftCommandOutput } from "./commands/UpdateZonalShiftCommand";
17
22
  import { ClientInputEndpointParameters, ClientResolvedEndpointParameters, EndpointParameters } from "./endpoint/EndpointParameters";
18
23
  import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
@@ -20,11 +25,11 @@ export { __Client };
20
25
  /**
21
26
  * @public
22
27
  */
23
- export type ServiceInputTypes = CancelZonalShiftCommandInput | GetManagedResourceCommandInput | ListManagedResourcesCommandInput | ListZonalShiftsCommandInput | StartZonalShiftCommandInput | UpdateZonalShiftCommandInput;
28
+ export type ServiceInputTypes = CancelZonalShiftCommandInput | CreatePracticeRunConfigurationCommandInput | DeletePracticeRunConfigurationCommandInput | GetManagedResourceCommandInput | ListAutoshiftsCommandInput | ListManagedResourcesCommandInput | ListZonalShiftsCommandInput | StartZonalShiftCommandInput | UpdatePracticeRunConfigurationCommandInput | UpdateZonalAutoshiftConfigurationCommandInput | UpdateZonalShiftCommandInput;
24
29
  /**
25
30
  * @public
26
31
  */
27
- export type ServiceOutputTypes = CancelZonalShiftCommandOutput | GetManagedResourceCommandOutput | ListManagedResourcesCommandOutput | ListZonalShiftsCommandOutput | StartZonalShiftCommandOutput | UpdateZonalShiftCommandOutput;
32
+ export type ServiceOutputTypes = CancelZonalShiftCommandOutput | CreatePracticeRunConfigurationCommandOutput | DeletePracticeRunConfigurationCommandOutput | GetManagedResourceCommandOutput | ListAutoshiftsCommandOutput | ListManagedResourcesCommandOutput | ListZonalShiftsCommandOutput | StartZonalShiftCommandOutput | UpdatePracticeRunConfigurationCommandOutput | UpdateZonalAutoshiftConfigurationCommandOutput | UpdateZonalShiftCommandOutput;
28
33
  /**
29
34
  * @public
30
35
  */
@@ -158,21 +163,33 @@ export interface ARCZonalShiftClientResolvedConfig extends ARCZonalShiftClientRe
158
163
  }
159
164
  /**
160
165
  * @public
161
- * <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
162
- * zonal shift API actions, data types, and errors.</p>
163
- * <p>Zonal shift is in preview release for Amazon Route 53 Application Recovery Controller and is subject to change.</p>
164
- * <p>Zonal shift in Route 53 ARC enables you to move traffic for a load balancer resource away from an Availability Zone. Starting
165
- * a zonal shift helps your application recover immediately, for example, from a developer's bad code deployment
166
- * or from an AWS infrastructure failure in a single Availability Zone, reducing the impact and time lost from an issue
167
- * in one zone. </p>
168
- * <p>Supported AWS resources are automatically registered with Route 53 ARC. Resources that are registered for zonal shifts
169
- * 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.
170
- * 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>
171
- * <p>Zonal shifts are temporary. You must specify an expiration when you start a zonal shift, of up to three days initially.
172
- * If you want to still keep traffic away from an Availability Zone, you can update the zonal shift and set a new expiration.
173
- * You can also cancel a zonal shift, before it expires, for example, if you're ready to restore traffic to the Availability Zone.</p>
174
- * <p>For more information about using zonal shift, see the
175
- * <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>
166
+ * <p>Welcome to the Zonal Shift API Reference Guide for Amazon Route 53 Application Recovery Controller (Route 53 ARC).</p>
167
+ * <p>You can start a zonal shift to move traffic for a load balancer resource away from an Availability Zone to
168
+ * help your application recover quickly from an impairment in an Availability Zone. For example,
169
+ * you can recover your application from a developer's bad code deployment or from an
170
+ * Amazon Web Services infrastructure failure in a single Availability Zone.</p>
171
+ * <p>You can also configure zonal autoshift for a load balancer resource. Zonal autoshift
172
+ * is a capability in Route 53 ARC where Amazon Web Services shifts away application resource
173
+ * traffic from an Availability Zone, on your behalf, to help reduce your time to recovery during events.
174
+ * Amazon Web Services shifts away traffic for resources that are enabled for zonal autoshift whenever Amazon Web Services
175
+ * determines that there's an issue in the Availability Zone that could potentially affect
176
+ * customers.</p>
177
+ * <p>To ensure that zonal autoshift is safe for your application, you must
178
+ * also configure practice runs when you enable zonal autoshift for a resource. Practice runs start
179
+ * weekly zonal shifts for a resource, to shift
180
+ * traffic for the resource out of an Availability Zone. Practice runs make sure, on a regular basis,
181
+ * that you have enough capacity in all the Availability Zones in an Amazon Web Services Region
182
+ * for your application to continue to operate normally
183
+ * when traffic for a resource is shifted away from one Availability Zone.</p>
184
+ * <important>
185
+ * <p>You must prescale resource capacity in all Availability Zones in the Region
186
+ * where your application is deployed, before you configure practice runs or enable zonal autoshift
187
+ * for a resource. You should not rely on scaling on demand when an autoshift or practice run
188
+ * starts. </p>
189
+ * </important>
190
+ * <p>For more information about using zonal shift and zonal autoshift, see the
191
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/what-is-route53-recovery.html">Amazon Route 53 Application Recovery Controller
192
+ * Developer Guide</a>.</p>
176
193
  */
177
194
  export declare class ARCZonalShiftClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, ARCZonalShiftClientResolvedConfig> {
178
195
  /**
@@ -23,7 +23,10 @@ export interface CancelZonalShiftCommandOutput extends ZonalShift, __MetadataBea
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Cancel a zonal shift in Amazon Route 53 Application Recovery Controller that you've started for a resource in your AWS account in an AWS Region. </p>
26
+ * <p>Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.</p>
27
+ * <p>A zonal shift can be one that you've started for a resource in your Amazon Web Services account
28
+ * in an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal
29
+ * autoshift. </p>
27
30
  * @example
28
31
  * Use a bare-bones client and the command you need to make an API call.
29
32
  * ```javascript
@@ -69,7 +72,7 @@ export interface CancelZonalShiftCommandOutput extends ZonalShift, __MetadataBea
69
72
  * <p>The request was denied due to request throttling.</p>
70
73
  *
71
74
  * @throws {@link ValidationException} (client fault)
72
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
75
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
73
76
  *
74
77
  * @throws {@link ARCZonalShiftServiceException}
75
78
  * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
@@ -0,0 +1,138 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
+ import { CreatePracticeRunConfigurationRequest, CreatePracticeRunConfigurationResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link CreatePracticeRunConfigurationCommand}.
14
+ */
15
+ export interface CreatePracticeRunConfigurationCommandInput extends CreatePracticeRunConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link CreatePracticeRunConfigurationCommand}.
21
+ */
22
+ export interface CreatePracticeRunConfigurationCommandOutput extends CreatePracticeRunConfigurationResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>A practice run configuration for zonal autoshift is required when you enable zonal autoshift.
27
+ * A practice run configuration includes specifications for blocked dates and blocked time windows,
28
+ * and for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an
29
+ * <i>outcome alarm</i>, to monitor application health during practice runs and,
30
+ * optionally, a <i>blocking alarm</i>, to block practice runs from starting.</p>
31
+ * <p>For more information, see
32
+ * <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html">
33
+ * Considerations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { ARCZonalShiftClient, CreatePracticeRunConfigurationCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
38
+ * // const { ARCZonalShiftClient, CreatePracticeRunConfigurationCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
39
+ * const client = new ARCZonalShiftClient(config);
40
+ * const input = { // CreatePracticeRunConfigurationRequest
41
+ * resourceIdentifier: "STRING_VALUE", // required
42
+ * blockedWindows: [ // BlockedWindows
43
+ * "STRING_VALUE",
44
+ * ],
45
+ * blockedDates: [ // BlockedDates
46
+ * "STRING_VALUE",
47
+ * ],
48
+ * blockingAlarms: [ // ControlConditions
49
+ * { // ControlCondition
50
+ * type: "CLOUDWATCH", // required
51
+ * alarmIdentifier: "STRING_VALUE", // required
52
+ * },
53
+ * ],
54
+ * outcomeAlarms: [ // required
55
+ * {
56
+ * type: "CLOUDWATCH", // required
57
+ * alarmIdentifier: "STRING_VALUE", // required
58
+ * },
59
+ * ],
60
+ * };
61
+ * const command = new CreatePracticeRunConfigurationCommand(input);
62
+ * const response = await client.send(command);
63
+ * // { // CreatePracticeRunConfigurationResponse
64
+ * // arn: "STRING_VALUE", // required
65
+ * // name: "STRING_VALUE", // required
66
+ * // zonalAutoshiftStatus: "ENABLED" || "DISABLED", // required
67
+ * // practiceRunConfiguration: { // PracticeRunConfiguration
68
+ * // blockingAlarms: [ // ControlConditions
69
+ * // { // ControlCondition
70
+ * // type: "CLOUDWATCH", // required
71
+ * // alarmIdentifier: "STRING_VALUE", // required
72
+ * // },
73
+ * // ],
74
+ * // outcomeAlarms: [ // required
75
+ * // {
76
+ * // type: "CLOUDWATCH", // required
77
+ * // alarmIdentifier: "STRING_VALUE", // required
78
+ * // },
79
+ * // ],
80
+ * // blockedWindows: [ // BlockedWindows
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // blockedDates: [ // BlockedDates
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // },
87
+ * // };
88
+ *
89
+ * ```
90
+ *
91
+ * @param CreatePracticeRunConfigurationCommandInput - {@link CreatePracticeRunConfigurationCommandInput}
92
+ * @returns {@link CreatePracticeRunConfigurationCommandOutput}
93
+ * @see {@link CreatePracticeRunConfigurationCommandInput} for command's `input` shape.
94
+ * @see {@link CreatePracticeRunConfigurationCommandOutput} for command's `response` shape.
95
+ * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
96
+ *
97
+ * @throws {@link AccessDeniedException} (client fault)
98
+ * <p>You do not have sufficient access to perform this action.</p>
99
+ *
100
+ * @throws {@link ConflictException} (client fault)
101
+ * <p>The request could not be processed because of conflict in the current state of the resource.</p>
102
+ *
103
+ * @throws {@link InternalServerException} (server fault)
104
+ * <p>There was an internal server error.</p>
105
+ *
106
+ * @throws {@link ResourceNotFoundException} (client fault)
107
+ * <p>The input requested a resource that was not found.</p>
108
+ *
109
+ * @throws {@link ThrottlingException} (client fault)
110
+ * <p>The request was denied due to request throttling.</p>
111
+ *
112
+ * @throws {@link ValidationException} (client fault)
113
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
114
+ *
115
+ * @throws {@link ARCZonalShiftServiceException}
116
+ * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
117
+ *
118
+ */
119
+ export declare class CreatePracticeRunConfigurationCommand extends $Command<CreatePracticeRunConfigurationCommandInput, CreatePracticeRunConfigurationCommandOutput, ARCZonalShiftClientResolvedConfig> {
120
+ readonly input: CreatePracticeRunConfigurationCommandInput;
121
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
122
+ /**
123
+ * @public
124
+ */
125
+ constructor(input: CreatePracticeRunConfigurationCommandInput);
126
+ /**
127
+ * @internal
128
+ */
129
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<CreatePracticeRunConfigurationCommandInput, CreatePracticeRunConfigurationCommandOutput>;
130
+ /**
131
+ * @internal
132
+ */
133
+ private serialize;
134
+ /**
135
+ * @internal
136
+ */
137
+ private deserialize;
138
+ }
@@ -0,0 +1,95 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
+ import { DeletePracticeRunConfigurationRequest, DeletePracticeRunConfigurationResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeletePracticeRunConfigurationCommand}.
14
+ */
15
+ export interface DeletePracticeRunConfigurationCommandInput extends DeletePracticeRunConfigurationRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeletePracticeRunConfigurationCommand}.
21
+ */
22
+ export interface DeletePracticeRunConfigurationCommandOutput extends DeletePracticeRunConfigurationResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Deletes the practice run configuration for a resource. Before you can delete
27
+ * a practice run configuration for a resource., you must disable zonal autoshift for
28
+ * the resource. Practice runs must be configured for zonal autoshift to be enabled.</p>
29
+ * @example
30
+ * Use a bare-bones client and the command you need to make an API call.
31
+ * ```javascript
32
+ * import { ARCZonalShiftClient, DeletePracticeRunConfigurationCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
33
+ * // const { ARCZonalShiftClient, DeletePracticeRunConfigurationCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
34
+ * const client = new ARCZonalShiftClient(config);
35
+ * const input = { // DeletePracticeRunConfigurationRequest
36
+ * resourceIdentifier: "STRING_VALUE", // required
37
+ * };
38
+ * const command = new DeletePracticeRunConfigurationCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // DeletePracticeRunConfigurationResponse
41
+ * // arn: "STRING_VALUE", // required
42
+ * // name: "STRING_VALUE", // required
43
+ * // zonalAutoshiftStatus: "ENABLED" || "DISABLED", // required
44
+ * // };
45
+ *
46
+ * ```
47
+ *
48
+ * @param DeletePracticeRunConfigurationCommandInput - {@link DeletePracticeRunConfigurationCommandInput}
49
+ * @returns {@link DeletePracticeRunConfigurationCommandOutput}
50
+ * @see {@link DeletePracticeRunConfigurationCommandInput} for command's `input` shape.
51
+ * @see {@link DeletePracticeRunConfigurationCommandOutput} for command's `response` shape.
52
+ * @see {@link ARCZonalShiftClientResolvedConfig | config} for ARCZonalShiftClient's `config` shape.
53
+ *
54
+ * @throws {@link AccessDeniedException} (client fault)
55
+ * <p>You do not have sufficient access to perform this action.</p>
56
+ *
57
+ * @throws {@link ConflictException} (client fault)
58
+ * <p>The request could not be processed because of conflict in the current state of the resource.</p>
59
+ *
60
+ * @throws {@link InternalServerException} (server fault)
61
+ * <p>There was an internal server error.</p>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p>The input requested a resource that was not found.</p>
65
+ *
66
+ * @throws {@link ThrottlingException} (client fault)
67
+ * <p>The request was denied due to request throttling.</p>
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
71
+ *
72
+ * @throws {@link ARCZonalShiftServiceException}
73
+ * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
74
+ *
75
+ */
76
+ export declare class DeletePracticeRunConfigurationCommand extends $Command<DeletePracticeRunConfigurationCommandInput, DeletePracticeRunConfigurationCommandOutput, ARCZonalShiftClientResolvedConfig> {
77
+ readonly input: DeletePracticeRunConfigurationCommandInput;
78
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
82
+ constructor(input: DeletePracticeRunConfigurationCommandInput);
83
+ /**
84
+ * @internal
85
+ */
86
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DeletePracticeRunConfigurationCommandInput, DeletePracticeRunConfigurationCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
90
+ private serialize;
91
+ /**
92
+ * @internal
93
+ */
94
+ private deserialize;
95
+ }
@@ -23,9 +23,9 @@ export interface GetManagedResourceCommandOutput extends GetManagedResourceRespo
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Get information about a resource that's been registered for zonal shifts with Amazon Route 53 Application Recovery Controller in this AWS Region. Resources that are registered for
27
- * zonal shifts are managed resources in Route 53 ARC.</p>
28
- * <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>
26
+ * <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
27
+ * zonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.</p>
28
+ * <p>At this time, you can only start a zonal shift or configure zonal autoshift for Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>
29
29
  * @example
30
30
  * Use a bare-bones client and the command you need to make an API call.
31
31
  * ```javascript
@@ -52,8 +52,37 @@ export interface GetManagedResourceCommandOutput extends GetManagedResourceRespo
52
52
  * // expiryTime: new Date("TIMESTAMP"), // required
53
53
  * // startTime: new Date("TIMESTAMP"), // required
54
54
  * // comment: "STRING_VALUE", // required
55
+ * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
55
56
  * // },
56
57
  * // ],
58
+ * // autoshifts: [ // AutoshiftsInResource
59
+ * // { // AutoshiftInResource
60
+ * // appliedStatus: "APPLIED" || "NOT_APPLIED", // required
61
+ * // awayFrom: "STRING_VALUE", // required
62
+ * // startTime: new Date("TIMESTAMP"), // required
63
+ * // },
64
+ * // ],
65
+ * // practiceRunConfiguration: { // PracticeRunConfiguration
66
+ * // blockingAlarms: [ // ControlConditions
67
+ * // { // ControlCondition
68
+ * // type: "CLOUDWATCH", // required
69
+ * // alarmIdentifier: "STRING_VALUE", // required
70
+ * // },
71
+ * // ],
72
+ * // outcomeAlarms: [ // required
73
+ * // {
74
+ * // type: "CLOUDWATCH", // required
75
+ * // alarmIdentifier: "STRING_VALUE", // required
76
+ * // },
77
+ * // ],
78
+ * // blockedWindows: [ // BlockedWindows
79
+ * // "STRING_VALUE",
80
+ * // ],
81
+ * // blockedDates: [ // BlockedDates
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // },
85
+ * // zonalAutoshiftStatus: "ENABLED" || "DISABLED",
57
86
  * // };
58
87
  *
59
88
  * ```
@@ -77,7 +106,7 @@ export interface GetManagedResourceCommandOutput extends GetManagedResourceRespo
77
106
  * <p>The request was denied due to request throttling.</p>
78
107
  *
79
108
  * @throws {@link ValidationException} (client fault)
80
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
109
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
81
110
  *
82
111
  * @throws {@link ARCZonalShiftServiceException}
83
112
  * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
@@ -0,0 +1,95 @@
1
+ import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
2
+ import { Command as $Command } from "@smithy/smithy-client";
3
+ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
4
+ import { ARCZonalShiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../ARCZonalShiftClient";
5
+ import { ListAutoshiftsRequest, ListAutoshiftsResponse } from "../models/models_0";
6
+ /**
7
+ * @public
8
+ */
9
+ export { __MetadataBearer, $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link ListAutoshiftsCommand}.
14
+ */
15
+ export interface ListAutoshiftsCommandInput extends ListAutoshiftsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListAutoshiftsCommand}.
21
+ */
22
+ export interface ListAutoshiftsCommandOutput extends ListAutoshiftsResponse, __MetadataBearer {
23
+ }
24
+ /**
25
+ * @public
26
+ * <p>Returns the active autoshifts for a specified resource.</p>
27
+ * @example
28
+ * Use a bare-bones client and the command you need to make an API call.
29
+ * ```javascript
30
+ * import { ARCZonalShiftClient, ListAutoshiftsCommand } from "@aws-sdk/client-arc-zonal-shift"; // ES Modules import
31
+ * // const { ARCZonalShiftClient, ListAutoshiftsCommand } = require("@aws-sdk/client-arc-zonal-shift"); // CommonJS import
32
+ * const client = new ARCZonalShiftClient(config);
33
+ * const input = { // ListAutoshiftsRequest
34
+ * nextToken: "STRING_VALUE",
35
+ * status: "ACTIVE" || "COMPLETED",
36
+ * maxResults: Number("int"),
37
+ * };
38
+ * const command = new ListAutoshiftsCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // ListAutoshiftsResponse
41
+ * // items: [ // AutoshiftSummaries
42
+ * // { // AutoshiftSummary
43
+ * // awayFrom: "STRING_VALUE", // required
44
+ * // endTime: new Date("TIMESTAMP"), // required
45
+ * // startTime: new Date("TIMESTAMP"), // required
46
+ * // status: "ACTIVE" || "COMPLETED", // required
47
+ * // },
48
+ * // ],
49
+ * // nextToken: "STRING_VALUE",
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param ListAutoshiftsCommandInput - {@link ListAutoshiftsCommandInput}
55
+ * @returns {@link ListAutoshiftsCommandOutput}
56
+ * @see {@link ListAutoshiftsCommandInput} for command's `input` shape.
57
+ * @see {@link ListAutoshiftsCommandOutput} 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 InternalServerException} (server fault)
64
+ * <p>There was an internal server error.</p>
65
+ *
66
+ * @throws {@link ThrottlingException} (client fault)
67
+ * <p>The request was denied due to request throttling.</p>
68
+ *
69
+ * @throws {@link ValidationException} (client fault)
70
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
71
+ *
72
+ * @throws {@link ARCZonalShiftServiceException}
73
+ * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
74
+ *
75
+ */
76
+ export declare class ListAutoshiftsCommand extends $Command<ListAutoshiftsCommandInput, ListAutoshiftsCommandOutput, ARCZonalShiftClientResolvedConfig> {
77
+ readonly input: ListAutoshiftsCommandInput;
78
+ static getEndpointParameterInstructions(): EndpointParameterInstructions;
79
+ /**
80
+ * @public
81
+ */
82
+ constructor(input: ListAutoshiftsCommandInput);
83
+ /**
84
+ * @internal
85
+ */
86
+ resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: ARCZonalShiftClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListAutoshiftsCommandInput, ListAutoshiftsCommandOutput>;
87
+ /**
88
+ * @internal
89
+ */
90
+ private serialize;
91
+ /**
92
+ * @internal
93
+ */
94
+ private deserialize;
95
+ }
@@ -23,8 +23,9 @@ export interface ListManagedResourcesCommandOutput extends ListManagedResourcesR
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists all the resources in your AWS account in this AWS Region that are managed for zonal shifts in Amazon Route 53 Application Recovery Controller, and information
27
- * about them. The information includes their Amazon Resource Names (ARNs), the Availability Zones the resources are deployed in, and
26
+ * <p>Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for
27
+ * zonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource,
28
+ * as well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and
28
29
  * the resource name.</p>
29
30
  * @example
30
31
  * Use a bare-bones client and the command you need to make an API call.
@@ -46,6 +47,30 @@ export interface ListManagedResourcesCommandOutput extends ListManagedResourcesR
46
47
  * // availabilityZones: [ // AvailabilityZones // required
47
48
  * // "STRING_VALUE",
48
49
  * // ],
50
+ * // appliedWeights: { // AppliedWeights
51
+ * // "<keys>": Number("float"),
52
+ * // },
53
+ * // zonalShifts: [ // ZonalShiftsInResource
54
+ * // { // ZonalShiftInResource
55
+ * // appliedStatus: "APPLIED" || "NOT_APPLIED", // required
56
+ * // zonalShiftId: "STRING_VALUE", // required
57
+ * // resourceIdentifier: "STRING_VALUE", // required
58
+ * // awayFrom: "STRING_VALUE", // required
59
+ * // expiryTime: new Date("TIMESTAMP"), // required
60
+ * // startTime: new Date("TIMESTAMP"), // required
61
+ * // comment: "STRING_VALUE", // required
62
+ * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
63
+ * // },
64
+ * // ],
65
+ * // autoshifts: [ // AutoshiftsInResource
66
+ * // { // AutoshiftInResource
67
+ * // appliedStatus: "APPLIED" || "NOT_APPLIED", // required
68
+ * // awayFrom: "STRING_VALUE", // required
69
+ * // startTime: new Date("TIMESTAMP"), // required
70
+ * // },
71
+ * // ],
72
+ * // zonalAutoshiftStatus: "ENABLED" || "DISABLED",
73
+ * // practiceRunStatus: "ENABLED" || "DISABLED",
49
74
  * // },
50
75
  * // ],
51
76
  * // nextToken: "STRING_VALUE",
@@ -69,7 +94,7 @@ export interface ListManagedResourcesCommandOutput extends ListManagedResourcesR
69
94
  * <p>The request was denied due to request throttling.</p>
70
95
  *
71
96
  * @throws {@link ValidationException} (client fault)
72
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
97
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
73
98
  *
74
99
  * @throws {@link ARCZonalShiftServiceException}
75
100
  * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
@@ -23,7 +23,11 @@ export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Lists all the active zonal shifts in Amazon Route 53 Application Recovery Controller in your AWS account in this AWS Region.</p>
26
+ * <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.
27
+ * <code>ListZonalShifts</code> returns customer-started zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on
28
+ * your behalf for zonal autoshift.</p>
29
+ * <p>The <code>ListZonalShifts</code> operation does not list autoshifts. For more information about listing
30
+ * autoshifts, see <a href="https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html">"&gt;ListAutoshifts</a>.</p>
27
31
  * @example
28
32
  * Use a bare-bones client and the command you need to make an API call.
29
33
  * ```javascript
@@ -34,6 +38,7 @@ export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
34
38
  * nextToken: "STRING_VALUE",
35
39
  * status: "ACTIVE" || "EXPIRED" || "CANCELED",
36
40
  * maxResults: Number("int"),
41
+ * resourceIdentifier: "STRING_VALUE",
37
42
  * };
38
43
  * const command = new ListZonalShiftsCommand(input);
39
44
  * const response = await client.send(command);
@@ -47,6 +52,7 @@ export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
47
52
  * // startTime: new Date("TIMESTAMP"), // required
48
53
  * // status: "ACTIVE" || "EXPIRED" || "CANCELED", // required
49
54
  * // comment: "STRING_VALUE", // required
55
+ * // practiceRunOutcome: "FAILED" || "INTERRUPTED" || "PENDING" || "SUCCEEDED",
50
56
  * // },
51
57
  * // ],
52
58
  * // nextToken: "STRING_VALUE",
@@ -70,7 +76,7 @@ export interface ListZonalShiftsCommandOutput extends ListZonalShiftsResponse, _
70
76
  * <p>The request was denied due to request throttling.</p>
71
77
  *
72
78
  * @throws {@link ValidationException} (client fault)
73
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
79
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
74
80
  *
75
81
  * @throws {@link ARCZonalShiftServiceException}
76
82
  * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>
@@ -23,15 +23,16 @@ export interface StartZonalShiftCommandOutput extends ZonalShift, __MetadataBear
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in a AWS Region,
27
- * to help your application recover immediately, for example, from a developer's bad code deployment or from an AWS
26
+ * <p>You start a zonal shift to temporarily move load balancer traffic away from an Availability Zone in an Amazon Web Services Region,
27
+ * to help your application recover immediately, for example, from a developer's bad code deployment or from an Amazon Web Services
28
28
  * infrastructure failure in a single Availability Zone. You can start a zonal shift in Route 53 ARC only for managed
29
- * resources in your account in an AWS Region. Resources are automatically registered with Route 53 ARC by AWS services.</p>
30
- * <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>
31
- * <p>When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The
29
+ * resources in your Amazon Web Services account in an Amazon Web Services Region. Resources are automatically registered with Route 53 ARC
30
+ * by Amazon Web Services services.</p>
31
+ * <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>
32
+ * <p>When you start a zonal shift, traffic for the resource is no longer routed to the Availability Zone. The
32
33
  * zonal shift is created immediately in Route 53 ARC. However, it can take a short time, typically up to a few minutes,
33
34
  * for existing, in-progress connections in the Availability Zone to complete.</p>
34
- * <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html">Zonal shift</a>
35
+ * <p>For more information, see <a href="https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-shift.html">Zonal shift</a>
35
36
  * in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>
36
37
  * @example
37
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -81,7 +82,7 @@ export interface StartZonalShiftCommandOutput extends ZonalShift, __MetadataBear
81
82
  * <p>The request was denied due to request throttling.</p>
82
83
  *
83
84
  * @throws {@link ValidationException} (client fault)
84
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
85
+ * <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
85
86
  *
86
87
  * @throws {@link ARCZonalShiftServiceException}
87
88
  * <p>Base exception class for all service exceptions from ARCZonalShift service.</p>