@aws-sdk/client-arc-zonal-shift 3.379.1 → 3.382.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.
@@ -29,6 +29,7 @@ export type AppliedStatus = (typeof AppliedStatus)[keyof typeof AppliedStatus];
29
29
  */
30
30
  export interface CancelZonalShiftRequest {
31
31
  /**
32
+ * @public
32
33
  * <p>The internally-generated identifier of a zonal shift.</p>
33
34
  */
34
35
  zonalShiftId: string | undefined;
@@ -54,10 +55,12 @@ export declare class ConflictException extends __BaseException {
54
55
  readonly name: "ConflictException";
55
56
  readonly $fault: "client";
56
57
  /**
58
+ * @public
57
59
  * <p>The reason for the conflict exception.</p>
58
60
  */
59
61
  reason: ConflictExceptionReason | string | undefined;
60
62
  /**
63
+ * @public
61
64
  * <p>The zonal shift ID associated with the conflict exception.</p>
62
65
  */
63
66
  zonalShiftId?: string;
@@ -127,6 +130,7 @@ export declare class ValidationException extends __BaseException {
127
130
  readonly name: "ValidationException";
128
131
  readonly $fault: "client";
129
132
  /**
133
+ * @public
130
134
  * <p>The reason for the validation exception.</p>
131
135
  */
132
136
  reason: ValidationExceptionReason | string | undefined;
@@ -153,20 +157,24 @@ export type ZonalShiftStatus = (typeof ZonalShiftStatus)[keyof typeof ZonalShift
153
157
  */
154
158
  export interface ZonalShift {
155
159
  /**
160
+ * @public
156
161
  * <p>The identifier of a zonal shift.</p>
157
162
  */
158
163
  zonalShiftId: string | undefined;
159
164
  /**
165
+ * @public
160
166
  * <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
161
167
  * <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>
162
168
  */
163
169
  resourceIdentifier: string | undefined;
164
170
  /**
171
+ * @public
165
172
  * <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
166
173
  * Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.</p>
167
174
  */
168
175
  awayFrom: string | undefined;
169
176
  /**
177
+ * @public
170
178
  * <p>The expiry time (expiration time) for the zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
171
179
  * You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
172
180
  * to set a new expiration at any time. </p>
@@ -176,10 +184,12 @@ export interface ZonalShift {
176
184
  */
177
185
  expiryTime: Date | undefined;
178
186
  /**
187
+ * @public
179
188
  * <p>The time (UTC) when the zonal shift is started.</p>
180
189
  */
181
190
  startTime: Date | undefined;
182
191
  /**
192
+ * @public
183
193
  * <p>A status for a zonal shift.</p>
184
194
  * <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
185
195
  * <ul>
@@ -199,6 +209,7 @@ export interface ZonalShift {
199
209
  */
200
210
  status: ZonalShiftStatus | string | undefined;
201
211
  /**
212
+ * @public
202
213
  * <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
203
214
  * history is maintained. A new comment overwrites any existing comment string.</p>
204
215
  */
@@ -209,6 +220,7 @@ export interface ZonalShift {
209
220
  */
210
221
  export interface GetManagedResourceRequest {
211
222
  /**
223
+ * @public
212
224
  * <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
213
225
  * <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>
214
226
  */
@@ -220,25 +232,30 @@ export interface GetManagedResourceRequest {
220
232
  */
221
233
  export interface ZonalShiftInResource {
222
234
  /**
235
+ * @public
223
236
  * <p>An <code>appliedStatus</code> for a zonal shift for a resource can have one of two values: <code>APPLIED</code>
224
237
  * or <code>NOT_APPLIED</code>. </p>
225
238
  */
226
239
  appliedStatus: AppliedStatus | string | undefined;
227
240
  /**
241
+ * @public
228
242
  * <p>The identifier of a zonal shift.</p>
229
243
  */
230
244
  zonalShiftId: string | undefined;
231
245
  /**
246
+ * @public
232
247
  * <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
233
248
  * <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>
234
249
  */
235
250
  resourceIdentifier: string | undefined;
236
251
  /**
252
+ * @public
237
253
  * <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
238
254
  * Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.</p>
239
255
  */
240
256
  awayFrom: string | undefined;
241
257
  /**
258
+ * @public
242
259
  * <p>The expiry time (expiration time) for the zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
243
260
  * You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
244
261
  * to set a new expiration at any time. </p>
@@ -248,10 +265,12 @@ export interface ZonalShiftInResource {
248
265
  */
249
266
  expiryTime: Date | undefined;
250
267
  /**
268
+ * @public
251
269
  * <p>The time (UTC) when the zonal shift is started.</p>
252
270
  */
253
271
  startTime: Date | undefined;
254
272
  /**
273
+ * @public
255
274
  * <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
256
275
  * history is maintained. That is, a new comment overwrites any existing comment string.</p>
257
276
  */
@@ -262,19 +281,23 @@ export interface ZonalShiftInResource {
262
281
  */
263
282
  export interface GetManagedResourceResponse {
264
283
  /**
284
+ * @public
265
285
  * <p>The Amazon Resource Name (ARN) for the resource.</p>
266
286
  */
267
287
  arn?: string;
268
288
  /**
289
+ * @public
269
290
  * <p>The name of the resource.</p>
270
291
  */
271
292
  name?: string;
272
293
  /**
294
+ * @public
273
295
  * <p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not.
274
296
  * The key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>
275
297
  */
276
298
  appliedWeights: Record<string, number> | undefined;
277
299
  /**
300
+ * @public
278
301
  * <p>The zonal shifts that are currently active for a resource. </p>
279
302
  */
280
303
  zonalShifts: ZonalShiftInResource[] | undefined;
@@ -284,12 +307,14 @@ export interface GetManagedResourceResponse {
284
307
  */
285
308
  export interface ListManagedResourcesRequest {
286
309
  /**
310
+ * @public
287
311
  * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
288
312
  * previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
289
313
  * call's <code>NextToken</code> response to request the next page of results.</p>
290
314
  */
291
315
  nextToken?: string;
292
316
  /**
317
+ * @public
293
318
  * <p>The number of objects that you want to return with this call.</p>
294
319
  */
295
320
  maxResults?: number;
@@ -305,14 +330,17 @@ export interface ListManagedResourcesRequest {
305
330
  */
306
331
  export interface ManagedResourceSummary {
307
332
  /**
333
+ * @public
308
334
  * <p>The Amazon Resource Name (ARN) for the managed resource.</p>
309
335
  */
310
336
  arn?: string;
311
337
  /**
338
+ * @public
312
339
  * <p>The name of the managed resource.</p>
313
340
  */
314
341
  name?: string;
315
342
  /**
343
+ * @public
316
344
  * <p>The Availability Zones that a resource is deployed in.</p>
317
345
  */
318
346
  availabilityZones: string[] | undefined;
@@ -322,10 +350,12 @@ export interface ManagedResourceSummary {
322
350
  */
323
351
  export interface ListManagedResourcesResponse {
324
352
  /**
353
+ * @public
325
354
  * <p>The items in the response list.</p>
326
355
  */
327
356
  items: ManagedResourceSummary[] | undefined;
328
357
  /**
358
+ * @public
329
359
  * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
330
360
  * previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
331
361
  * call's <code>NextToken</code> response to request the next page of results.</p>
@@ -337,12 +367,14 @@ export interface ListManagedResourcesResponse {
337
367
  */
338
368
  export interface ListZonalShiftsRequest {
339
369
  /**
370
+ * @public
340
371
  * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
341
372
  * previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
342
373
  * call's <code>NextToken</code> response to request the next page of results.</p>
343
374
  */
344
375
  nextToken?: string;
345
376
  /**
377
+ * @public
346
378
  * <p>A status for a zonal shift.</p>
347
379
  * <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
348
380
  * <ul>
@@ -362,6 +394,7 @@ export interface ListZonalShiftsRequest {
362
394
  */
363
395
  status?: ZonalShiftStatus | string;
364
396
  /**
397
+ * @public
365
398
  * <p>The number of objects that you want to return with this call.</p>
366
399
  */
367
400
  maxResults?: number;
@@ -379,20 +412,24 @@ export interface ListZonalShiftsRequest {
379
412
  */
380
413
  export interface ZonalShiftSummary {
381
414
  /**
415
+ * @public
382
416
  * <p>The identifier of a zonal shift.</p>
383
417
  */
384
418
  zonalShiftId: string | undefined;
385
419
  /**
420
+ * @public
386
421
  * <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
387
422
  * <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>
388
423
  */
389
424
  resourceIdentifier: string | undefined;
390
425
  /**
426
+ * @public
391
427
  * <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
392
428
  * Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.</p>
393
429
  */
394
430
  awayFrom: string | undefined;
395
431
  /**
432
+ * @public
396
433
  * <p>The expiry time (expiration time) for the zonal shift. A zonal shift is temporary and must be set to expire when you start the zonal shift.
397
434
  * You can initially set a zonal shift to expire in a maximum of three days (72 hours). However, you can update a zonal shift
398
435
  * to set a new expiration at any time. </p>
@@ -402,10 +439,12 @@ export interface ZonalShiftSummary {
402
439
  */
403
440
  expiryTime: Date | undefined;
404
441
  /**
442
+ * @public
405
443
  * <p>The time (UTC) when the zonal shift is started.</p>
406
444
  */
407
445
  startTime: Date | undefined;
408
446
  /**
447
+ * @public
409
448
  * <p>A status for a zonal shift.</p>
410
449
  * <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>
411
450
  * <ul>
@@ -425,6 +464,7 @@ export interface ZonalShiftSummary {
425
464
  */
426
465
  status: ZonalShiftStatus | string | undefined;
427
466
  /**
467
+ * @public
428
468
  * <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
429
469
  * history is maintained. That is, a new comment overwrites any existing comment string.</p>
430
470
  */
@@ -435,10 +475,12 @@ export interface ZonalShiftSummary {
435
475
  */
436
476
  export interface ListZonalShiftsResponse {
437
477
  /**
478
+ * @public
438
479
  * <p>The items in the response list.</p>
439
480
  */
440
481
  items?: ZonalShiftSummary[];
441
482
  /**
483
+ * @public
442
484
  * <p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the
443
485
  * previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous
444
486
  * call's <code>NextToken</code> response to request the next page of results.</p>
@@ -450,15 +492,18 @@ export interface ListZonalShiftsResponse {
450
492
  */
451
493
  export interface UpdateZonalShiftRequest {
452
494
  /**
495
+ * @public
453
496
  * <p>The identifier of a zonal shift.</p>
454
497
  */
455
498
  zonalShiftId: string | undefined;
456
499
  /**
500
+ * @public
457
501
  * <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
458
502
  * history is maintained. A new comment overwrites any existing comment string.</p>
459
503
  */
460
504
  comment?: string;
461
505
  /**
506
+ * @public
462
507
  * <p>The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time).
463
508
  * Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p>
464
509
  * <p>If you want to still keep traffic away from an Availability Zone, you can update the
@@ -484,16 +529,19 @@ export interface UpdateZonalShiftRequest {
484
529
  */
485
530
  export interface StartZonalShiftRequest {
486
531
  /**
532
+ * @public
487
533
  * <p>The identifier for the resource to include in a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>
488
534
  * <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>
489
535
  */
490
536
  resourceIdentifier: string | undefined;
491
537
  /**
538
+ * @public
492
539
  * <p>The Availability Zone that traffic is moved away from for a resource when you start a zonal shift.
493
540
  * Until the zonal shift expires or you cancel it, traffic for the resource is instead moved to other Availability Zones in the AWS Region.</p>
494
541
  */
495
542
  awayFrom: string | undefined;
496
543
  /**
544
+ * @public
497
545
  * <p>The length of time that you want a zonal shift to be active, which Route 53 ARC converts to an expiry time (expiration time).
498
546
  * Zonal shifts are temporary. You can set a zonal shift to be active initially for up to three days (72 hours).</p>
499
547
  * <p>If you want to still keep traffic away from an Availability Zone, you can update the
@@ -515,6 +563,7 @@ export interface StartZonalShiftRequest {
515
563
  */
516
564
  expiresIn: string | undefined;
517
565
  /**
566
+ * @public
518
567
  * <p>A comment that you enter about the zonal shift. Only the latest comment is retained; no comment
519
568
  * history is maintained. A new comment overwrites any existing comment string.</p>
520
569
  */
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-arc-zonal-shift",
3
3
  "description": "AWS SDK for JavaScript Arc Zonal Shift Client for Node.js, Browser and React Native",
4
- "version": "3.379.1",
4
+ "version": "3.382.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,15 +21,15 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.379.1",
25
- "@aws-sdk/credential-provider-node": "3.379.1",
24
+ "@aws-sdk/client-sts": "3.382.0",
25
+ "@aws-sdk/credential-provider-node": "3.382.0",
26
26
  "@aws-sdk/middleware-host-header": "3.379.1",
27
27
  "@aws-sdk/middleware-logger": "3.378.0",
28
28
  "@aws-sdk/middleware-recursion-detection": "3.378.0",
29
29
  "@aws-sdk/middleware-signing": "3.379.1",
30
- "@aws-sdk/middleware-user-agent": "3.379.1",
30
+ "@aws-sdk/middleware-user-agent": "3.382.0",
31
31
  "@aws-sdk/types": "3.378.0",
32
- "@aws-sdk/util-endpoints": "3.378.0",
32
+ "@aws-sdk/util-endpoints": "3.382.0",
33
33
  "@aws-sdk/util-user-agent-browser": "3.378.0",
34
34
  "@aws-sdk/util-user-agent-node": "3.378.0",
35
35
  "@smithy/config-resolver": "^2.0.1",