/
backup.2018-11-15.json
7527 lines (7527 loc) · 394 KB
/
backup.2018-11-15.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": "1.0",
"metadata": {
"suppressions": [
{
"id": "HttpMethodSemantics",
"namespace": "*"
},
{
"id": "HttpResponseCodeSemantics",
"namespace": "*"
},
{
"id": "PaginatedTrait",
"namespace": "*"
},
{
"id": "HttpHeaderTrait",
"namespace": "*"
},
{
"id": "HttpUriConflict",
"namespace": "*"
},
{
"id": "Service",
"namespace": "*"
}
]
},
"shapes": {
"com.amazonaws.backup#ARN": {
"type": "string"
},
"com.amazonaws.backup#AccountId": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[0-9]{12}$"
}
},
"com.amazonaws.backup#AdvancedBackupSetting": {
"type": "structure",
"members": {
"ResourceType": {
"target": "com.amazonaws.backup#ResourceType",
"traits": {
"smithy.api#documentation": "<p>Specifies an object containing resource type and backup options. The only supported\n resource type is Amazon EC2 instances with Windows Volume Shadow Copy Service\n (VSS). For a CloudFormation example, see the <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html\">sample\n CloudFormation template to enable Windows VSS</a> in the <i>Backup User Guide</i>.</p>\n <p>Valid values: <code>EC2</code>.</p>"
}
},
"BackupOptions": {
"target": "com.amazonaws.backup#BackupOptions",
"traits": {
"smithy.api#documentation": "<p>Specifies the backup option for a selected resource. This option is only available for\n Windows VSS backup jobs.</p>\n <p>Valid values: </p>\n <p>Set to <code>\"WindowsVSS\":\"enabled\"</code> to enable the <code>WindowsVSS</code> backup\n option and create a Windows VSS backup. </p>\n <p>Set to <code>\"WindowsVSS\":\"disabled\"</code> to create a regular backup. The\n <code>WindowsVSS</code> option is not enabled by default.</p>\n <p>If you specify an invalid option, you get an <code>InvalidParameterValueException</code>\n exception.</p>\n <p>For more information about Windows VSS backups, see <a href=\"https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html\">Creating a VSS-Enabled Windows\n Backup</a>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of backup options for each resource type.</p>"
}
},
"com.amazonaws.backup#AdvancedBackupSettings": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#AdvancedBackupSetting"
}
},
"com.amazonaws.backup#AlreadyExistsException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.backup#string"
},
"Message": {
"target": "com.amazonaws.backup#string"
},
"CreatorRequestId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"Arn": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"Type": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"Context": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>The required resource already exists.</p>",
"smithy.api#error": "client"
}
},
"com.amazonaws.backup#BackupJob": {
"type": "structure",
"members": {
"AccountId": {
"target": "com.amazonaws.backup#AccountId",
"traits": {
"smithy.api#documentation": "<p>The account ID that owns the backup job.</p>"
}
},
"BackupJobId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Uniquely identifies a request to Backup to back up a resource.</p>"
}
},
"BackupVaultName": {
"target": "com.amazonaws.backup#BackupVaultName",
"traits": {
"smithy.api#documentation": "<p>The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.</p>"
}
},
"BackupVaultArn": {
"target": "com.amazonaws.backup#ARN",
"traits": {
"smithy.api#documentation": "<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
}
},
"RecoveryPointArn": {
"target": "com.amazonaws.backup#ARN",
"traits": {
"smithy.api#documentation": "<p>An ARN that uniquely identifies a recovery point; for example,\n <code>arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45</code>.</p>"
}
},
"ResourceArn": {
"target": "com.amazonaws.backup#ARN",
"traits": {
"smithy.api#documentation": "<p>An ARN that uniquely identifies a resource. The format of the ARN depends on the\n resource type.</p>"
}
},
"CreationDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time a backup job is created, in Unix format and Coordinated Universal Time\n (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For example, the\n value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
},
"CompletionDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time a job to create a backup job is completed, in Unix format and\n Coordinated Universal Time (UTC). The value of <code>CompletionDate</code> is accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.</p>"
}
},
"State": {
"target": "com.amazonaws.backup#BackupJobState",
"traits": {
"smithy.api#documentation": "<p>The current state of a resource recovery point.</p>"
}
},
"StatusMessage": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>A detailed message explaining the status of the job to back up a resource.</p>"
}
},
"PercentDone": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Contains an estimated percentage complete of a job at the time the job status was\n queried.</p>"
}
},
"BackupSizeInBytes": {
"target": "com.amazonaws.backup#Long",
"traits": {
"smithy.api#documentation": "<p>The size, in bytes, of a backup.</p>"
}
},
"IamRoleArn": {
"target": "com.amazonaws.backup#IAMRoleArn",
"traits": {
"smithy.api#documentation": "<p>Specifies the IAM role ARN used to create the target recovery point. IAM roles other\n than the default role must include either <code>AWSBackup</code> or <code>AwsBackup</code>\n in the role name. For example,\n <code>arn:aws:iam::123456789012:role/AWSBackupRDSAccess</code>. Role names without those\n strings lack permissions to perform backup jobs.</p>"
}
},
"CreatedBy": {
"target": "com.amazonaws.backup#RecoveryPointCreator",
"traits": {
"smithy.api#documentation": "<p>Contains identifying information about the creation of a backup job, including the\n <code>BackupPlanArn</code>, <code>BackupPlanId</code>, <code>BackupPlanVersion</code>,\n and <code>BackupRuleId</code> of the backup plan used to create it.</p>"
}
},
"ExpectedCompletionDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time a job to back up resources is expected to be completed, in Unix format\n and Coordinated Universal Time (UTC). The value of <code>ExpectedCompletionDate</code> is\n accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January\n 26, 2018 12:11:30.087 AM.</p>"
}
},
"StartBy": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job\n must be started before it is canceled. The value is calculated by adding the start window\n to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2\n hours, the <code>StartBy</code> time would be 8:00 PM on the date specified. The value of\n <code>StartBy</code> is accurate to milliseconds. For example, the value 1516925490.087\n represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
},
"ResourceType": {
"target": "com.amazonaws.backup#ResourceType",
"traits": {
"smithy.api#documentation": "<p>The type of Amazon Web Services resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) backups, the only\n supported resource type is Amazon EC2.</p>"
}
},
"BytesTransferred": {
"target": "com.amazonaws.backup#Long",
"traits": {
"smithy.api#documentation": "<p>The size in bytes transferred to a backup vault at the time that the job status was\n queried.</p>"
}
},
"BackupOptions": {
"target": "com.amazonaws.backup#BackupOptions",
"traits": {
"smithy.api#documentation": "<p>Specifies the backup option for a selected resource. This option is only available for\n Windows Volume Shadow Copy Service (VSS) backup jobs.</p>\n <p>Valid values: Set to <code>\"WindowsVSS\":\"enabled\"</code> to enable the\n <code>WindowsVSS</code> backup option and create a Windows VSS backup. Set to\n <code>\"WindowsVSS\":\"disabled\"</code> to create a regular backup. If you specify an\n invalid option, you get an <code>InvalidParameterValueException</code> exception.</p>"
}
},
"BackupType": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Represents the type of backup for a backup job.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains detailed information about a backup job.</p>"
}
},
"com.amazonaws.backup#BackupJobState": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "CREATED",
"name": "CREATED"
},
{
"value": "PENDING",
"name": "PENDING"
},
{
"value": "RUNNING",
"name": "RUNNING"
},
{
"value": "ABORTING",
"name": "ABORTING"
},
{
"value": "ABORTED",
"name": "ABORTED"
},
{
"value": "COMPLETED",
"name": "COMPLETED"
},
{
"value": "FAILED",
"name": "FAILED"
},
{
"value": "EXPIRED",
"name": "EXPIRED"
}
]
}
},
"com.amazonaws.backup#BackupJobsList": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupJob"
}
},
"com.amazonaws.backup#BackupOptionKey": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
}
},
"com.amazonaws.backup#BackupOptionValue": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
}
},
"com.amazonaws.backup#BackupOptions": {
"type": "map",
"key": {
"target": "com.amazonaws.backup#BackupOptionKey"
},
"value": {
"target": "com.amazonaws.backup#BackupOptionValue"
}
},
"com.amazonaws.backup#BackupPlan": {
"type": "structure",
"members": {
"BackupPlanName": {
"target": "com.amazonaws.backup#BackupPlanName",
"traits": {
"smithy.api#documentation": "<p>The display name of a backup plan.</p>",
"smithy.api#required": {}
}
},
"Rules": {
"target": "com.amazonaws.backup#BackupRules",
"traits": {
"smithy.api#documentation": "<p>An array of <code>BackupRule</code> objects, each of which specifies a scheduled task\n that is used to back up a selection of resources. </p>",
"smithy.api#required": {}
}
},
"AdvancedBackupSettings": {
"target": "com.amazonaws.backup#AdvancedBackupSettings",
"traits": {
"smithy.api#documentation": "<p>Contains a list of <code>BackupOptions</code> for each resource type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains an optional backup plan display name and an array of <code>BackupRule</code>\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task and can back up a different selection of Amazon Web Services\n resources.</p>"
}
},
"com.amazonaws.backup#BackupPlanInput": {
"type": "structure",
"members": {
"BackupPlanName": {
"target": "com.amazonaws.backup#BackupPlanName",
"traits": {
"smithy.api#documentation": "<p>The optional display name of a backup plan.</p>",
"smithy.api#required": {}
}
},
"Rules": {
"target": "com.amazonaws.backup#BackupRulesInput",
"traits": {
"smithy.api#documentation": "<p>An array of <code>BackupRule</code> objects, each of which specifies a scheduled task\n that is used to back up a selection of resources.</p>",
"smithy.api#required": {}
}
},
"AdvancedBackupSettings": {
"target": "com.amazonaws.backup#AdvancedBackupSettings",
"traits": {
"smithy.api#documentation": "<p>Specifies a list of <code>BackupOptions</code> for each resource type. These settings\n are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains an optional backup plan display name and an array of <code>BackupRule</code>\n objects, each of which specifies a backup rule. Each rule in a backup plan is a separate\n scheduled task. </p>"
}
},
"com.amazonaws.backup#BackupPlanName": {
"type": "string"
},
"com.amazonaws.backup#BackupPlanTemplatesList": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupPlanTemplatesListMember"
}
},
"com.amazonaws.backup#BackupPlanTemplatesListMember": {
"type": "structure",
"members": {
"BackupPlanTemplateId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Uniquely identifies a stored backup plan template.</p>"
}
},
"BackupPlanTemplateName": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>The optional display name of a backup plan template.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>An object specifying metadata associated with a backup plan template.</p>"
}
},
"com.amazonaws.backup#BackupPlanVersionsList": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupPlansListMember"
}
},
"com.amazonaws.backup#BackupPlansList": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupPlansListMember"
}
},
"com.amazonaws.backup#BackupPlansListMember": {
"type": "structure",
"members": {
"BackupPlanArn": {
"target": "com.amazonaws.backup#ARN",
"traits": {
"smithy.api#documentation": "<p>An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for example,\n <code>arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50</code>.</p>"
}
},
"BackupPlanId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Uniquely identifies a backup plan.</p>"
}
},
"CreationDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time a resource backup plan is created, in Unix format and Coordinated\n Universal Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds.\n For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.</p>"
}
},
"DeletionDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time a backup plan is deleted, in Unix format and Coordinated Universal\n Time (UTC). The value of <code>DeletionDate</code> is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.</p>"
}
},
"VersionId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most 1,024 bytes\n long. Version IDs cannot be edited.</p>"
}
},
"BackupPlanName": {
"target": "com.amazonaws.backup#BackupPlanName",
"traits": {
"smithy.api#documentation": "<p>The display name of a saved backup plan.</p>"
}
},
"CreatorRequestId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.</p>"
}
},
"LastExecutionDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The last time a job to back up resources was run with this rule. A date and time, in\n Unix format and Coordinated Universal Time (UTC). The value of\n <code>LastExecutionDate</code> is accurate to milliseconds. For example, the value\n 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.</p>"
}
},
"AdvancedBackupSettings": {
"target": "com.amazonaws.backup#AdvancedBackupSettings",
"traits": {
"smithy.api#documentation": "<p>Contains a list of <code>BackupOptions</code> for a resource type.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains metadata about a backup plan.</p>"
}
},
"com.amazonaws.backup#BackupRule": {
"type": "structure",
"members": {
"RuleName": {
"target": "com.amazonaws.backup#BackupRuleName",
"traits": {
"smithy.api#documentation": "<p>An optional display name for a backup rule.</p>",
"smithy.api#required": {}
}
},
"TargetBackupVaultName": {
"target": "com.amazonaws.backup#BackupVaultName",
"traits": {
"smithy.api#documentation": "<p>The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.</p>",
"smithy.api#required": {}
}
},
"ScheduleExpression": {
"target": "com.amazonaws.backup#CronExpression",
"traits": {
"smithy.api#documentation": "<p>A cron expression in UTC specifying when Backup initiates a backup job. For\n more information about cron expressions, see <a href=\"https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html\">Schedule Expressions for Rules</a> in the <i>Amazon CloudWatch Events User\n Guide.</i>. Prior to specifying a value for this parameter, we recommend testing\n your cron expression using one of the many available cron generator and testing\n tools.</p>"
}
},
"StartWindowMinutes": {
"target": "com.amazonaws.backup#WindowMinutes",
"traits": {
"smithy.api#documentation": "<p>A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional.</p>"
}
},
"CompletionWindowMinutes": {
"target": "com.amazonaws.backup#WindowMinutes",
"traits": {
"smithy.api#documentation": "<p>A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by Backup. This value is optional.</p>"
}
},
"Lifecycle": {
"target": "com.amazonaws.backup#Lifecycle",
"traits": {
"smithy.api#documentation": "<p>The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define. </p>\n <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold. </p>\n <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
}
},
"RecoveryPointTags": {
"target": "com.amazonaws.backup#Tags",
"traits": {
"smithy.api#documentation": "<p>An array of key-value pair strings that are assigned to resources that are associated\n with this rule when restored from backup.</p>"
}
},
"RuleId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Uniquely identifies a rule that is used to schedule the backup of a selection of\n resources.</p>"
}
},
"CopyActions": {
"target": "com.amazonaws.backup#CopyActions",
"traits": {
"smithy.api#documentation": "<p>An array of <code>CopyAction</code> objects, which contains the details of the copy\n operation.</p>"
}
},
"EnableContinuousBackup": {
"target": "com.amazonaws.backup#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Specifies a scheduled task used to back up a selection of resources.</p>"
}
},
"com.amazonaws.backup#BackupRuleInput": {
"type": "structure",
"members": {
"RuleName": {
"target": "com.amazonaws.backup#BackupRuleName",
"traits": {
"smithy.api#documentation": "<p>An optional display name for a backup rule.</p>",
"smithy.api#required": {}
}
},
"TargetBackupVaultName": {
"target": "com.amazonaws.backup#BackupVaultName",
"traits": {
"smithy.api#documentation": "<p>The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.</p>",
"smithy.api#required": {}
}
},
"ScheduleExpression": {
"target": "com.amazonaws.backup#CronExpression",
"traits": {
"smithy.api#documentation": "<p>A CRON expression in UTC specifying when Backup initiates a backup\n job.</p>"
}
},
"StartWindowMinutes": {
"target": "com.amazonaws.backup#WindowMinutes",
"traits": {
"smithy.api#documentation": "<p>A value in minutes after a backup is scheduled before a job will be canceled if it\n doesn't start successfully. This value is optional.</p>"
}
},
"CompletionWindowMinutes": {
"target": "com.amazonaws.backup#WindowMinutes",
"traits": {
"smithy.api#documentation": "<p>A value in minutes after a backup job is successfully started before it must be\n completed or it will be canceled by Backup. This value is optional.</p>"
}
},
"Lifecycle": {
"target": "com.amazonaws.backup#Lifecycle",
"traits": {
"smithy.api#documentation": "<p>The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup will transition and expire backups automatically according\n to the lifecycle that you define. </p>\n <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold. </p>\n <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
}
},
"RecoveryPointTags": {
"target": "com.amazonaws.backup#Tags",
"traits": {
"smithy.api#documentation": "<p>To help organize your resources, you can assign your own metadata to the resources that\n you create. Each tag is a key-value pair.</p>"
}
},
"CopyActions": {
"target": "com.amazonaws.backup#CopyActions",
"traits": {
"smithy.api#documentation": "<p>An array of <code>CopyAction</code> objects, which contains the details of the copy\n operation.</p>"
}
},
"EnableContinuousBackup": {
"target": "com.amazonaws.backup#Boolean",
"traits": {
"smithy.api#documentation": "<p>Specifies whether Backup creates continuous backups. True causes Backup to create continuous backups capable of point-in-time restore (PITR). False\n (or not specified) causes Backup to create snapshot backups.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Specifies a scheduled task used to back up a selection of resources.</p>"
}
},
"com.amazonaws.backup#BackupRuleName": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
}
},
"com.amazonaws.backup#BackupRules": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupRule"
}
},
"com.amazonaws.backup#BackupRulesInput": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupRuleInput"
}
},
"com.amazonaws.backup#BackupSelection": {
"type": "structure",
"members": {
"SelectionName": {
"target": "com.amazonaws.backup#BackupSelectionName",
"traits": {
"smithy.api#documentation": "<p>The display name of a resource selection document.</p>",
"smithy.api#required": {}
}
},
"IamRoleArn": {
"target": "com.amazonaws.backup#IAMRoleArn",
"traits": {
"smithy.api#documentation": "<p>The ARN of the IAM role that Backup uses to authenticate when backing up the\n target resource; for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>",
"smithy.api#required": {}
}
},
"Resources": {
"target": "com.amazonaws.backup#ResourceArns",
"traits": {
"smithy.api#documentation": "<p>An array of strings that contain Amazon Resource Names (ARNs)\n \n of resources to assign to a backup plan.</p>"
}
},
"ListOfTags": {
"target": "com.amazonaws.backup#ListOfTags",
"traits": {
"smithy.api#documentation": "<p>An array of conditions used to specify a set of resources to assign to a backup plan;\n for example, <code>\"StringEquals\": {\"ec2:ResourceTag/Department\": \"accounting\"</code>.\n Assigns the backup plan to every resource with at least one matching tag.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Used to specify a set of resources to a backup plan.</p>"
}
},
"com.amazonaws.backup#BackupSelectionName": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[a-zA-Z0-9\\-\\_\\.]{1,50}$"
}
},
"com.amazonaws.backup#BackupSelectionsList": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupSelectionsListMember"
}
},
"com.amazonaws.backup#BackupSelectionsListMember": {
"type": "structure",
"members": {
"SelectionId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Uniquely identifies a request to assign a set of resources to a backup plan.</p>"
}
},
"SelectionName": {
"target": "com.amazonaws.backup#BackupSelectionName",
"traits": {
"smithy.api#documentation": "<p>The display name of a resource selection document.</p>"
}
},
"BackupPlanId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>Uniquely identifies a backup plan.</p>"
}
},
"CreationDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time a backup plan is created, in Unix format and Coordinated Universal\n Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.</p>"
}
},
"CreatorRequestId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.</p>"
}
},
"IamRoleArn": {
"target": "com.amazonaws.backup#IAMRoleArn",
"traits": {
"smithy.api#documentation": "<p>Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery point;\n for example, <code>arn:aws:iam::123456789012:role/S3Access</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains metadata about a <code>BackupSelection</code> object.</p>"
}
},
"com.amazonaws.backup#BackupVaultEvent": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "BACKUP_JOB_STARTED",
"name": "BACKUP_JOB_STARTED"
},
{
"value": "BACKUP_JOB_COMPLETED",
"name": "BACKUP_JOB_COMPLETED"
},
{
"value": "BACKUP_JOB_SUCCESSFUL",
"name": "BACKUP_JOB_SUCCESSFUL"
},
{
"value": "BACKUP_JOB_FAILED",
"name": "BACKUP_JOB_FAILED"
},
{
"value": "BACKUP_JOB_EXPIRED",
"name": "BACKUP_JOB_EXPIRED"
},
{
"value": "RESTORE_JOB_STARTED",
"name": "RESTORE_JOB_STARTED"
},
{
"value": "RESTORE_JOB_COMPLETED",
"name": "RESTORE_JOB_COMPLETED"
},
{
"value": "RESTORE_JOB_SUCCESSFUL",
"name": "RESTORE_JOB_SUCCESSFUL"
},
{
"value": "RESTORE_JOB_FAILED",
"name": "RESTORE_JOB_FAILED"
},
{
"value": "COPY_JOB_STARTED",
"name": "COPY_JOB_STARTED"
},
{
"value": "COPY_JOB_SUCCESSFUL",
"name": "COPY_JOB_SUCCESSFUL"
},
{
"value": "COPY_JOB_FAILED",
"name": "COPY_JOB_FAILED"
},
{
"value": "RECOVERY_POINT_MODIFIED",
"name": "RECOVERY_POINT_MODIFIED"
},
{
"value": "BACKUP_PLAN_CREATED",
"name": "BACKUP_PLAN_CREATED"
},
{
"value": "BACKUP_PLAN_MODIFIED",
"name": "BACKUP_PLAN_MODIFIED"
}
]
}
},
"com.amazonaws.backup#BackupVaultEvents": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupVaultEvent"
}
},
"com.amazonaws.backup#BackupVaultList": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#BackupVaultListMember"
}
},
"com.amazonaws.backup#BackupVaultListMember": {
"type": "structure",
"members": {
"BackupVaultName": {
"target": "com.amazonaws.backup#BackupVaultName",
"traits": {
"smithy.api#documentation": "<p>The name of a logical container where backups are stored. Backup vaults are identified\n by names that are unique to the account used to create them and the Amazon Web Services\n Region where they are created. They consist of lowercase letters, numbers, and\n hyphens.</p>"
}
},
"BackupVaultArn": {
"target": "com.amazonaws.backup#ARN",
"traits": {
"smithy.api#documentation": "<p>An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example,\n <code>arn:aws:backup:us-east-1:123456789012:vault:aBackupVault</code>.</p>"
}
},
"CreationDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time a resource backup is created, in Unix format and Coordinated Universal\n Time (UTC). The value of <code>CreationDate</code> is accurate to milliseconds. For\n example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087\n AM.</p>"
}
},
"EncryptionKeyArn": {
"target": "com.amazonaws.backup#ARN",
"traits": {
"smithy.api#documentation": "<p>The server-side encryption key that is used to protect your backups; for example,\n <code>arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab</code>.</p>"
}
},
"CreatorRequestId": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p>A unique string that identifies the request and allows failed requests to be retried\n without the risk of running the operation twice.</p>"
}
},
"NumberOfRecoveryPoints": {
"target": "com.amazonaws.backup#Long2",
"traits": {
"smithy.api#documentation": "<p>The number of recovery points that are stored in a backup vault.</p>"
}
},
"Locked": {
"target": "com.amazonaws.backup#Boolean",
"traits": {
"smithy.api#documentation": "<p>A Boolean value that indicates whether Backup Vault Lock applies to the\n selected backup vault. If <code>true</code>, Vault Lock prevents delete and update\n operations on the recovery points in the selected vault.</p>"
}
},
"MinRetentionDays": {
"target": "com.amazonaws.backup#Long",
"traits": {
"smithy.api#documentation": "<p>The Backup Vault Lock setting that specifies the minimum retention period\n that the vault retains its recovery points. If this parameter is not specified, Vault Lock\n does not enforce a minimum retention period.</p>\n <p>If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or longer than the minimum retention period. If the job's\n retention period is shorter than that minimum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.</p>"
}
},
"MaxRetentionDays": {
"target": "com.amazonaws.backup#Long",
"traits": {
"smithy.api#documentation": "<p>The Backup Vault Lock setting that specifies the maximum retention period\n that the vault retains its recovery points. If this parameter is not specified, Vault Lock\n does not enforce a maximum retention period on the recovery points in the vault (allowing\n indefinite storage).</p>\n <p>If specified, any backup or copy job to the vault must have a lifecycle policy with a\n retention period equal to or shorter than the maximum retention period. If the job's\n retention period is longer than that maximum retention period, then the vault fails the\n backup or copy job, and you should either modify your lifecycle settings or use a different\n vault. Recovery points already stored in the vault prior to Vault Lock are not\n affected.</p>"
}
},
"LockDate": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>The date and time when Backup Vault Lock configuration becomes immutable,\n meaning it cannot be changed or deleted.</p>\n <p>If you applied Vault Lock to your vault without specifying a lock date, you can change\n your Vault Lock settings, or delete Vault Lock from the vault entirely, at any time.</p>\n <p>This value is in Unix format, Coordinated Universal Time (UTC), and accurate to\n milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018\n 12:11:30.087 AM.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains metadata about a backup vault.</p>"
}
},
"com.amazonaws.backup#BackupVaultName": {
"type": "string",
"traits": {
"smithy.api#pattern": "^[a-zA-Z0-9\\-\\_]{2,50}$"
}
},
"com.amazonaws.backup#Boolean": {
"type": "boolean",
"traits": {
"smithy.api#box": {}
}
},
"com.amazonaws.backup#Boolean2": {
"type": "boolean"
},
"com.amazonaws.backup#CalculatedLifecycle": {
"type": "structure",
"members": {
"MoveToColdStorageAt": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp that specifies when to transition a recovery point to cold storage.</p>"
}
},
"DeleteAt": {
"target": "com.amazonaws.backup#timestamp",
"traits": {
"smithy.api#documentation": "<p>A timestamp that specifies when to delete a recovery point.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains <code>DeleteAt</code> and <code>MoveToColdStorageAt</code> timestamps, which\n are used to specify a lifecycle for a recovery point.</p>\n <p>The lifecycle defines when a protected resource is transitioned to cold storage and when\n it expires. Backup transitions and expires backups automatically according to\n the lifecycle that you define.</p>\n <p>Backups transitioned to cold storage must be stored in cold storage for a minimum of 90\n days. Therefore, the “expire after days” setting must be 90 days greater than the\n “transition to cold after days” setting. The “transition to cold after days” setting cannot\n be changed after a backup has been transitioned to cold.</p>\n <p>Only Amazon EFS file system backups can be transitioned to cold storage.</p>"
}
},
"com.amazonaws.backup#ComplianceResourceIdList": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#string"
},
"traits": {
"smithy.api#length": {
"min": 1,
"max": 100
}
}
},
"com.amazonaws.backup#Condition": {
"type": "structure",
"members": {
"ConditionType": {
"target": "com.amazonaws.backup#ConditionType",
"traits": {
"smithy.api#documentation": "<p>An operation, such as <code>StringEquals</code>, that is applied to a key-value pair\n used to filter resources in a selection.</p>",
"smithy.api#required": {}
}
},
"ConditionKey": {
"target": "com.amazonaws.backup#ConditionKey",
"traits": {
"smithy.api#documentation": "<p>The key in a key-value pair. For example, in <code>\"ec2:ResourceTag/Department\":\n \"accounting\"</code>, <code>\"ec2:ResourceTag/Department\"</code> is the key.</p>",
"smithy.api#required": {}
}
},
"ConditionValue": {
"target": "com.amazonaws.backup#ConditionValue",
"traits": {
"smithy.api#documentation": "<p>The value in a key-value pair. For example, in <code>\"ec2:ResourceTag/Department\":\n \"accounting\"</code>, <code>\"accounting\"</code> is the value.</p>",
"smithy.api#required": {}
}
}
},
"traits": {
"smithy.api#documentation": "<p>Contains an array of triplets made up of a condition type (such as\n <code>StringEquals</code>), a key, and a value. Conditions are used to filter resources\n in a selection that is assigned to a backup plan.</p>"
}
},
"com.amazonaws.backup#ConditionKey": {
"type": "string"
},
"com.amazonaws.backup#ConditionType": {
"type": "string",
"traits": {
"smithy.api#enum": [
{
"value": "STRINGEQUALS",
"name": "STRINGEQUALS"
}
]
}
},
"com.amazonaws.backup#ConditionValue": {
"type": "string"
},
"com.amazonaws.backup#ConflictException": {
"type": "structure",
"members": {
"Code": {
"target": "com.amazonaws.backup#string"
},
"Message": {
"target": "com.amazonaws.backup#string"
},
"Type": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p></p>"
}
},
"Context": {
"target": "com.amazonaws.backup#string",
"traits": {
"smithy.api#documentation": "<p></p>"
}
}
},
"traits": {
"aws.protocols#awsQueryError": {
"code": "ConflictException",
"httpResponseCode": 409
},
"smithy.api#documentation": "<p>Backup can't perform the action that you requested until it finishes\n performing a previous action. Try again later.</p>",
"smithy.api#error": "client",
"smithy.api#httpError": 409
}
},
"com.amazonaws.backup#ControlInputParameter": {
"type": "structure",
"members": {
"ParameterName": {
"target": "com.amazonaws.backup#ParameterName",
"traits": {
"smithy.api#documentation": "<p>The name of a parameter, for example, <code>BackupPlanFrequency</code>.</p>"
}
},
"ParameterValue": {
"target": "com.amazonaws.backup#ParameterValue",
"traits": {
"smithy.api#documentation": "<p>The value of parameter, for example, <code>hourly</code>.</p>"
}
}
},
"traits": {
"smithy.api#documentation": "<p>A list of parameters for a control. A control can have zero, one, or more than one\n parameter. An example of a control with two parameters is: \"backup plan frequency is at\n least <code>daily</code> and the retention period is at least <code>1 year</code>\". The\n first parameter is <code>daily</code>. The second parameter is <code>1 year</code>.</p>"
}
},
"com.amazonaws.backup#ControlInputParameters": {
"type": "list",
"member": {
"target": "com.amazonaws.backup#ControlInputParameter"
}
},
"com.amazonaws.backup#ControlName": {
"type": "string"