forked from awslabs/aws-sdk-kotlin
-
Notifications
You must be signed in to change notification settings - Fork 0
/
arc-zonal-shift.json
2666 lines (2666 loc) · 150 KB
/
arc-zonal-shift.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"smithy": "2.0",
"shapes": {
"com.amazonaws.arczonalshift#AccessDeniedException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String"
}
},
"traits": {
"smithy.api#documentation": "<p>You do not have sufficient access to perform this action.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 403
}
},
"com.amazonaws.arczonalshift#AlertRetrieval": {
"type": "resource"
},
"com.amazonaws.arczonalshift#AlertTransmission": {
"type": "resource"
},
"com.amazonaws.arczonalshift#AppliedStatus": {
"type": "enum",
"members": {
"APPLIED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "APPLIED"
}
},
"NOT_APPLIED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "NOT_APPLIED"
}
}
}
},
"com.amazonaws.arczonalshift#AppliedWeights": {
"type": "map",
"key": {
"target": "com.amazonaws.arczonalshift#AvailabilityZone"
},
"value": {
"target": "com.amazonaws.arczonalshift#Weight"
}
},
"com.amazonaws.arczonalshift#Autoshift": {
"type": "resource",
"operations": [
{
"target": "com.amazonaws.arczonalshift#ListAutoshifts"
}
]
},
"com.amazonaws.arczonalshift#AutoshiftAppliedStatus": {
"type": "enum",
"members": {
"APPLIED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "APPLIED"
}
},
"NOT_APPLIED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "NOT_APPLIED"
}
}
}
},
"com.amazonaws.arczonalshift#AutoshiftExecutionStatus": {
"type": "enum",
"members": {
"ACTIVE": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "ACTIVE"
}
},
"COMPLETED": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "COMPLETED"
}
}
}
},
"com.amazonaws.arczonalshift#AutoshiftInResource": {
"type": "structure",
"members": {
"appliedStatus": {
"target": "com.amazonaws.arczonalshift#AutoshiftAppliedStatus",
"traits": {
"smithy.api#documentation": "<p>The <code>appliedStatus</code> field specifies which application traffic shift is in effect for a\n\t\t\tresource when there is more than one traffic shift active. There can be more than one application traffic \n\t\t\tshift in progress at the same time - that is, practice run zonal shifts, customer-started zonal shifts, \n\t\t\tor an autoshift. The <code>appliedStatus</code> field for an autoshift for a resource can have one of two \n\t\t\tvalues: <code>APPLIED</code> or <code>NOT_APPLIED</code>. The zonal shift or autoshift \n\t\t\tthat is currently in effect for the resource has an applied status set to <code>APPLIED</code>.</p>\n <p>The overall principle for precedence is that zonal shifts that you start as a customer take precedence \n\t\t\tautoshifts, which take precedence over practice runs. That is, customer-started zonal shifts > autoshifts > practice run \n\t\t\tzonal shifts.</p>\n <p>For more information, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html\">How zonal autoshift \n\t\t\t\tand practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>",
"smithy.api#required": {}
}
},
"awayFrom": {
"target": "com.amazonaws.arczonalshift#AvailabilityZone",
"traits": {
"smithy.api#documentation": "<p>The Availability Zone that traffic is shifted away from for a resource, when Amazon Web Services starts an autoshift. \n\t\t\tUntil the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region.\n\t\t\tAn autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when \n\t\t\tyou disable zonal autoshift for the resource.</p>",
"smithy.api#required": {}
}
},
"startTime": {
"target": "com.amazonaws.arczonalshift#StartTime",
"traits": {
"smithy.api#documentation": "<p>The time (UTC) when the autoshift started.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A complex structure that lists an autoshift that is currently active for a managed resource and information about\n\t\t\tthe autoshift.</p>\n <p>For more information, see <a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.how-it-works.html\">How zonal autoshift \n\t\t\tand practice runs work</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>"
}
},
"com.amazonaws.arczonalshift#AutoshiftSummaries": {
"type": "list",
"member": {
"target": "com.amazonaws.arczonalshift#AutoshiftSummary"
}
},
"com.amazonaws.arczonalshift#AutoshiftSummary": {
"type": "structure",
"members": {
"awayFrom": {
"target": "com.amazonaws.arczonalshift#AvailabilityZone",
"traits": {
"smithy.api#documentation": "<p>The Availability Zone that traffic is shifted away from for a resource when Amazon Web Services starts an autoshift. \n\t\t\tUntil the autoshift ends, traffic for the resource is instead directed to other Availability Zones in the Amazon Web Services Region.\n\t\t\tAn autoshift can end for a resource, for example, when Amazon Web Services ends the autoshift for the Availability Zone or when \n\t\t\tyou disable zonal autoshift for the resource.</p>",
"smithy.api#required": {}
}
},
"endTime": {
"target": "com.amazonaws.arczonalshift#ExpiryTime",
"traits": {
"smithy.api#documentation": "<p>The time (in UTC) when the autoshift ended.</p>",
"smithy.api#required": {}
}
},
"startTime": {
"target": "com.amazonaws.arczonalshift#StartTime",
"traits": {
"smithy.api#documentation": "<p>The time (in UTC) when the autoshift started.</p>",
"smithy.api#required": {}
}
},
"status": {
"target": "com.amazonaws.arczonalshift#AutoshiftExecutionStatus",
"traits": {
"smithy.api#documentation": "<p>The status for an autoshift. </p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Information about an autoshift. Amazon Web Services starts an autoshift to temporarily move traffic for a resource \n\t\t\taway from an Availability Zone in an Amazon Web Services Region\n\t\t\twhen Amazon Web Services determines that there's an issue in the Availability Zone that could potentially affect customers.\n\t\t\tYou can configure zonal autoshift in Route 53 ARC for managed resources in your Amazon Web Services account in a Region. \n\t\t\tSupported Amazon Web Services resources are automatically registered with Route 53 ARC.</p>\n <p>Autoshifts are temporary. When the Availability Zone recovers, Amazon Web Services ends the autoshift, and \n\t\t\ttraffic for the resource is no longer directed to the other Availability Zones in the Region.</p>\n <p>You can stop an autoshift for a resource by disabling zonal autoshift.</p>"
}
},
"com.amazonaws.arczonalshift#AutoshiftsInResource": {
"type": "list",
"member": {
"target": "com.amazonaws.arczonalshift#AutoshiftInResource"
}
},
"com.amazonaws.arczonalshift#AvailabilityZone": {
"type": "string",
"traits": {
"smithy.api#length": {
"max": 20
}
}
},
"com.amazonaws.arczonalshift#AvailabilityZones": {
"type": "list",
"member": {
"target": "com.amazonaws.arczonalshift#AvailabilityZone"
}
},
"com.amazonaws.arczonalshift#BlockedDate": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 10,
"max": 10
},
"smithy.api#pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
}
},
"com.amazonaws.arczonalshift#BlockedDates": {
"type": "list",
"member": {
"target": "com.amazonaws.arczonalshift#BlockedDate"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 15
}
}
},
"com.amazonaws.arczonalshift#BlockedWindow": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 19,
"max": 19
},
"smithy.api#pattern": "^(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}-(Mon|Tue|Wed|Thu|Fri|Sat|Sun):[0-9]{2}:[0-9]{2}$"
}
},
"com.amazonaws.arczonalshift#BlockedWindows": {
"type": "list",
"member": {
"target": "com.amazonaws.arczonalshift#BlockedWindow"
},
"traits": {
"smithy.api#length": {
"min": 0,
"max": 15
}
}
},
"com.amazonaws.arczonalshift#CancelZonalShift": {
"type": "operation",
"input": {
"target": "com.amazonaws.arczonalshift#CancelZonalShiftRequest"
},
"output": {
"target": "com.amazonaws.arczonalshift#ZonalShift"
},
"errors": [
{
"target": "com.amazonaws.arczonalshift#AccessDeniedException"
},
{
"target": "com.amazonaws.arczonalshift#ConflictException"
},
{
"target": "com.amazonaws.arczonalshift#InternalServerException"
},
{
"target": "com.amazonaws.arczonalshift#ResourceNotFoundException"
},
{
"target": "com.amazonaws.arczonalshift#ThrottlingException"
},
{
"target": "com.amazonaws.arczonalshift#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Cancel a zonal shift in Amazon Route 53 Application Recovery Controller. To cancel the zonal shift, specify the zonal shift ID.</p>\n <p>A zonal shift can be one that you've started for a resource in your Amazon Web Services account \n \t\tin an Amazon Web Services Region, or it can be a zonal shift started by a practice run with zonal \n \t\tautoshift. </p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/zonalshifts/{zonalShiftId}",
"code": 200
}
}
},
"com.amazonaws.arczonalshift#CancelZonalShiftRequest": {
"type": "structure",
"members": {
"zonalShiftId": {
"target": "com.amazonaws.arczonalshift#ZonalShiftId",
"traits": {
"smithy.api#documentation": "<p>The internally-generated identifier of a zonal shift.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {},
"smithy.api#references": [
{
"resource": "com.amazonaws.arczonalshift#ZonalShiftResource"
}
]
}
},
"com.amazonaws.arczonalshift#ConflictException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String",
"traits": {
"smithy.api#required": {}
}
},
"reason": {
"target": "com.amazonaws.arczonalshift#ConflictExceptionReason",
"traits": {
"smithy.api#documentation": "<p>The reason for the conflict exception.</p>",
"smithy.api#required": {}
}
},
"zonalShiftId": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>The zonal shift ID associated with the conflict exception.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The request could not be processed because of conflict in the current state of the resource.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.arczonalshift#ConflictExceptionReason": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "ZonalShiftAlreadyExists",
"name": "ZONAL_SHIFT_ALREADY_EXISTS"
},
{
"value": "ZonalShiftStatusNotActive",
"name": "ZONAL_SHIFT_STATUS_NOT_ACTIVE"
},
{
"value": "SimultaneousZonalShiftsConflict",
"name": "SIMULTANEOUS_ZONAL_SHIFTS_CONFLICT"
},
{
"value": "PracticeConfigurationAlreadyExists",
"name": "PRACTICE_CONFIGURATION_ALREADY_EXISTS"
},
{
"value": "AutoShiftEnabled",
"name": "AUTOSHIFT_ENABLED"
},
{
"value": "PracticeConfigurationDoesNotExist",
"name": "PRACTICE_CONFIGURATION_DOES_NOT_EXIST"
}
]
}
},
"com.amazonaws.arczonalshift#ControlCondition": {
"type": "structure",
"members": {
"type": {
"target": "com.amazonaws.arczonalshift#ControlConditionType",
"traits": {
"smithy.api#documentation": "<p>The type of alarm specified for a practice run. The only valid value is <code>CLOUDWATCH</code>.</p>",
"smithy.api#required": {}
}
},
"alarmIdentifier": {
"target": "com.amazonaws.arczonalshift#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the Amazon CloudWatch alarm that you specify as a control condition for a practice run.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>A control condition is an alarm that you specify for a practice run. When you configure practice runs\n\t\t\twith zonal autoshift for a resource, you specify Amazon CloudWatch alarms, which you create in CloudWatch \n\t\t\tto use with the practice run. The alarms that you specify are an \n\t\t\t<i>outcome alarm</i>, to monitor application health during practice runs and, \n\t\t\toptionally, a <i>blocking alarm</i>, to block practice runs from starting.</p>\n <p>Control condition alarms do not apply for autoshifts.</p>\n <p>For more information, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html\">\n\t\t\t\tConsiderations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>"
}
},
"com.amazonaws.arczonalshift#ControlConditionType": {
"type": "enum",
"members": {
"CLOUDWATCH": {
"target": "smithy.api#Unit",
"traits": {
"smithy.api#enumValue": "CLOUDWATCH"
}
}
}
},
"com.amazonaws.arczonalshift#ControlConditions": {
"type": "list",
"member": {
"target": "com.amazonaws.arczonalshift#ControlCondition"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 1
}
}
},
"com.amazonaws.arczonalshift#CreatePracticeRunConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.arczonalshift#CreatePracticeRunConfigurationRequest"
},
"output": {
"target": "com.amazonaws.arczonalshift#CreatePracticeRunConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.arczonalshift#AccessDeniedException"
},
{
"target": "com.amazonaws.arczonalshift#ConflictException"
},
{
"target": "com.amazonaws.arczonalshift#InternalServerException"
},
{
"target": "com.amazonaws.arczonalshift#ResourceNotFoundException"
},
{
"target": "com.amazonaws.arczonalshift#ThrottlingException"
},
{
"target": "com.amazonaws.arczonalshift#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>A practice run configuration for zonal autoshift is required when you enable zonal autoshift.\n\t\t\tA practice run configuration includes specifications for blocked dates and blocked time windows,\n\t\tand for Amazon CloudWatch alarms that you create to use with practice runs. The alarms that you specify are an \n\t\t\t<i>outcome alarm</i>, to monitor application health during practice runs and, \n\t\t\toptionally, a <i>blocking alarm</i>, to block practice runs from starting.</p>\n <p>For more information, see \n\t\t\t<a href=\"https://docs.aws.amazon.com/r53recovery/latest/dg/arc-zonal-autoshift.considerations.html\">\n\t\t\t\tConsiderations when you configure zonal autoshift</a> in the Amazon Route 53 Application Recovery Controller Developer Guide.</p>",
"smithy.api#http": {
"method": "POST",
"uri": "/configuration",
"code": 201
}
}
},
"com.amazonaws.arczonalshift#CreatePracticeRunConfigurationRequest": {
"type": "structure",
"members": {
"resourceIdentifier": {
"target": "com.amazonaws.arczonalshift#ResourceIdentifier",
"traits": {
"smithy.api#documentation": "<p>The identifier of the resource to shift away traffic for when a practice\n\t\t\trun starts a zonal shift. The identifier is the Amazon Resource Name (ARN) for the resource.</p>\n <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>",
"smithy.api#required": {}
}
},
"blockedWindows": {
"target": "com.amazonaws.arczonalshift#BlockedWindows",
"traits": {
"smithy.api#documentation": "<p>Optionally, you can block Route 53 ARC from starting practice runs for specific windows of \n\t\t\tdays and times. </p>\n <p>The format for blocked windows is: DAY:HH:SS-DAY:HH:SS. Keep in mind, when you specify dates,\n\t\t\tthat dates and times for practice runs are in UTC. Also, be aware of potential time adjustments \n\t\t\tthat might be required for daylight saving time differences. Separate multiple blocked windows \n\t\t\twith spaces.</p>\n <p>For example, say you run business report summaries three days a week. For\n\t\t\tthis scenario, you might set the following recurring days and times as blocked windows, \n\t\t\tfor example: <code>MON-20:30-21:30 WED-20:30-21:30 \n\t\t\t\tFRI-20:30-21:30</code>.</p>"
}
},
"blockedDates": {
"target": "com.amazonaws.arczonalshift#BlockedDates",
"traits": {
"smithy.api#documentation": "<p>Optionally, you can block Route 53 ARC from starting practice runs for a resource\n\t\t\ton specific calendar dates.</p>\n <p>The format for blocked dates is: YYYY-MM-DD. Keep in mind, when you specify dates,\n\t\t\tthat dates and times for practice runs are in UTC. Separate multiple blocked \n\t\t\tdates with spaces.</p>\n <p>For example, if you have an application update scheduled to launch on May 1, 2024, and \n\t\t\tyou don't want practice runs to shift traffic away at that time, you could set a blocked date \n\t\t\tfor <code>2024-05-01</code>.</p>"
}
},
"blockingAlarms": {
"target": "com.amazonaws.arczonalshift#ControlConditions",
"traits": {
"smithy.api#documentation": "<p>An Amazon CloudWatch alarm that you can specify for zonal autoshift \n\t\t\tpractice runs. This alarm blocks Route 53 ARC from starting practice run zonal \n\t\t\tshifts, and ends a practice run that's in progress, when the alarm is in \n\t\t\tan <code>ALARM</code> state. </p>"
}
},
"outcomeAlarms": {
"target": "com.amazonaws.arczonalshift#ControlConditions",
"traits": {
"smithy.api#documentation": "<p>The <i>outcome alarm</i> for practice runs is a required\n\t\t\tAmazon CloudWatch alarm that you specify that ends a practice run when the \n\t\t\talarm is in an <code>ALARM</code> state.</p>\n <p>Configure the alarm to monitor the health of your application \n\t\t\twhen traffic is shifted away from an Availability Zone during each weekly \n\t\t\tpractice run. You should configure the alarm to go into an <code>ALARM</code> state \n\t\t\tif your application is impacted by the zonal shift, and you want to stop the\n\t\t\tzonal shift, to let traffic for the resource return to the Availability Zone.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {},
"smithy.api#references": [
{
"resource": "com.amazonaws.arczonalshift#PracticeRunConfigurationResource"
}
]
}
},
"com.amazonaws.arczonalshift#CreatePracticeRunConfigurationResponse": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.arczonalshift#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource that you configured the practice \n\t\t\trun for.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.arczonalshift#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the resource that you configured the practice run for. </p>",
"smithy.api#required": {}
}
},
"zonalAutoshiftStatus": {
"target": "com.amazonaws.arczonalshift#ZonalAutoshiftStatus",
"traits": {
"smithy.api#documentation": "<p>The status for zonal autoshift for a resource. When you specify the\n\t\t\tautoshift status as <code>ENABLED</code>, Amazon Web Services shifts traffic \n\t\t\taway from shifts away application resource traffic from an Availability Zone, \n\t\t\ton your behalf, when Amazon Web Services determines that there's an issue in \n\t\t\tthe Availability Zone that could potentially affect customers.</p>\n <p>When you enable zonal autoshift, you must also configure practice runs for\n\t\t\tthe resource.</p>",
"smithy.api#required": {}
}
},
"practiceRunConfiguration": {
"target": "com.amazonaws.arczonalshift#PracticeRunConfiguration",
"traits": {
"smithy.api#documentation": "<p>A practice run configuration for a resource. Configurations include the\n\t\t\toutcome alarm that you specify for practice runs, and, optionally, a\n\t\t\tblocking alarm and blocking dates and windows.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.arczonalshift#DeletePracticeRunConfiguration": {
"type": "operation",
"input": {
"target": "com.amazonaws.arczonalshift#DeletePracticeRunConfigurationRequest"
},
"output": {
"target": "com.amazonaws.arczonalshift#DeletePracticeRunConfigurationResponse"
},
"errors": [
{
"target": "com.amazonaws.arczonalshift#AccessDeniedException"
},
{
"target": "com.amazonaws.arczonalshift#ConflictException"
},
{
"target": "com.amazonaws.arczonalshift#InternalServerException"
},
{
"target": "com.amazonaws.arczonalshift#ResourceNotFoundException"
},
{
"target": "com.amazonaws.arczonalshift#ThrottlingException"
},
{
"target": "com.amazonaws.arczonalshift#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Deletes the practice run configuration for a resource. Before you can delete\n\t\t\ta practice run configuration for a resource., you must disable zonal autoshift for \n\t\t\tthe resource. Practice runs must be configured for zonal autoshift to be enabled.</p>",
"smithy.api#http": {
"method": "DELETE",
"uri": "/configuration/{resourceIdentifier}",
"code": 200
},
"smithy.api#idempotent": {}
}
},
"com.amazonaws.arczonalshift#DeletePracticeRunConfigurationRequest": {
"type": "structure",
"members": {
"resourceIdentifier": {
"target": "com.amazonaws.arczonalshift#ResourceIdentifier",
"traits": {
"smithy.api#documentation": "<p>The identifier for the resource that you want to delete the practice\n\t\t\trun configuration for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {},
"smithy.api#references": [
{
"resource": "com.amazonaws.arczonalshift#PracticeRunConfigurationResource"
}
]
}
},
"com.amazonaws.arczonalshift#DeletePracticeRunConfigurationResponse": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.arczonalshift#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the resource that you deleted the practice \n\t\t\trun for.</p>",
"smithy.api#required": {}
}
},
"name": {
"target": "com.amazonaws.arczonalshift#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the resource that you deleted the practice \n\t\t\trun for. </p>",
"smithy.api#required": {}
}
},
"zonalAutoshiftStatus": {
"target": "com.amazonaws.arczonalshift#ZonalAutoshiftStatus",
"traits": {
"smithy.api#documentation": "<p>The status of zonal autoshift for the resource.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.arczonalshift#ExpiresIn": {
"type": "string",
"traits": {
"smithy.api#length": {
"min": 2,
"max": 5
},
"smithy.api#pattern": "^([1-9][0-9]*)(m|h)$"
}
},
"com.amazonaws.arczonalshift#ExpiryTime": {
"type": "timestamp"
},
"com.amazonaws.arczonalshift#GetManagedResource": {
"type": "operation",
"input": {
"target": "com.amazonaws.arczonalshift#GetManagedResourceRequest"
},
"output": {
"target": "com.amazonaws.arczonalshift#GetManagedResourceResponse"
},
"errors": [
{
"target": "com.amazonaws.arczonalshift#AccessDeniedException"
},
{
"target": "com.amazonaws.arczonalshift#InternalServerException"
},
{
"target": "com.amazonaws.arczonalshift#ResourceNotFoundException"
},
{
"target": "com.amazonaws.arczonalshift#ThrottlingException"
},
{
"target": "com.amazonaws.arczonalshift#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<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\n \t\tzonal shifts are managed resources in Route 53 ARC. You can start zonal shifts and configure zonal autoshift for managed resources.</p>\n <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>",
"smithy.api#http": {
"method": "GET",
"uri": "/managedresources/{resourceIdentifier}",
"code": 200
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.arczonalshift#GetManagedResourceRequest": {
"type": "structure",
"members": {
"resourceIdentifier": {
"target": "com.amazonaws.arczonalshift#ResourceIdentifier",
"traits": {
"smithy.api#documentation": "<p>The identifier for the resource to shift away traffic for. The identifier is the Amazon Resource Name (ARN) for the resource.</p>\n <p>At this time, supported resources are Network Load Balancers and Application Load Balancers with cross-zone load balancing turned off.</p>",
"smithy.api#httpLabel": {},
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#input": {},
"smithy.api#references": [
{
"resource": "com.amazonaws.arczonalshift#ManagedResource"
}
]
}
},
"com.amazonaws.arczonalshift#GetManagedResourceResponse": {
"type": "structure",
"members": {
"arn": {
"target": "com.amazonaws.arczonalshift#ResourceArn",
"traits": {
"smithy.api#documentation": "<p>The Amazon Resource Name (ARN) for the resource.</p>"
}
},
"name": {
"target": "com.amazonaws.arczonalshift#ResourceName",
"traits": {
"smithy.api#documentation": "<p>The name of the resource.</p>"
}
},
"appliedWeights": {
"target": "com.amazonaws.arczonalshift#AppliedWeights",
"traits": {
"smithy.api#documentation": "<p>A collection of key-value pairs that indicate whether resources are active in Availability Zones or not. \n \t\tThe key name is the Availability Zone where the resource is deployed. The value is 1 or 0.</p>",
"smithy.api#required": {}
}
},
"zonalShifts": {
"target": "com.amazonaws.arczonalshift#ZonalShiftsInResource",
"traits": {
"smithy.api#documentation": "<p>The zonal shifts that are currently active for a resource. </p>",
"smithy.api#required": {}
}
},
"autoshifts": {
"target": "com.amazonaws.arczonalshift#AutoshiftsInResource",
"traits": {
"smithy.api#documentation": "<p>An array of the autoshifts that are active for the resource.</p>"
}
},
"practiceRunConfiguration": {
"target": "com.amazonaws.arczonalshift#PracticeRunConfiguration",
"traits": {
"smithy.api#documentation": "<p>The practice run configuration for zonal autoshift that's associated with\n\t\t\tthe resource.</p>"
}
},
"zonalAutoshiftStatus": {
"target": "com.amazonaws.arczonalshift#ZonalAutoshiftStatus",
"traits": {
"smithy.api#documentation": "<p>The status for zonal autoshift for a resource. When the\n\t\t\tautoshift status is <code>ENABLED</code>, Amazon Web Services shifts traffic \n\t\t\tfor a resource away from an Availability Zone, on your behalf, when \n\t\t\tAmazon Web Services determines that there's an issue in \n\t\t\tthe Availability Zone that could potentially affect customers.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.arczonalshift#InternalServerException": {
"type": "structure",
"members": {
"message": {
"target": "smithy.api#String"
}
},
"traits": {
"smithy.api#documentation": "<p>There was an internal server error.</p>",
"smithy.api#error": "server",
"smithy.api#httpError": 500
}
},
"com.amazonaws.arczonalshift#ListAutoshifts": {
"type": "operation",
"input": {
"target": "com.amazonaws.arczonalshift#ListAutoshiftsRequest"
},
"output": {
"target": "com.amazonaws.arczonalshift#ListAutoshiftsResponse"
},
"errors": [
{
"target": "com.amazonaws.arczonalshift#AccessDeniedException"
},
{
"target": "com.amazonaws.arczonalshift#InternalServerException"
},
{
"target": "com.amazonaws.arczonalshift#ThrottlingException"
},
{
"target": "com.amazonaws.arczonalshift#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Returns the active autoshifts for a specified resource.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/autoshifts",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "items"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.arczonalshift#ListAutoshiftsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the \n\t\t\tprevious request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous \n\t\t\tcall's <code>NextToken</code> response to request the next page of results.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"status": {
"target": "com.amazonaws.arczonalshift#AutoshiftExecutionStatus",
"traits": {
"smithy.api#documentation": "<p>The status of the autoshift.</p>",
"smithy.api#httpQuery": "status"
}
},
"maxResults": {
"target": "com.amazonaws.arczonalshift#MaxResults",
"traits": {
"smithy.api#documentation": "<p>The number of objects that you want to return with this call.</p>",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.arczonalshift#ListAutoshiftsResponse": {
"type": "structure",
"members": {
"items": {
"target": "com.amazonaws.arczonalshift#AutoshiftSummaries",
"traits": {
"smithy.api#documentation": "<p>The items in the response list.</p>"
}
},
"nextToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the \n\t\t\tprevious request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous \n\t\t\tcall's <code>NextToken</code> response to request the next page of results.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.arczonalshift#ListManagedResources": {
"type": "operation",
"input": {
"target": "com.amazonaws.arczonalshift#ListManagedResourcesRequest"
},
"output": {
"target": "com.amazonaws.arczonalshift#ListManagedResourcesResponse"
},
"errors": [
{
"target": "com.amazonaws.arczonalshift#AccessDeniedException"
},
{
"target": "com.amazonaws.arczonalshift#InternalServerException"
},
{
"target": "com.amazonaws.arczonalshift#ThrottlingException"
},
{
"target": "com.amazonaws.arczonalshift#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<p>Lists all the resources in your Amazon Web Services account in this Amazon Web Services Region that are managed for \n \t\tzonal shifts in Amazon Route 53 Application Recovery Controller, and information about them. The information includes the zonal autoshift status for the resource, \n \t\tas well as the Amazon Resource Name (ARN), the Availability Zones that each resource is deployed in, and \n \t\tthe resource name.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/managedresources",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "items"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.arczonalshift#ListManagedResourcesRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the \n \t\tprevious request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous \n \t\tcall's <code>NextToken</code> response to request the next page of results.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"maxResults": {
"target": "com.amazonaws.arczonalshift#MaxResults",
"traits": {
"smithy.api#documentation": "<p>The number of objects that you want to return with this call.</p>",
"smithy.api#httpQuery": "maxResults"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.arczonalshift#ListManagedResourcesResponse": {
"type": "structure",
"members": {
"items": {
"target": "com.amazonaws.arczonalshift#ManagedResourceSummaries",
"traits": {
"smithy.api#documentation": "<p>The items in the response list.</p>",
"smithy.api#required": {}
}
},
"nextToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the \n \t\tprevious request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous \n \t\tcall's <code>NextToken</code> response to request the next page of results.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.arczonalshift#ListZonalShifts": {
"type": "operation",
"input": {
"target": "com.amazonaws.arczonalshift#ListZonalShiftsRequest"
},
"output": {
"target": "com.amazonaws.arczonalshift#ListZonalShiftsResponse"
},
"errors": [
{
"target": "com.amazonaws.arczonalshift#AccessDeniedException"
},
{
"target": "com.amazonaws.arczonalshift#InternalServerException"
},
{
"target": "com.amazonaws.arczonalshift#ThrottlingException"
},
{
"target": "com.amazonaws.arczonalshift#ValidationException"
}
],
"traits": {
"smithy.api#documentation": "<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.\n \t\t<code>ListZonalShifts</code> returns customer-started zonal shifts, as well as practice run zonal shifts that Route 53 ARC started on \n \t\tyour behalf for zonal autoshift.</p>\n <p>The <code>ListZonalShifts</code> operation does not list autoshifts. For more information about listing\n \t\tautoshifts, see <a href=\"https://docs.aws.amazon.com/arc-zonal-shift/latest/api/API_ListAutoshifts.html\">\">ListAutoshifts</a>.</p>",
"smithy.api#http": {
"method": "GET",
"uri": "/zonalshifts",
"code": 200
},
"smithy.api#paginated": {
"inputToken": "nextToken",
"outputToken": "nextToken",
"pageSize": "maxResults",
"items": "items"
},
"smithy.api#readonly": {}
}
},
"com.amazonaws.arczonalshift#ListZonalShiftsRequest": {
"type": "structure",
"members": {
"nextToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the \n \t\tprevious request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous \n \t\tcall's <code>NextToken</code> response to request the next page of results.</p>",
"smithy.api#httpQuery": "nextToken"
}
},
"status": {
"target": "com.amazonaws.arczonalshift#ZonalShiftStatus",
"traits": {
"smithy.api#documentation": "<p>A status for a zonal shift.</p>\n <p>The <code>Status</code> for a zonal shift can have one of the following values:</p>\n <ul>\n <li>\n <p>\n <b>ACTIVE</b>: The zonal shift has been started and active.</p>\n </li>\n <li>\n <p>\n <b>EXPIRED</b>: The zonal shift has expired (the expiry time was exceeded).</p>\n </li>\n <li>\n <p>\n <b>CANCELED</b>: The zonal shift was canceled.</p>\n </li>\n </ul>",
"smithy.api#httpQuery": "status"
}
},
"maxResults": {
"target": "com.amazonaws.arczonalshift#MaxResults",
"traits": {
"smithy.api#documentation": "<p>The number of objects that you want to return with this call.</p>",
"smithy.api#httpQuery": "maxResults"
}
},
"resourceIdentifier": {
"target": "com.amazonaws.arczonalshift#ResourceIdentifier",
"traits": {
"smithy.api#documentation": "<p>The identifier for the resource that you want to list zonal shifts for.\n\t\t\tThe identifier is the Amazon Resource Name (ARN) for the resource.</p>",
"smithy.api#httpQuery": "resourceIdentifier"
}
}
},
"traits": {
"smithy.api#input": {}
}
},
"com.amazonaws.arczonalshift#ListZonalShiftsResponse": {
"type": "structure",
"members": {
"items": {
"target": "com.amazonaws.arczonalshift#ZonalShiftSummaries",
"traits": {
"smithy.api#documentation": "<p>The items in the response list.</p>"
}
},
"nextToken": {
"target": "smithy.api#String",
"traits": {
"smithy.api#documentation": "<p>Specifies that you want to receive the next page of results. Valid only if you received a <code>NextToken</code> response in the \n \t\tprevious request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous \n \t\tcall's <code>NextToken</code> response to request the next page of results.</p>"
}
}
},
"traits": {
"smithy.api#output": {}
}
},
"com.amazonaws.arczonalshift#ManagedResource": {
"type": "resource",
"identifiers": {
"resourceIdentifier": {
"target": "com.amazonaws.arczonalshift#ResourceIdentifier"
}
},
"read": {
"target": "com.amazonaws.arczonalshift#GetManagedResource"
},