/
docs-2.json
1452 lines (1452 loc) · 64.6 KB
/
docs-2.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
{
"version": "2.0",
"service": "<p>Amplify enables developers to develop and deploy cloud-powered mobile and web apps. The Amplify Console provides a continuous delivery and hosting service for web applications. For more information, see the <a href=\"https://docs.aws.amazon.com/amplify/latest/userguide/welcome.html\">Amplify Console User Guide</a>. The Amplify Framework is a comprehensive set of SDKs, libraries, tools, and documentation for client app development. For more information, see the <a href=\"https://docs.amplify.aws/\">Amplify Framework.</a> </p>",
"operations": {
"CreateApp": "<p> Creates a new Amplify app. </p>",
"CreateBackendEnvironment": "<p> Creates a new backend environment for an Amplify app. </p>",
"CreateBranch": "<p> Creates a new branch for an Amplify app. </p>",
"CreateDeployment": "<p> Creates a deployment for a manually deployed Amplify app. Manually deployed apps are not connected to a repository. </p>",
"CreateDomainAssociation": "<p> Creates a new domain association for an Amplify app. This action associates a custom domain with the Amplify app </p>",
"CreateWebhook": "<p> Creates a new webhook on an Amplify app. </p>",
"DeleteApp": "<p> Deletes an existing Amplify app specified by an app ID. </p>",
"DeleteBackendEnvironment": "<p> Deletes a backend environment for an Amplify app. </p>",
"DeleteBranch": "<p> Deletes a branch for an Amplify app. </p>",
"DeleteDomainAssociation": "<p> Deletes a domain association for an Amplify app. </p>",
"DeleteJob": "<p> Deletes a job for a branch of an Amplify app. </p>",
"DeleteWebhook": "<p> Deletes a webhook. </p>",
"GenerateAccessLogs": "<p> Returns the website access logs for a specific time range using a presigned URL. </p>",
"GetApp": "<p> Returns an existing Amplify app by appID. </p>",
"GetArtifactUrl": "<p> Returns the artifact info that corresponds to an artifact id. </p>",
"GetBackendEnvironment": "<p> Returns a backend environment for an Amplify app. </p>",
"GetBranch": "<p> Returns a branch for an Amplify app. </p>",
"GetDomainAssociation": "<p> Returns the domain information for an Amplify app. </p>",
"GetJob": "<p> Returns a job for a branch of an Amplify app. </p>",
"GetWebhook": "<p> Returns the webhook information that corresponds to a specified webhook ID. </p>",
"ListApps": "<p> Returns a list of the existing Amplify apps. </p>",
"ListArtifacts": "<p> Returns a list of artifacts for a specified app, branch, and job. </p>",
"ListBackendEnvironments": "<p> Lists the backend environments for an Amplify app. </p>",
"ListBranches": "<p> Lists the branches of an Amplify app. </p>",
"ListDomainAssociations": "<p> Returns the domain associations for an Amplify app. </p>",
"ListJobs": "<p> Lists the jobs for a branch of an Amplify app. </p>",
"ListTagsForResource": "<p> Returns a list of tags for a specified Amazon Resource Name (ARN). </p>",
"ListWebhooks": "<p> Returns a list of webhooks for an Amplify app. </p>",
"StartDeployment": "<p> Starts a deployment for a manually deployed app. Manually deployed apps are not connected to a repository. </p>",
"StartJob": "<p> Starts a new job for a branch of an Amplify app. </p>",
"StopJob": "<p> Stops a job that is in progress for a branch of an Amplify app. </p>",
"TagResource": "<p> Tags the resource with a tag key and value. </p>",
"UntagResource": "<p> Untags a resource with a specified Amazon Resource Name (ARN). </p>",
"UpdateApp": "<p> Updates an existing Amplify app. </p>",
"UpdateBranch": "<p> Updates a branch for an Amplify app. </p>",
"UpdateDomainAssociation": "<p> Creates a new domain association for an Amplify app.</p>",
"UpdateWebhook": "<p> Updates a webhook. </p>"
},
"shapes": {
"AccessToken": {
"base": null,
"refs": {
"CreateAppRequest$accessToken": "<p> The personal access token for a third-party source control system for an Amplify app. The personal access token is used to create a webhook and a read-only deploy key. The token is not stored. </p>",
"UpdateAppRequest$accessToken": "<p> The personal access token for a third-party source control system for an Amplify app. The token is used to create webhook and a read-only deploy key. The token is not stored. </p>"
}
},
"ActiveJobId": {
"base": null,
"refs": {
"Branch$activeJobId": "<p> The ID of the active job for a branch of an Amplify app. </p>"
}
},
"App": {
"base": "<p> Represents the different branches of a repository for building, deploying, and hosting an Amplify app. </p>",
"refs": {
"Apps$member": null,
"CreateAppResult$app": null,
"DeleteAppResult$app": null,
"GetAppResult$app": null,
"UpdateAppResult$app": "<p> Represents the updated Amplify app. </p>"
}
},
"AppArn": {
"base": null,
"refs": {
"App$appArn": "<p> The Amazon Resource Name (ARN) of the Amplify app. </p>"
}
},
"AppId": {
"base": null,
"refs": {
"App$appId": "<p> The unique ID of the Amplify app. </p>",
"CreateBackendEnvironmentRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"CreateBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"CreateDeploymentRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"CreateDomainAssociationRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"CreateWebhookRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"DeleteAppRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"DeleteBackendEnvironmentRequest$appId": "<p> The unique ID of an Amplify app. </p>",
"DeleteBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"DeleteDomainAssociationRequest$appId": "<p> The unique id for an Amplify app. </p>",
"DeleteJobRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"GenerateAccessLogsRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"GetAppRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"GetBackendEnvironmentRequest$appId": "<p> The unique id for an Amplify app. </p>",
"GetBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"GetDomainAssociationRequest$appId": "<p> The unique id for an Amplify app. </p>",
"GetJobRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"ListArtifactsRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"ListBackendEnvironmentsRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"ListBranchesRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"ListDomainAssociationsRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"ListJobsRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"ListWebhooksRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"StartDeploymentRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"StartJobRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"StopJobRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"UpdateAppRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"UpdateBranchRequest$appId": "<p> The unique ID for an Amplify app. </p>",
"UpdateDomainAssociationRequest$appId": "<p> The unique ID for an Amplify app. </p>"
}
},
"Apps": {
"base": null,
"refs": {
"ListAppsResult$apps": "<p> A list of Amplify apps. </p>"
}
},
"Artifact": {
"base": "<p> Describes an artifact. </p>",
"refs": {
"Artifacts$member": null
}
},
"ArtifactFileName": {
"base": null,
"refs": {
"Artifact$artifactFileName": "<p> The file name for the artifact. </p>"
}
},
"ArtifactId": {
"base": null,
"refs": {
"Artifact$artifactId": "<p> The unique ID for the artifact. </p>",
"GetArtifactUrlRequest$artifactId": "<p> The unique ID for an artifact. </p>",
"GetArtifactUrlResult$artifactId": "<p> The unique ID for an artifact. </p>"
}
},
"ArtifactUrl": {
"base": null,
"refs": {
"GetArtifactUrlResult$artifactUrl": "<p> The presigned URL for the artifact. </p>"
}
},
"Artifacts": {
"base": null,
"refs": {
"ListArtifactsResult$artifacts": "<p> A list of artifacts. </p>"
}
},
"ArtifactsUrl": {
"base": null,
"refs": {
"Step$artifactsUrl": "<p> The URL to the artifact for the execution step. </p>"
}
},
"AssociatedResource": {
"base": null,
"refs": {
"AssociatedResources$member": null
}
},
"AssociatedResources": {
"base": null,
"refs": {
"Branch$associatedResources": "<p> A list of custom resources that are linked to this branch. </p>"
}
},
"AutoBranchCreationConfig": {
"base": "<p> Describes the automated branch creation configuration. </p>",
"refs": {
"App$autoBranchCreationConfig": "<p> Describes the automated branch creation configuration for the Amplify app. </p>",
"CreateAppRequest$autoBranchCreationConfig": "<p> The automated branch creation configuration for an Amplify app. </p>",
"UpdateAppRequest$autoBranchCreationConfig": "<p> The automated branch creation configuration for an Amplify app. </p>"
}
},
"AutoBranchCreationPattern": {
"base": null,
"refs": {
"AutoBranchCreationPatterns$member": null
}
},
"AutoBranchCreationPatterns": {
"base": null,
"refs": {
"App$autoBranchCreationPatterns": "<p> Describes the automated branch creation glob patterns for the Amplify app. </p>",
"CreateAppRequest$autoBranchCreationPatterns": "<p> The automated branch creation glob patterns for an Amplify app. </p>",
"UpdateAppRequest$autoBranchCreationPatterns": "<p> Describes the automated branch creation glob patterns for an Amplify app. </p>"
}
},
"AutoSubDomainCreationPattern": {
"base": null,
"refs": {
"AutoSubDomainCreationPatterns$member": null
}
},
"AutoSubDomainCreationPatterns": {
"base": null,
"refs": {
"CreateDomainAssociationRequest$autoSubDomainCreationPatterns": "<p> Sets the branch patterns for automatic subdomain creation. </p>",
"DomainAssociation$autoSubDomainCreationPatterns": "<p> Sets branch patterns for automatic subdomain creation. </p>",
"UpdateDomainAssociationRequest$autoSubDomainCreationPatterns": "<p> Sets the branch patterns for automatic subdomain creation. </p>"
}
},
"AutoSubDomainIAMRole": {
"base": null,
"refs": {
"CreateDomainAssociationRequest$autoSubDomainIAMRole": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>",
"DomainAssociation$autoSubDomainIAMRole": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>",
"UpdateDomainAssociationRequest$autoSubDomainIAMRole": "<p> The required AWS Identity and Access Management (IAM) service role for the Amazon Resource Name (ARN) for automatically creating subdomains. </p>"
}
},
"BackendEnvironment": {
"base": "<p> Describes the backend environment for an Amplify app. </p>",
"refs": {
"BackendEnvironments$member": null,
"CreateBackendEnvironmentResult$backendEnvironment": "<p> Describes the backend environment for an Amplify app. </p>",
"DeleteBackendEnvironmentResult$backendEnvironment": "<p> Describes the backend environment for an Amplify app. </p>",
"GetBackendEnvironmentResult$backendEnvironment": "<p> Describes the backend environment for an Amplify app. </p>"
}
},
"BackendEnvironmentArn": {
"base": null,
"refs": {
"BackendEnvironment$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>",
"Branch$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>",
"CreateBranchRequest$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>",
"UpdateBranchRequest$backendEnvironmentArn": "<p> The Amazon Resource Name (ARN) for a backend environment that is part of an Amplify app. </p>"
}
},
"BackendEnvironments": {
"base": null,
"refs": {
"ListBackendEnvironmentsResult$backendEnvironments": "<p> The list of backend environments for an Amplify app. </p>"
}
},
"BadRequestException": {
"base": "<p> A request contains unexpected data. </p>",
"refs": {
}
},
"BasicAuthCredentials": {
"base": null,
"refs": {
"App$basicAuthCredentials": "<p> The basic authorization credentials for branches for the Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>",
"AutoBranchCreationConfig$basicAuthCredentials": "<p> The basic authorization credentials for the autocreated branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>",
"Branch$basicAuthCredentials": "<p> The basic authorization credentials for a branch of an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>",
"CreateAppRequest$basicAuthCredentials": "<p> The credentials for basic authorization for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>",
"CreateBranchRequest$basicAuthCredentials": "<p> The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>",
"UpdateAppRequest$basicAuthCredentials": "<p> The basic authorization credentials for an Amplify app. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>",
"UpdateBranchRequest$basicAuthCredentials": "<p> The basic authorization credentials for the branch. You must base64-encode the authorization credentials and provide them in the format <code>user:password</code>.</p>"
}
},
"Branch": {
"base": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>",
"refs": {
"Branches$member": null,
"CreateBranchResult$branch": "<p> Describes the branch for an Amplify app, which maps to a third-party repository branch. </p>",
"DeleteBranchResult$branch": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>",
"GetBranchResult$branch": null,
"UpdateBranchResult$branch": "<p> The branch for an Amplify app, which maps to a third-party repository branch. </p>"
}
},
"BranchArn": {
"base": null,
"refs": {
"Branch$branchArn": "<p> The Amazon Resource Name (ARN) for a branch that is part of an Amplify app. </p>"
}
},
"BranchName": {
"base": null,
"refs": {
"Branch$branchName": "<p> The name for the branch that is part of an Amplify app. </p>",
"Branch$destinationBranch": "<p> The destination branch if the branch is a pull request branch. </p>",
"Branch$sourceBranch": "<p> The source branch if the branch is a pull request branch. </p>",
"CreateBranchRequest$branchName": "<p> The name for the branch. </p>",
"CreateDeploymentRequest$branchName": "<p> The name for the branch, for the job. </p>",
"CreateWebhookRequest$branchName": "<p> The name for a branch that is part of an Amplify app. </p>",
"DeleteBranchRequest$branchName": "<p> The name for the branch. </p>",
"DeleteJobRequest$branchName": "<p> The name for the branch, for the job. </p>",
"GetBranchRequest$branchName": "<p> The name for the branch. </p>",
"GetJobRequest$branchName": "<p> The branch name for the job. </p>",
"ListArtifactsRequest$branchName": "<p> The name of a branch that is part of an Amplify app. </p>",
"ListJobsRequest$branchName": "<p> The name for a branch. </p>",
"ProductionBranch$branchName": "<p> The branch name for the production branch. </p>",
"StartDeploymentRequest$branchName": "<p> The name for the branch, for the job. </p>",
"StartJobRequest$branchName": "<p> The branch name for the job. </p>",
"StopJobRequest$branchName": "<p> The name for the branch, for the job. </p>",
"SubDomainSetting$branchName": "<p> The branch name setting for the subdomain. </p>",
"UpdateBranchRequest$branchName": "<p> The name for the branch. </p>",
"UpdateWebhookRequest$branchName": "<p> The name for a branch that is part of an Amplify app. </p>",
"Webhook$branchName": "<p> The name for a branch that is part of an Amplify app. </p>"
}
},
"Branches": {
"base": null,
"refs": {
"ListBranchesResult$branches": "<p> A list of branches for an Amplify app. </p>"
}
},
"BuildSpec": {
"base": "<p> The build specification (build spec) file for an Amplify app build. </p>",
"refs": {
"App$buildSpec": "<p> Describes the content of the build specification (build spec) for the Amplify app. </p>",
"AutoBranchCreationConfig$buildSpec": "<p> The build specification (build spec) for the autocreated branch. </p>",
"Branch$buildSpec": "<p> The build specification (build spec) content for the branch of an Amplify app. </p>",
"CreateAppRequest$buildSpec": "<p> The build specification (build spec) for an Amplify app. </p>",
"CreateBranchRequest$buildSpec": "<p> The build specification (build spec) for the branch. </p>",
"UpdateAppRequest$buildSpec": "<p> The build specification (build spec) for an Amplify app. </p>",
"UpdateBranchRequest$buildSpec": "<p> The build specification (build spec) for the branch. </p>"
}
},
"CertificateVerificationDNSRecord": {
"base": null,
"refs": {
"DomainAssociation$certificateVerificationDNSRecord": "<p> The DNS record for certificate verification. </p>"
}
},
"Code": {
"base": null,
"refs": {
"ResourceNotFoundException$code": null
}
},
"CommitId": {
"base": null,
"refs": {
"JobSummary$commitId": "<p> The commit ID from a third-party repository provider for the job. </p>",
"StartJobRequest$commitId": "<p> The commit ID from a third-party repository provider for the job. </p>"
}
},
"CommitMessage": {
"base": null,
"refs": {
"JobSummary$commitMessage": "<p> The commit message from a third-party repository provider for the job. </p>",
"StartJobRequest$commitMessage": "<p> The commit message from a third-party repository provider for the job. </p>"
}
},
"CommitTime": {
"base": null,
"refs": {
"JobSummary$commitTime": "<p> The commit date and time for the job. </p>",
"StartJobRequest$commitTime": "<p> The commit date and time for the job. </p>"
}
},
"Condition": {
"base": null,
"refs": {
"CustomRule$condition": "<p> The condition for a URL rewrite or redirect rule, such as a country code. </p>"
}
},
"Context": {
"base": null,
"refs": {
"Step$context": "<p> The context for the current step. Includes a build image if the step is build. </p>"
}
},
"CreateAppRequest": {
"base": "<p> The request structure used to create apps in Amplify. </p>",
"refs": {
}
},
"CreateAppResult": {
"base": null,
"refs": {
}
},
"CreateBackendEnvironmentRequest": {
"base": "<p> The request structure for the backend environment create request. </p>",
"refs": {
}
},
"CreateBackendEnvironmentResult": {
"base": "<p> The result structure for the create backend environment request. </p>",
"refs": {
}
},
"CreateBranchRequest": {
"base": "<p> The request structure for the create branch request. </p>",
"refs": {
}
},
"CreateBranchResult": {
"base": "<p> The result structure for create branch request. </p>",
"refs": {
}
},
"CreateDeploymentRequest": {
"base": "<p> The request structure for the create a new deployment request. </p>",
"refs": {
}
},
"CreateDeploymentResult": {
"base": "<p> The result structure for the create a new deployment request. </p>",
"refs": {
}
},
"CreateDomainAssociationRequest": {
"base": "<p> The request structure for the create domain association request. </p>",
"refs": {
}
},
"CreateDomainAssociationResult": {
"base": "<p> The result structure for the create domain association request. </p>",
"refs": {
}
},
"CreateTime": {
"base": null,
"refs": {
"App$createTime": "<p> Creates a date and time for the Amplify app. </p>",
"BackendEnvironment$createTime": "<p> The creation date and time for a backend environment that is part of an Amplify app. </p>",
"Branch$createTime": "<p> The creation date and time for a branch that is part of an Amplify app. </p>",
"Webhook$createTime": "<p> The create date and time for a webhook. </p>"
}
},
"CreateWebhookRequest": {
"base": "<p> The request structure for the create webhook request. </p>",
"refs": {
}
},
"CreateWebhookResult": {
"base": "<p> The result structure for the create webhook request. </p>",
"refs": {
}
},
"CustomDomain": {
"base": null,
"refs": {
"CustomDomains$member": null
}
},
"CustomDomains": {
"base": null,
"refs": {
"Branch$customDomains": "<p> The custom domains for a branch of an Amplify app. </p>"
}
},
"CustomHeaders": {
"base": null,
"refs": {
"App$customHeaders": "<p>Describes the custom HTTP headers for the Amplify app.</p>",
"CreateAppRequest$customHeaders": "<p>The custom HTTP headers for an Amplify app.</p>",
"UpdateAppRequest$customHeaders": "<p>The custom HTTP headers for an Amplify app.</p>"
}
},
"CustomRule": {
"base": "<p> Describes a custom rewrite or redirect rule. </p>",
"refs": {
"CustomRules$member": null
}
},
"CustomRules": {
"base": null,
"refs": {
"App$customRules": "<p> Describes the custom redirect and rewrite rules for the Amplify app. </p>",
"CreateAppRequest$customRules": "<p> The custom rewrite and redirect rules for an Amplify app. </p>",
"UpdateAppRequest$customRules": "<p> The custom redirect and rewrite rules for an Amplify app. </p>"
}
},
"DNSRecord": {
"base": null,
"refs": {
"SubDomain$dnsRecord": "<p> The DNS record for the subdomain. </p>"
}
},
"DefaultDomain": {
"base": null,
"refs": {
"App$defaultDomain": "<p> The default domain for the Amplify app. </p>"
}
},
"DeleteAppRequest": {
"base": "<p> Describes the request structure for the delete app request. </p>",
"refs": {
}
},
"DeleteAppResult": {
"base": "<p> The result structure for the delete app request. </p>",
"refs": {
}
},
"DeleteBackendEnvironmentRequest": {
"base": "<p> The request structure for the delete backend environment request. </p>",
"refs": {
}
},
"DeleteBackendEnvironmentResult": {
"base": "<p> The result structure of the delete backend environment result. </p>",
"refs": {
}
},
"DeleteBranchRequest": {
"base": "<p> The request structure for the delete branch request. </p>",
"refs": {
}
},
"DeleteBranchResult": {
"base": "<p> The result structure for the delete branch request. </p>",
"refs": {
}
},
"DeleteDomainAssociationRequest": {
"base": "<p> The request structure for the delete domain association request. </p>",
"refs": {
}
},
"DeleteDomainAssociationResult": {
"base": null,
"refs": {
}
},
"DeleteJobRequest": {
"base": "<p> The request structure for the delete job request. </p>",
"refs": {
}
},
"DeleteJobResult": {
"base": "<p> The result structure for the delete job request. </p>",
"refs": {
}
},
"DeleteWebhookRequest": {
"base": "<p> The request structure for the delete webhook request. </p>",
"refs": {
}
},
"DeleteWebhookResult": {
"base": "<p> The result structure for the delete webhook request. </p>",
"refs": {
}
},
"DependentServiceFailureException": {
"base": "<p> An operation failed because a dependent service threw an exception. </p>",
"refs": {
}
},
"DeploymentArtifacts": {
"base": null,
"refs": {
"BackendEnvironment$deploymentArtifacts": "<p> The name of deployment artifacts. </p>",
"CreateBackendEnvironmentRequest$deploymentArtifacts": "<p> The name of deployment artifacts. </p>"
}
},
"Description": {
"base": null,
"refs": {
"App$description": "<p> The description for the Amplify app. </p>",
"Branch$description": "<p> The description for the branch that is part of an Amplify app. </p>",
"CreateAppRequest$description": "<p> The description for an Amplify app. </p>",
"CreateBranchRequest$description": "<p> The description for the branch. </p>",
"CreateWebhookRequest$description": "<p> The description for a webhook. </p>",
"UpdateAppRequest$description": "<p> The description for an Amplify app. </p>",
"UpdateBranchRequest$description": "<p> The description for the branch. </p>",
"UpdateWebhookRequest$description": "<p> The description for a webhook. </p>",
"Webhook$description": "<p> The description for a webhook. </p>"
}
},
"DisplayName": {
"base": null,
"refs": {
"Branch$displayName": "<p> The display name for the branch. This is used as the default domain prefix. </p>",
"CreateBranchRequest$displayName": "<p> The display name for a branch. This is used as the default domain prefix. </p>",
"UpdateBranchRequest$displayName": "<p> The display name for a branch. This is used as the default domain prefix. </p>"
}
},
"DomainAssociation": {
"base": "<p> Describes a domain association that associates a custom domain with an Amplify app. </p>",
"refs": {
"CreateDomainAssociationResult$domainAssociation": "<p> Describes the structure of a domain association, which associates a custom domain with an Amplify app. </p>",
"DeleteDomainAssociationResult$domainAssociation": null,
"DomainAssociations$member": null,
"GetDomainAssociationResult$domainAssociation": "<p> Describes the structure of a domain association, which associates a custom domain with an Amplify app. </p>",
"UpdateDomainAssociationResult$domainAssociation": "<p> Describes a domain association, which associates a custom domain with an Amplify app. </p>"
}
},
"DomainAssociationArn": {
"base": null,
"refs": {
"DomainAssociation$domainAssociationArn": "<p> The Amazon Resource Name (ARN) for the domain association. </p>"
}
},
"DomainAssociations": {
"base": null,
"refs": {
"ListDomainAssociationsResult$domainAssociations": "<p> A list of domain associations. </p>"
}
},
"DomainName": {
"base": null,
"refs": {
"CreateDomainAssociationRequest$domainName": "<p> The domain name for the domain association. </p>",
"DeleteDomainAssociationRequest$domainName": "<p> The name of the domain. </p>",
"DomainAssociation$domainName": "<p> The name of the domain. </p>",
"GenerateAccessLogsRequest$domainName": "<p> The name of the domain. </p>",
"GetDomainAssociationRequest$domainName": "<p> The name of the domain. </p>",
"UpdateDomainAssociationRequest$domainName": "<p> The name of the domain. </p>"
}
},
"DomainPrefix": {
"base": null,
"refs": {
"SubDomainSetting$prefix": "<p> The prefix setting for the subdomain. </p>"
}
},
"DomainStatus": {
"base": null,
"refs": {
"DomainAssociation$domainStatus": "<p> The current status of the domain association. </p>"
}
},
"EnableAutoBranchCreation": {
"base": null,
"refs": {
"App$enableAutoBranchCreation": "<p> Enables automated branch creation for the Amplify app. </p>",
"CreateAppRequest$enableAutoBranchCreation": "<p> Enables automated branch creation for an Amplify app. </p>",
"UpdateAppRequest$enableAutoBranchCreation": "<p> Enables automated branch creation for an Amplify app. </p>"
}
},
"EnableAutoBuild": {
"base": null,
"refs": {
"AutoBranchCreationConfig$enableAutoBuild": "<p> Enables auto building for the autocreated branch. </p>",
"Branch$enableAutoBuild": "<p> Enables auto-building on push for a branch of an Amplify app. </p>",
"CreateBranchRequest$enableAutoBuild": "<p> Enables auto building for the branch. </p>",
"UpdateAppRequest$enableBranchAutoBuild": "<p> Enables branch auto-building for an Amplify app. </p>",
"UpdateBranchRequest$enableAutoBuild": "<p> Enables auto building for the branch. </p>"
}
},
"EnableAutoSubDomain": {
"base": null,
"refs": {
"CreateDomainAssociationRequest$enableAutoSubDomain": "<p> Enables the automated creation of subdomains for branches. </p>",
"DomainAssociation$enableAutoSubDomain": "<p> Enables the automated creation of subdomains for branches. </p>",
"UpdateDomainAssociationRequest$enableAutoSubDomain": "<p> Enables the automated creation of subdomains for branches. </p>"
}
},
"EnableBasicAuth": {
"base": null,
"refs": {
"App$enableBasicAuth": "<p> Enables basic authorization for the Amplify app's branches. </p>",
"AutoBranchCreationConfig$enableBasicAuth": "<p> Enables basic authorization for the autocreated branch. </p>",
"Branch$enableBasicAuth": "<p> Enables basic authorization for a branch of an Amplify app. </p>",
"CreateAppRequest$enableBasicAuth": "<p> Enables basic authorization for an Amplify app. This will apply to all branches that are part of this app. </p>",
"CreateBranchRequest$enableBasicAuth": "<p> Enables basic authorization for the branch. </p>",
"UpdateAppRequest$enableBasicAuth": "<p> Enables basic authorization for an Amplify app. </p>",
"UpdateBranchRequest$enableBasicAuth": "<p> Enables basic authorization for the branch. </p>"
}
},
"EnableBranchAutoBuild": {
"base": null,
"refs": {
"App$enableBranchAutoBuild": "<p> Enables the auto-building of branches for the Amplify app. </p>",
"CreateAppRequest$enableBranchAutoBuild": "<p> Enables the auto building of branches for an Amplify app. </p>"
}
},
"EnableBranchAutoDeletion": {
"base": null,
"refs": {
"App$enableBranchAutoDeletion": "<p> Automatically disconnect a branch in the Amplify Console when you delete a branch from your Git repository. </p>",
"CreateAppRequest$enableBranchAutoDeletion": "<p> Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. </p>",
"UpdateAppRequest$enableBranchAutoDeletion": "<p> Automatically disconnects a branch in the Amplify Console when you delete a branch from your Git repository. </p>"
}
},
"EnableNotification": {
"base": null,
"refs": {
"Branch$enableNotification": "<p> Enables notifications for a branch that is part of an Amplify app. </p>",
"CreateBranchRequest$enableNotification": "<p> Enables notifications for the branch. </p>",
"UpdateBranchRequest$enableNotification": "<p> Enables notifications for the branch. </p>"
}
},
"EnablePerformanceMode": {
"base": null,
"refs": {
"AutoBranchCreationConfig$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>",
"Branch$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>",
"CreateBranchRequest$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>",
"UpdateBranchRequest$enablePerformanceMode": "<p>Enables performance mode for the branch.</p> <p>Performance mode optimizes for faster hosting performance by keeping content cached at the edge for a longer interval. When performance mode is enabled, hosting configuration or code changes can take up to 10 minutes to roll out. </p>"
}
},
"EnablePullRequestPreview": {
"base": null,
"refs": {
"AutoBranchCreationConfig$enablePullRequestPreview": "<p> Enables pull request previews for the autocreated branch. </p>",
"Branch$enablePullRequestPreview": "<p> Enables pull request previews for the branch. </p>",
"CreateBranchRequest$enablePullRequestPreview": "<p> Enables pull request previews for this branch. </p>",
"UpdateBranchRequest$enablePullRequestPreview": "<p> Enables pull request previews for this branch. </p>"
}
},
"EndTime": {
"base": null,
"refs": {
"GenerateAccessLogsRequest$endTime": "<p> The time at which the logs should end. The time range specified is inclusive of the end time. </p>",
"JobSummary$endTime": "<p> The end date and time for the job. </p>",
"Step$endTime": "<p> The end date and time of the execution step. </p>"
}
},
"EnvKey": {
"base": null,
"refs": {
"EnvironmentVariables$key": null
}
},
"EnvValue": {
"base": null,
"refs": {
"EnvironmentVariables$value": null
}
},
"EnvironmentName": {
"base": null,
"refs": {
"BackendEnvironment$environmentName": "<p> The name for a backend environment that is part of an Amplify app. </p>",
"CreateBackendEnvironmentRequest$environmentName": "<p> The name for the backend environment. </p>",
"DeleteBackendEnvironmentRequest$environmentName": "<p> The name of a backend environment of an Amplify app. </p>",
"GetBackendEnvironmentRequest$environmentName": "<p> The name for the backend environment. </p>",
"ListBackendEnvironmentsRequest$environmentName": "<p> The name of the backend environment </p>"
}
},
"EnvironmentVariables": {
"base": null,
"refs": {
"App$environmentVariables": "<p> The environment variables for the Amplify app. </p>",
"AutoBranchCreationConfig$environmentVariables": "<p> The environment variables for the autocreated branch. </p>",
"Branch$environmentVariables": "<p> The environment variables specific to a branch of an Amplify app. </p>",
"CreateAppRequest$environmentVariables": "<p> The environment variables map for an Amplify app. </p>",
"CreateBranchRequest$environmentVariables": "<p> The environment variables for the branch. </p>",
"UpdateAppRequest$environmentVariables": "<p> The environment variables for an Amplify app. </p>",
"UpdateBranchRequest$environmentVariables": "<p> The environment variables for the branch. </p>"
}
},
"ErrorMessage": {
"base": null,
"refs": {
"BadRequestException$message": null,
"DependentServiceFailureException$message": null,
"InternalFailureException$message": null,
"LimitExceededException$message": null,
"NotFoundException$message": null,
"ResourceNotFoundException$message": null,
"UnauthorizedException$message": null
}
},
"FileMap": {
"base": null,
"refs": {
"CreateDeploymentRequest$fileMap": "<p> An optional file map that contains the file name as the key and the file content md5 hash as the value. If this argument is provided, the service will generate a unique upload URL per file. Otherwise, the service will only generate a single upload URL for the zipped files. </p>"
}
},
"FileName": {
"base": null,
"refs": {
"FileMap$key": null,
"FileUploadUrls$key": null
}
},
"FileUploadUrls": {
"base": null,
"refs": {
"CreateDeploymentResult$fileUploadUrls": "<p> When the <code>fileMap</code> argument is provided in the request, <code>fileUploadUrls</code> will contain a map of file names to upload URLs. </p>"
}
},
"Framework": {
"base": null,
"refs": {
"AutoBranchCreationConfig$framework": "<p> The framework for the autocreated branch. </p>",
"Branch$framework": "<p> The framework for a branch of an Amplify app. </p>",
"CreateBranchRequest$framework": "<p> The framework for the branch. </p>",
"UpdateBranchRequest$framework": "<p> The framework for the branch. </p>"
}
},
"GenerateAccessLogsRequest": {
"base": "<p> The request structure for the generate access logs request. </p>",
"refs": {
}
},
"GenerateAccessLogsResult": {
"base": "<p> The result structure for the generate access logs request. </p>",
"refs": {
}
},
"GetAppRequest": {
"base": "<p> The request structure for the get app request. </p>",
"refs": {
}
},
"GetAppResult": {
"base": null,
"refs": {
}
},
"GetArtifactUrlRequest": {
"base": "<p> Returns the request structure for the get artifact request. </p>",
"refs": {
}
},
"GetArtifactUrlResult": {
"base": "<p> Returns the result structure for the get artifact request. </p>",
"refs": {
}
},
"GetBackendEnvironmentRequest": {
"base": "<p> The request structure for the get backend environment request. </p>",
"refs": {
}
},
"GetBackendEnvironmentResult": {
"base": "<p> The result structure for the get backend environment result. </p>",
"refs": {
}
},
"GetBranchRequest": {
"base": "<p> The request structure for the get branch request. </p>",
"refs": {
}
},
"GetBranchResult": {
"base": null,
"refs": {
}
},
"GetDomainAssociationRequest": {
"base": "<p> The request structure for the get domain association request. </p>",
"refs": {
}
},
"GetDomainAssociationResult": {
"base": "<p> The result structure for the get domain association request. </p>",
"refs": {
}
},
"GetJobRequest": {
"base": "<p> The request structure for the get job request. </p>",
"refs": {
}
},
"GetJobResult": {
"base": null,
"refs": {
}
},
"GetWebhookRequest": {
"base": "<p> The request structure for the get webhook request. </p>",
"refs": {
}
},
"GetWebhookResult": {
"base": "<p> The result structure for the get webhook request. </p>",
"refs": {
}
},
"InternalFailureException": {
"base": "<p> The service failed to perform an operation due to an internal issue. </p>",
"refs": {
}
},
"Job": {
"base": "<p> Describes an execution job for an Amplify app. </p>",
"refs": {
"GetJobResult$job": null
}
},
"JobArn": {
"base": null,
"refs": {
"JobSummary$jobArn": "<p> The Amazon Resource Name (ARN) for the job. </p>"
}
},
"JobId": {
"base": null,
"refs": {
"CreateDeploymentResult$jobId": "<p> The job ID for this deployment. will supply to start deployment api. </p>",
"DeleteJobRequest$jobId": "<p> The unique ID for the job. </p>",
"GetJobRequest$jobId": "<p> The unique ID for the job. </p>",
"JobSummary$jobId": "<p> The unique ID for the job. </p>",
"ListArtifactsRequest$jobId": "<p> The unique ID for a job. </p>",
"StartDeploymentRequest$jobId": "<p> The job ID for this deployment, generated by the create deployment request. </p>",
"StartJobRequest$jobId": "<p> The unique ID for an existing job. This is required if the value of <code>jobType</code> is <code>RETRY</code>. </p>",
"StopJobRequest$jobId": "<p> The unique id for the job. </p>"
}
},
"JobReason": {
"base": null,
"refs": {
"StartJobRequest$jobReason": "<p> A descriptive reason for starting this job. </p>"
}
},
"JobStatus": {
"base": null,
"refs": {
"JobSummary$status": "<p> The current status for the job. </p>",
"Step$status": "<p> The status of the execution step. </p>"
}
},
"JobSummaries": {
"base": null,
"refs": {
"ListJobsResult$jobSummaries": "<p> The result structure for the list job result request. </p>"
}
},
"JobSummary": {
"base": "<p> Describes the summary for an execution job for an Amplify app. </p>",
"refs": {
"DeleteJobResult$jobSummary": null,
"Job$summary": "<p> Describes the summary for an execution job for an Amplify app. </p>",
"JobSummaries$member": null,
"StartDeploymentResult$jobSummary": "<p> The summary for the job. </p>",
"StartJobResult$jobSummary": "<p> The summary for the job. </p>",
"StopJobResult$jobSummary": "<p> The summary for the job. </p>"
}
},
"JobType": {
"base": null,
"refs": {
"JobSummary$jobType": "<p> The type for the job. If the value is <code>RELEASE</code>, the job was manually released from its source by using the <code>StartJob</code> API. If the value is <code>RETRY</code>, the job was manually retried using the <code>StartJob</code> API. If the value is <code>WEB_HOOK</code>, the job was automatically triggered by webhooks. </p>",
"StartJobRequest$jobType": "<p> Describes the type for the job. The job type <code>RELEASE</code> starts a new job with the latest change from the specified branch. This value is available only for apps that are connected to a repository. The job type <code>RETRY</code> retries an existing job. If the job type value is <code>RETRY</code>, the <code>jobId</code> is also required. </p>"
}
},
"LastDeployTime": {
"base": null,
"refs": {
"ProductionBranch$lastDeployTime": "<p> The last deploy time of the production branch. </p>"
}
},
"LimitExceededException": {
"base": "<p> A resource could not be created because service quotas were exceeded. </p>",
"refs": {
}
},
"ListAppsRequest": {
"base": "<p> The request structure for the list apps request. </p>",
"refs": {
}
},
"ListAppsResult": {
"base": "<p> The result structure for an Amplify app list request. </p>",
"refs": {
}
},
"ListArtifactsRequest": {
"base": "<p> Describes the request structure for the list artifacts request. </p>",
"refs": {
}
},
"ListArtifactsResult": {
"base": "<p> The result structure for the list artifacts request. </p>",
"refs": {
}
},
"ListBackendEnvironmentsRequest": {
"base": "<p> The request structure for the list backend environments request. </p>",
"refs": {
}
},
"ListBackendEnvironmentsResult": {
"base": "<p> The result structure for the list backend environments result. </p>",
"refs": {
}
},
"ListBranchesRequest": {
"base": "<p> The request structure for the list branches request. </p>",
"refs": {
}
},
"ListBranchesResult": {
"base": "<p> The result structure for the list branches request. </p>",
"refs": {
}
},
"ListDomainAssociationsRequest": {
"base": "<p> The request structure for the list domain associations request. </p>",
"refs": {
}
},
"ListDomainAssociationsResult": {
"base": "<p> The result structure for the list domain association request. </p>",
"refs": {
}
},
"ListJobsRequest": {
"base": "<p> The request structure for the list jobs request. </p>",
"refs": {
}
},
"ListJobsResult": {
"base": "<p> The maximum number of records to list in a single response. </p>",
"refs": {
}
},
"ListTagsForResourceRequest": {
"base": "<p> The request structure to use to list tags for a resource. </p>",
"refs": {
}
},
"ListTagsForResourceResponse": {
"base": "<p> The response for the list tags for resource request. </p>",
"refs": {
}
},
"ListWebhooksRequest": {
"base": "<p> The request structure for the list webhooks request. </p>",
"refs": {
}
},
"ListWebhooksResult": {