appsync.d.ts
60.4 KB
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config';
interface Blob {}
declare class AppSync extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: AppSync.Types.ClientConfiguration)
config: Config & AppSync.Types.ClientConfiguration;
/**
* Creates a cache for the GraphQL API.
*/
createApiCache(params: AppSync.Types.CreateApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.CreateApiCacheResponse) => void): Request<AppSync.Types.CreateApiCacheResponse, AWSError>;
/**
* Creates a cache for the GraphQL API.
*/
createApiCache(callback?: (err: AWSError, data: AppSync.Types.CreateApiCacheResponse) => void): Request<AppSync.Types.CreateApiCacheResponse, AWSError>;
/**
* Creates a unique key that you can distribute to clients who are executing your API.
*/
createApiKey(params: AppSync.Types.CreateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request<AppSync.Types.CreateApiKeyResponse, AWSError>;
/**
* Creates a unique key that you can distribute to clients who are executing your API.
*/
createApiKey(callback?: (err: AWSError, data: AppSync.Types.CreateApiKeyResponse) => void): Request<AppSync.Types.CreateApiKeyResponse, AWSError>;
/**
* Creates a DataSource object.
*/
createDataSource(params: AppSync.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request<AppSync.Types.CreateDataSourceResponse, AWSError>;
/**
* Creates a DataSource object.
*/
createDataSource(callback?: (err: AWSError, data: AppSync.Types.CreateDataSourceResponse) => void): Request<AppSync.Types.CreateDataSourceResponse, AWSError>;
/**
* Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
*/
createFunction(params: AppSync.Types.CreateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request<AppSync.Types.CreateFunctionResponse, AWSError>;
/**
* Creates a Function object. A function is a reusable entity. Multiple functions can be used to compose the resolver logic.
*/
createFunction(callback?: (err: AWSError, data: AppSync.Types.CreateFunctionResponse) => void): Request<AppSync.Types.CreateFunctionResponse, AWSError>;
/**
* Creates a GraphqlApi object.
*/
createGraphqlApi(params: AppSync.Types.CreateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request<AppSync.Types.CreateGraphqlApiResponse, AWSError>;
/**
* Creates a GraphqlApi object.
*/
createGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.CreateGraphqlApiResponse) => void): Request<AppSync.Types.CreateGraphqlApiResponse, AWSError>;
/**
* Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.
*/
createResolver(params: AppSync.Types.CreateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request<AppSync.Types.CreateResolverResponse, AWSError>;
/**
* Creates a Resolver object. A resolver converts incoming requests into a format that a data source can understand and converts the data source's responses into GraphQL.
*/
createResolver(callback?: (err: AWSError, data: AppSync.Types.CreateResolverResponse) => void): Request<AppSync.Types.CreateResolverResponse, AWSError>;
/**
* Creates a Type object.
*/
createType(params: AppSync.Types.CreateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request<AppSync.Types.CreateTypeResponse, AWSError>;
/**
* Creates a Type object.
*/
createType(callback?: (err: AWSError, data: AppSync.Types.CreateTypeResponse) => void): Request<AppSync.Types.CreateTypeResponse, AWSError>;
/**
* Deletes an ApiCache object.
*/
deleteApiCache(params: AppSync.Types.DeleteApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteApiCacheResponse) => void): Request<AppSync.Types.DeleteApiCacheResponse, AWSError>;
/**
* Deletes an ApiCache object.
*/
deleteApiCache(callback?: (err: AWSError, data: AppSync.Types.DeleteApiCacheResponse) => void): Request<AppSync.Types.DeleteApiCacheResponse, AWSError>;
/**
* Deletes an API key.
*/
deleteApiKey(params: AppSync.Types.DeleteApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request<AppSync.Types.DeleteApiKeyResponse, AWSError>;
/**
* Deletes an API key.
*/
deleteApiKey(callback?: (err: AWSError, data: AppSync.Types.DeleteApiKeyResponse) => void): Request<AppSync.Types.DeleteApiKeyResponse, AWSError>;
/**
* Deletes a DataSource object.
*/
deleteDataSource(params: AppSync.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request<AppSync.Types.DeleteDataSourceResponse, AWSError>;
/**
* Deletes a DataSource object.
*/
deleteDataSource(callback?: (err: AWSError, data: AppSync.Types.DeleteDataSourceResponse) => void): Request<AppSync.Types.DeleteDataSourceResponse, AWSError>;
/**
* Deletes a Function.
*/
deleteFunction(params: AppSync.Types.DeleteFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request<AppSync.Types.DeleteFunctionResponse, AWSError>;
/**
* Deletes a Function.
*/
deleteFunction(callback?: (err: AWSError, data: AppSync.Types.DeleteFunctionResponse) => void): Request<AppSync.Types.DeleteFunctionResponse, AWSError>;
/**
* Deletes a GraphqlApi object.
*/
deleteGraphqlApi(params: AppSync.Types.DeleteGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request<AppSync.Types.DeleteGraphqlApiResponse, AWSError>;
/**
* Deletes a GraphqlApi object.
*/
deleteGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.DeleteGraphqlApiResponse) => void): Request<AppSync.Types.DeleteGraphqlApiResponse, AWSError>;
/**
* Deletes a Resolver object.
*/
deleteResolver(params: AppSync.Types.DeleteResolverRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request<AppSync.Types.DeleteResolverResponse, AWSError>;
/**
* Deletes a Resolver object.
*/
deleteResolver(callback?: (err: AWSError, data: AppSync.Types.DeleteResolverResponse) => void): Request<AppSync.Types.DeleteResolverResponse, AWSError>;
/**
* Deletes a Type object.
*/
deleteType(params: AppSync.Types.DeleteTypeRequest, callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request<AppSync.Types.DeleteTypeResponse, AWSError>;
/**
* Deletes a Type object.
*/
deleteType(callback?: (err: AWSError, data: AppSync.Types.DeleteTypeResponse) => void): Request<AppSync.Types.DeleteTypeResponse, AWSError>;
/**
* Flushes an ApiCache object.
*/
flushApiCache(params: AppSync.Types.FlushApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.FlushApiCacheResponse) => void): Request<AppSync.Types.FlushApiCacheResponse, AWSError>;
/**
* Flushes an ApiCache object.
*/
flushApiCache(callback?: (err: AWSError, data: AppSync.Types.FlushApiCacheResponse) => void): Request<AppSync.Types.FlushApiCacheResponse, AWSError>;
/**
* Retrieves an ApiCache object.
*/
getApiCache(params: AppSync.Types.GetApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.GetApiCacheResponse) => void): Request<AppSync.Types.GetApiCacheResponse, AWSError>;
/**
* Retrieves an ApiCache object.
*/
getApiCache(callback?: (err: AWSError, data: AppSync.Types.GetApiCacheResponse) => void): Request<AppSync.Types.GetApiCacheResponse, AWSError>;
/**
* Retrieves a DataSource object.
*/
getDataSource(params: AppSync.Types.GetDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request<AppSync.Types.GetDataSourceResponse, AWSError>;
/**
* Retrieves a DataSource object.
*/
getDataSource(callback?: (err: AWSError, data: AppSync.Types.GetDataSourceResponse) => void): Request<AppSync.Types.GetDataSourceResponse, AWSError>;
/**
* Get a Function.
*/
getFunction(params: AppSync.Types.GetFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request<AppSync.Types.GetFunctionResponse, AWSError>;
/**
* Get a Function.
*/
getFunction(callback?: (err: AWSError, data: AppSync.Types.GetFunctionResponse) => void): Request<AppSync.Types.GetFunctionResponse, AWSError>;
/**
* Retrieves a GraphqlApi object.
*/
getGraphqlApi(params: AppSync.Types.GetGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request<AppSync.Types.GetGraphqlApiResponse, AWSError>;
/**
* Retrieves a GraphqlApi object.
*/
getGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.GetGraphqlApiResponse) => void): Request<AppSync.Types.GetGraphqlApiResponse, AWSError>;
/**
* Retrieves the introspection schema for a GraphQL API.
*/
getIntrospectionSchema(params: AppSync.Types.GetIntrospectionSchemaRequest, callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request<AppSync.Types.GetIntrospectionSchemaResponse, AWSError>;
/**
* Retrieves the introspection schema for a GraphQL API.
*/
getIntrospectionSchema(callback?: (err: AWSError, data: AppSync.Types.GetIntrospectionSchemaResponse) => void): Request<AppSync.Types.GetIntrospectionSchemaResponse, AWSError>;
/**
* Retrieves a Resolver object.
*/
getResolver(params: AppSync.Types.GetResolverRequest, callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request<AppSync.Types.GetResolverResponse, AWSError>;
/**
* Retrieves a Resolver object.
*/
getResolver(callback?: (err: AWSError, data: AppSync.Types.GetResolverResponse) => void): Request<AppSync.Types.GetResolverResponse, AWSError>;
/**
* Retrieves the current status of a schema creation operation.
*/
getSchemaCreationStatus(params: AppSync.Types.GetSchemaCreationStatusRequest, callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request<AppSync.Types.GetSchemaCreationStatusResponse, AWSError>;
/**
* Retrieves the current status of a schema creation operation.
*/
getSchemaCreationStatus(callback?: (err: AWSError, data: AppSync.Types.GetSchemaCreationStatusResponse) => void): Request<AppSync.Types.GetSchemaCreationStatusResponse, AWSError>;
/**
* Retrieves a Type object.
*/
getType(params: AppSync.Types.GetTypeRequest, callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request<AppSync.Types.GetTypeResponse, AWSError>;
/**
* Retrieves a Type object.
*/
getType(callback?: (err: AWSError, data: AppSync.Types.GetTypeResponse) => void): Request<AppSync.Types.GetTypeResponse, AWSError>;
/**
* Lists the API keys for a given API. API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.
*/
listApiKeys(params: AppSync.Types.ListApiKeysRequest, callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request<AppSync.Types.ListApiKeysResponse, AWSError>;
/**
* Lists the API keys for a given API. API keys are deleted automatically sometime after they expire. However, they may still be included in the response until they have actually been deleted. You can safely call DeleteApiKey to manually delete a key before it's automatically deleted.
*/
listApiKeys(callback?: (err: AWSError, data: AppSync.Types.ListApiKeysResponse) => void): Request<AppSync.Types.ListApiKeysResponse, AWSError>;
/**
* Lists the data sources for a given API.
*/
listDataSources(params: AppSync.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request<AppSync.Types.ListDataSourcesResponse, AWSError>;
/**
* Lists the data sources for a given API.
*/
listDataSources(callback?: (err: AWSError, data: AppSync.Types.ListDataSourcesResponse) => void): Request<AppSync.Types.ListDataSourcesResponse, AWSError>;
/**
* List multiple functions.
*/
listFunctions(params: AppSync.Types.ListFunctionsRequest, callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request<AppSync.Types.ListFunctionsResponse, AWSError>;
/**
* List multiple functions.
*/
listFunctions(callback?: (err: AWSError, data: AppSync.Types.ListFunctionsResponse) => void): Request<AppSync.Types.ListFunctionsResponse, AWSError>;
/**
* Lists your GraphQL APIs.
*/
listGraphqlApis(params: AppSync.Types.ListGraphqlApisRequest, callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request<AppSync.Types.ListGraphqlApisResponse, AWSError>;
/**
* Lists your GraphQL APIs.
*/
listGraphqlApis(callback?: (err: AWSError, data: AppSync.Types.ListGraphqlApisResponse) => void): Request<AppSync.Types.ListGraphqlApisResponse, AWSError>;
/**
* Lists the resolvers for a given API and type.
*/
listResolvers(params: AppSync.Types.ListResolversRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request<AppSync.Types.ListResolversResponse, AWSError>;
/**
* Lists the resolvers for a given API and type.
*/
listResolvers(callback?: (err: AWSError, data: AppSync.Types.ListResolversResponse) => void): Request<AppSync.Types.ListResolversResponse, AWSError>;
/**
* List the resolvers that are associated with a specific function.
*/
listResolversByFunction(params: AppSync.Types.ListResolversByFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request<AppSync.Types.ListResolversByFunctionResponse, AWSError>;
/**
* List the resolvers that are associated with a specific function.
*/
listResolversByFunction(callback?: (err: AWSError, data: AppSync.Types.ListResolversByFunctionResponse) => void): Request<AppSync.Types.ListResolversByFunctionResponse, AWSError>;
/**
* Lists the tags for a resource.
*/
listTagsForResource(params: AppSync.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request<AppSync.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the tags for a resource.
*/
listTagsForResource(callback?: (err: AWSError, data: AppSync.Types.ListTagsForResourceResponse) => void): Request<AppSync.Types.ListTagsForResourceResponse, AWSError>;
/**
* Lists the types for a given API.
*/
listTypes(params: AppSync.Types.ListTypesRequest, callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request<AppSync.Types.ListTypesResponse, AWSError>;
/**
* Lists the types for a given API.
*/
listTypes(callback?: (err: AWSError, data: AppSync.Types.ListTypesResponse) => void): Request<AppSync.Types.ListTypesResponse, AWSError>;
/**
* Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.
*/
startSchemaCreation(params: AppSync.Types.StartSchemaCreationRequest, callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request<AppSync.Types.StartSchemaCreationResponse, AWSError>;
/**
* Adds a new schema to your GraphQL API. This operation is asynchronous. Use to determine when it has completed.
*/
startSchemaCreation(callback?: (err: AWSError, data: AppSync.Types.StartSchemaCreationResponse) => void): Request<AppSync.Types.StartSchemaCreationResponse, AWSError>;
/**
* Tags a resource with user-supplied tags.
*/
tagResource(params: AppSync.Types.TagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request<AppSync.Types.TagResourceResponse, AWSError>;
/**
* Tags a resource with user-supplied tags.
*/
tagResource(callback?: (err: AWSError, data: AppSync.Types.TagResourceResponse) => void): Request<AppSync.Types.TagResourceResponse, AWSError>;
/**
* Untags a resource.
*/
untagResource(params: AppSync.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request<AppSync.Types.UntagResourceResponse, AWSError>;
/**
* Untags a resource.
*/
untagResource(callback?: (err: AWSError, data: AppSync.Types.UntagResourceResponse) => void): Request<AppSync.Types.UntagResourceResponse, AWSError>;
/**
* Updates the cache for the GraphQL API.
*/
updateApiCache(params: AppSync.Types.UpdateApiCacheRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateApiCacheResponse) => void): Request<AppSync.Types.UpdateApiCacheResponse, AWSError>;
/**
* Updates the cache for the GraphQL API.
*/
updateApiCache(callback?: (err: AWSError, data: AppSync.Types.UpdateApiCacheResponse) => void): Request<AppSync.Types.UpdateApiCacheResponse, AWSError>;
/**
* Updates an API key.
*/
updateApiKey(params: AppSync.Types.UpdateApiKeyRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request<AppSync.Types.UpdateApiKeyResponse, AWSError>;
/**
* Updates an API key.
*/
updateApiKey(callback?: (err: AWSError, data: AppSync.Types.UpdateApiKeyResponse) => void): Request<AppSync.Types.UpdateApiKeyResponse, AWSError>;
/**
* Updates a DataSource object.
*/
updateDataSource(params: AppSync.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request<AppSync.Types.UpdateDataSourceResponse, AWSError>;
/**
* Updates a DataSource object.
*/
updateDataSource(callback?: (err: AWSError, data: AppSync.Types.UpdateDataSourceResponse) => void): Request<AppSync.Types.UpdateDataSourceResponse, AWSError>;
/**
* Updates a Function object.
*/
updateFunction(params: AppSync.Types.UpdateFunctionRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request<AppSync.Types.UpdateFunctionResponse, AWSError>;
/**
* Updates a Function object.
*/
updateFunction(callback?: (err: AWSError, data: AppSync.Types.UpdateFunctionResponse) => void): Request<AppSync.Types.UpdateFunctionResponse, AWSError>;
/**
* Updates a GraphqlApi object.
*/
updateGraphqlApi(params: AppSync.Types.UpdateGraphqlApiRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request<AppSync.Types.UpdateGraphqlApiResponse, AWSError>;
/**
* Updates a GraphqlApi object.
*/
updateGraphqlApi(callback?: (err: AWSError, data: AppSync.Types.UpdateGraphqlApiResponse) => void): Request<AppSync.Types.UpdateGraphqlApiResponse, AWSError>;
/**
* Updates a Resolver object.
*/
updateResolver(params: AppSync.Types.UpdateResolverRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request<AppSync.Types.UpdateResolverResponse, AWSError>;
/**
* Updates a Resolver object.
*/
updateResolver(callback?: (err: AWSError, data: AppSync.Types.UpdateResolverResponse) => void): Request<AppSync.Types.UpdateResolverResponse, AWSError>;
/**
* Updates a Type object.
*/
updateType(params: AppSync.Types.UpdateTypeRequest, callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request<AppSync.Types.UpdateTypeResponse, AWSError>;
/**
* Updates a Type object.
*/
updateType(callback?: (err: AWSError, data: AppSync.Types.UpdateTypeResponse) => void): Request<AppSync.Types.UpdateTypeResponse, AWSError>;
}
declare namespace AppSync {
export interface AdditionalAuthenticationProvider {
/**
* The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
*/
authenticationType?: AuthenticationType;
/**
* The OpenID Connect configuration.
*/
openIDConnectConfig?: OpenIDConnectConfig;
/**
* The Amazon Cognito user pool configuration.
*/
userPoolConfig?: CognitoUserPoolConfig;
}
export type AdditionalAuthenticationProviders = AdditionalAuthenticationProvider[];
export interface ApiCache {
/**
* TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
*/
ttl?: Long;
/**
* Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
*/
apiCachingBehavior?: ApiCachingBehavior;
/**
* Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
*/
transitEncryptionEnabled?: Boolean;
/**
* At rest encryption flag for cache. This setting cannot be updated after creation.
*/
atRestEncryptionEnabled?: Boolean;
/**
* The cache instance type. T2_SMALL: A t2.small instance type. T2_MEDIUM: A t2.medium instance type. R4_LARGE: A r4.large instance type. R4_XLARGE: A r4.xlarge instance type. R4_2XLARGE: A r4.2xlarge instance type. R4_4XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.
*/
type?: ApiCacheType;
/**
* The cache instance status. AVAILABLE: The instance is available for use. CREATING: The instance is currently creating. DELETING: The instance is currently deleting. MODIFYING: The instance is currently modifying. FAILED: The instance has failed creation.
*/
status?: ApiCacheStatus;
}
export type ApiCacheStatus = "AVAILABLE"|"CREATING"|"DELETING"|"MODIFYING"|"FAILED"|string;
export type ApiCacheType = "T2_SMALL"|"T2_MEDIUM"|"R4_LARGE"|"R4_XLARGE"|"R4_2XLARGE"|"R4_4XLARGE"|"R4_8XLARGE"|string;
export type ApiCachingBehavior = "FULL_REQUEST_CACHING"|"PER_RESOLVER_CACHING"|string;
export interface ApiKey {
/**
* The API key ID.
*/
id?: String;
/**
* A description of the purpose of the API key.
*/
description?: String;
/**
* The time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour.
*/
expires?: Long;
}
export type ApiKeys = ApiKey[];
export type AuthenticationType = "API_KEY"|"AWS_IAM"|"AMAZON_COGNITO_USER_POOLS"|"OPENID_CONNECT"|string;
export interface AuthorizationConfig {
/**
* The authorization type required by the HTTP endpoint. AWS_IAM: The authorization type is Sigv4.
*/
authorizationType: AuthorizationType;
/**
* The AWS IAM settings.
*/
awsIamConfig?: AwsIamConfig;
}
export type AuthorizationType = "AWS_IAM"|string;
export interface AwsIamConfig {
/**
* The signing region for AWS IAM authorization.
*/
signingRegion?: String;
/**
* The signing service name for AWS IAM authorization.
*/
signingServiceName?: String;
}
export type _Blob = Buffer|Uint8Array|Blob|string;
export type Boolean = boolean;
export type BooleanValue = boolean;
export interface CachingConfig {
/**
* The TTL in seconds for a resolver that has caching enabled. Valid values are between 1 and 3600 seconds.
*/
ttl?: Long;
/**
* The caching keys for a resolver that has caching enabled. Valid values are entries from the $context.identity and $context.arguments maps.
*/
cachingKeys?: CachingKeys;
}
export type CachingKeys = String[];
export interface CognitoUserPoolConfig {
/**
* The user pool ID.
*/
userPoolId: String;
/**
* The AWS Region in which the user pool was created.
*/
awsRegion: String;
/**
* A regular expression for validating the incoming Amazon Cognito user pool app client ID.
*/
appIdClientRegex?: String;
}
export type ConflictDetectionType = "VERSION"|"NONE"|string;
export type ConflictHandlerType = "OPTIMISTIC_CONCURRENCY"|"LAMBDA"|"AUTOMERGE"|"NONE"|string;
export interface CreateApiCacheRequest {
/**
* The GraphQL API Id.
*/
apiId: String;
/**
* TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
*/
ttl: Long;
/**
* Transit encryption flag when connecting to cache. This setting cannot be updated after creation.
*/
transitEncryptionEnabled?: Boolean;
/**
* At rest encryption flag for cache. This setting cannot be updated after creation.
*/
atRestEncryptionEnabled?: Boolean;
/**
* Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
*/
apiCachingBehavior: ApiCachingBehavior;
/**
* The cache instance type. T2_SMALL: A t2.small instance type. T2_MEDIUM: A t2.medium instance type. R4_LARGE: A r4.large instance type. R4_XLARGE: A r4.xlarge instance type. R4_2XLARGE: A r4.2xlarge instance type. R4_4XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.
*/
type: ApiCacheType;
}
export interface CreateApiCacheResponse {
/**
* The ApiCache object.
*/
apiCache?: ApiCache;
}
export interface CreateApiKeyRequest {
/**
* The ID for your GraphQL API.
*/
apiId: String;
/**
* A description of the purpose of the API key.
*/
description?: String;
/**
* The time from creation time after which the API key expires. The date is represented as seconds since the epoch, rounded down to the nearest hour. The default value for this parameter is 7 days from creation time. For more information, see .
*/
expires?: Long;
}
export interface CreateApiKeyResponse {
/**
* The API key.
*/
apiKey?: ApiKey;
}
export interface CreateDataSourceRequest {
/**
* The API ID for the GraphQL API for the DataSource.
*/
apiId: String;
/**
* A user-supplied name for the DataSource.
*/
name: ResourceName;
/**
* A description of the DataSource.
*/
description?: String;
/**
* The type of the DataSource.
*/
type: DataSourceType;
/**
* The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
*/
serviceRoleArn?: String;
/**
* Amazon DynamoDB settings.
*/
dynamodbConfig?: DynamodbDataSourceConfig;
/**
* AWS Lambda settings.
*/
lambdaConfig?: LambdaDataSourceConfig;
/**
* Amazon Elasticsearch Service settings.
*/
elasticsearchConfig?: ElasticsearchDataSourceConfig;
/**
* HTTP endpoint settings.
*/
httpConfig?: HttpDataSourceConfig;
/**
* Relational database settings.
*/
relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
}
export interface CreateDataSourceResponse {
/**
* The DataSource object.
*/
dataSource?: DataSource;
}
export interface CreateFunctionRequest {
/**
* The GraphQL API ID.
*/
apiId: String;
/**
* The Function name. The function name does not have to be unique.
*/
name: ResourceName;
/**
* The Function description.
*/
description?: String;
/**
* The Function DataSource name.
*/
dataSourceName: ResourceName;
/**
* The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
*/
requestMappingTemplate: MappingTemplate;
/**
* The Function response mapping template.
*/
responseMappingTemplate?: MappingTemplate;
/**
* The version of the request mapping template. Currently the supported value is 2018-05-29.
*/
functionVersion: String;
}
export interface CreateFunctionResponse {
/**
* The Function object.
*/
functionConfiguration?: FunctionConfiguration;
}
export interface CreateGraphqlApiRequest {
/**
* A user-supplied name for the GraphqlApi.
*/
name: String;
/**
* The Amazon CloudWatch Logs configuration.
*/
logConfig?: LogConfig;
/**
* The authentication type: API key, AWS IAM, OIDC, or Amazon Cognito user pools.
*/
authenticationType: AuthenticationType;
/**
* The Amazon Cognito user pool configuration.
*/
userPoolConfig?: UserPoolConfig;
/**
* The OpenID Connect configuration.
*/
openIDConnectConfig?: OpenIDConnectConfig;
/**
* A TagMap object.
*/
tags?: TagMap;
/**
* A list of additional authentication providers for the GraphqlApi API.
*/
additionalAuthenticationProviders?: AdditionalAuthenticationProviders;
}
export interface CreateGraphqlApiResponse {
/**
* The GraphqlApi.
*/
graphqlApi?: GraphqlApi;
}
export interface CreateResolverRequest {
/**
* The ID for the GraphQL API for which the resolver is being created.
*/
apiId: String;
/**
* The name of the Type.
*/
typeName: ResourceName;
/**
* The name of the field to attach the resolver to.
*/
fieldName: ResourceName;
/**
* The name of the data source for which the resolver is being created.
*/
dataSourceName?: ResourceName;
/**
* The mapping template to be used for requests. A resolver uses a request mapping template to convert a GraphQL expression into a format that a data source can understand. Mapping templates are written in Apache Velocity Template Language (VTL).
*/
requestMappingTemplate: MappingTemplate;
/**
* The mapping template to be used for responses from the data source.
*/
responseMappingTemplate?: MappingTemplate;
/**
* The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
*/
kind?: ResolverKind;
/**
* The PipelineConfig.
*/
pipelineConfig?: PipelineConfig;
/**
* The SyncConfig for a resolver attached to a versioned datasource.
*/
syncConfig?: SyncConfig;
/**
* The caching configuration for the resolver.
*/
cachingConfig?: CachingConfig;
}
export interface CreateResolverResponse {
/**
* The Resolver object.
*/
resolver?: Resolver;
}
export interface CreateTypeRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The type definition, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation.
*/
definition: String;
/**
* The type format: SDL or JSON.
*/
format: TypeDefinitionFormat;
}
export interface CreateTypeResponse {
/**
* The Type object.
*/
type?: Type;
}
export interface DataSource {
/**
* The data source ARN.
*/
dataSourceArn?: String;
/**
* The name of the data source.
*/
name?: ResourceName;
/**
* The description of the data source.
*/
description?: String;
/**
* The type of the data source. AMAZON_DYNAMODB: The data source is an Amazon DynamoDB table. AMAZON_ELASTICSEARCH: The data source is an Amazon Elasticsearch Service domain. AWS_LAMBDA: The data source is an AWS Lambda function. NONE: There is no data source. This type is used when you wish to invoke a GraphQL operation without connecting to a data source, such as performing data transformation with resolvers or triggering a subscription to be invoked from a mutation. HTTP: The data source is an HTTP endpoint. RELATIONAL_DATABASE: The data source is a relational database.
*/
type?: DataSourceType;
/**
* The AWS IAM service role ARN for the data source. The system assumes this role when accessing the data source.
*/
serviceRoleArn?: String;
/**
* Amazon DynamoDB settings.
*/
dynamodbConfig?: DynamodbDataSourceConfig;
/**
* AWS Lambda settings.
*/
lambdaConfig?: LambdaDataSourceConfig;
/**
* Amazon Elasticsearch Service settings.
*/
elasticsearchConfig?: ElasticsearchDataSourceConfig;
/**
* HTTP endpoint settings.
*/
httpConfig?: HttpDataSourceConfig;
/**
* Relational database settings.
*/
relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
}
export type DataSourceType = "AWS_LAMBDA"|"AMAZON_DYNAMODB"|"AMAZON_ELASTICSEARCH"|"NONE"|"HTTP"|"RELATIONAL_DATABASE"|string;
export type DataSources = DataSource[];
export type DefaultAction = "ALLOW"|"DENY"|string;
export interface DeleteApiCacheRequest {
/**
* The API ID.
*/
apiId: String;
}
export interface DeleteApiCacheResponse {
}
export interface DeleteApiKeyRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The ID for the API key.
*/
id: String;
}
export interface DeleteApiKeyResponse {
}
export interface DeleteDataSourceRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The name of the data source.
*/
name: ResourceName;
}
export interface DeleteDataSourceResponse {
}
export interface DeleteFunctionRequest {
/**
* The GraphQL API ID.
*/
apiId: String;
/**
* The Function ID.
*/
functionId: ResourceName;
}
export interface DeleteFunctionResponse {
}
export interface DeleteGraphqlApiRequest {
/**
* The API ID.
*/
apiId: String;
}
export interface DeleteGraphqlApiResponse {
}
export interface DeleteResolverRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The name of the resolver type.
*/
typeName: ResourceName;
/**
* The resolver field name.
*/
fieldName: ResourceName;
}
export interface DeleteResolverResponse {
}
export interface DeleteTypeRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The type name.
*/
typeName: ResourceName;
}
export interface DeleteTypeResponse {
}
export interface DeltaSyncConfig {
/**
* The number of minutes an Item is stored in the datasource.
*/
baseTableTTL?: Long;
/**
* The Delta Sync table name.
*/
deltaSyncTableName?: String;
/**
* The number of minutes a Delta Sync log entry is stored in the Delta Sync table.
*/
deltaSyncTableTTL?: Long;
}
export interface DynamodbDataSourceConfig {
/**
* The table name.
*/
tableName: String;
/**
* The AWS Region.
*/
awsRegion: String;
/**
* Set to TRUE to use Amazon Cognito credentials with this data source.
*/
useCallerCredentials?: Boolean;
/**
* The DeltaSyncConfig for a versioned datasource.
*/
deltaSyncConfig?: DeltaSyncConfig;
/**
* Set to TRUE to use Conflict Detection and Resolution with this data source.
*/
versioned?: Boolean;
}
export interface ElasticsearchDataSourceConfig {
/**
* The endpoint.
*/
endpoint: String;
/**
* The AWS Region.
*/
awsRegion: String;
}
export type FieldLogLevel = "NONE"|"ERROR"|"ALL"|string;
export interface FlushApiCacheRequest {
/**
* The API ID.
*/
apiId: String;
}
export interface FlushApiCacheResponse {
}
export interface FunctionConfiguration {
/**
* A unique ID representing the Function object.
*/
functionId?: String;
/**
* The ARN of the Function object.
*/
functionArn?: String;
/**
* The name of the Function object.
*/
name?: ResourceName;
/**
* The Function description.
*/
description?: String;
/**
* The name of the DataSource.
*/
dataSourceName?: ResourceName;
/**
* The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
*/
requestMappingTemplate?: MappingTemplate;
/**
* The Function response mapping template.
*/
responseMappingTemplate?: MappingTemplate;
/**
* The version of the request mapping template. Currently only the 2018-05-29 version of the template is supported.
*/
functionVersion?: String;
}
export type Functions = FunctionConfiguration[];
export type FunctionsIds = String[];
export interface GetApiCacheRequest {
/**
* The API ID.
*/
apiId: String;
}
export interface GetApiCacheResponse {
apiCache?: ApiCache;
}
export interface GetDataSourceRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The name of the data source.
*/
name: ResourceName;
}
export interface GetDataSourceResponse {
/**
* The DataSource object.
*/
dataSource?: DataSource;
}
export interface GetFunctionRequest {
/**
* The GraphQL API ID.
*/
apiId: String;
/**
* The Function ID.
*/
functionId: ResourceName;
}
export interface GetFunctionResponse {
/**
* The Function object.
*/
functionConfiguration?: FunctionConfiguration;
}
export interface GetGraphqlApiRequest {
/**
* The API ID for the GraphQL API.
*/
apiId: String;
}
export interface GetGraphqlApiResponse {
/**
* The GraphqlApi object.
*/
graphqlApi?: GraphqlApi;
}
export interface GetIntrospectionSchemaRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The schema format: SDL or JSON.
*/
format: OutputType;
/**
* A flag that specifies whether the schema introspection should contain directives.
*/
includeDirectives?: BooleanValue;
}
export interface GetIntrospectionSchemaResponse {
/**
* The schema, in GraphQL Schema Definition Language (SDL) format. For more information, see the GraphQL SDL documentation.
*/
schema?: _Blob;
}
export interface GetResolverRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The resolver type name.
*/
typeName: ResourceName;
/**
* The resolver field name.
*/
fieldName: ResourceName;
}
export interface GetResolverResponse {
/**
* The Resolver object.
*/
resolver?: Resolver;
}
export interface GetSchemaCreationStatusRequest {
/**
* The API ID.
*/
apiId: String;
}
export interface GetSchemaCreationStatusResponse {
/**
* The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
*/
status?: SchemaStatus;
/**
* Detailed information about the status of the schema creation operation.
*/
details?: String;
}
export interface GetTypeRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The type name.
*/
typeName: ResourceName;
/**
* The type format: SDL or JSON.
*/
format: TypeDefinitionFormat;
}
export interface GetTypeResponse {
/**
* The Type object.
*/
type?: Type;
}
export interface GraphqlApi {
/**
* The API name.
*/
name?: ResourceName;
/**
* The API ID.
*/
apiId?: String;
/**
* The authentication type.
*/
authenticationType?: AuthenticationType;
/**
* The Amazon CloudWatch Logs configuration.
*/
logConfig?: LogConfig;
/**
* The Amazon Cognito user pool configuration.
*/
userPoolConfig?: UserPoolConfig;
/**
* The OpenID Connect configuration.
*/
openIDConnectConfig?: OpenIDConnectConfig;
/**
* The ARN.
*/
arn?: String;
/**
* The URIs.
*/
uris?: MapOfStringToString;
/**
* The tags.
*/
tags?: TagMap;
/**
* A list of additional authentication providers for the GraphqlApi API.
*/
additionalAuthenticationProviders?: AdditionalAuthenticationProviders;
}
export type GraphqlApis = GraphqlApi[];
export interface HttpDataSourceConfig {
/**
* The HTTP URL endpoint. You can either specify the domain name or IP, and port combination, and the URL scheme must be HTTP or HTTPS. If the port is not specified, AWS AppSync uses the default port 80 for the HTTP endpoint and port 443 for HTTPS endpoints.
*/
endpoint?: String;
/**
* The authorization config in case the HTTP endpoint requires authorization.
*/
authorizationConfig?: AuthorizationConfig;
}
export interface LambdaConflictHandlerConfig {
/**
* The Arn for the Lambda function to use as the Conflict Handler.
*/
lambdaConflictHandlerArn?: String;
}
export interface LambdaDataSourceConfig {
/**
* The ARN for the Lambda function.
*/
lambdaFunctionArn: String;
}
export interface ListApiKeysRequest {
/**
* The API ID.
*/
apiId: String;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results you want the request to return.
*/
maxResults?: MaxResults;
}
export interface ListApiKeysResponse {
/**
* The ApiKey objects.
*/
apiKeys?: ApiKeys;
/**
* An identifier to be passed in the next request to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListDataSourcesRequest {
/**
* The API ID.
*/
apiId: String;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results you want the request to return.
*/
maxResults?: MaxResults;
}
export interface ListDataSourcesResponse {
/**
* The DataSource objects.
*/
dataSources?: DataSources;
/**
* An identifier to be passed in the next request to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListFunctionsRequest {
/**
* The GraphQL API ID.
*/
apiId: String;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results you want the request to return.
*/
maxResults?: MaxResults;
}
export interface ListFunctionsResponse {
/**
* A list of Function objects.
*/
functions?: Functions;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListGraphqlApisRequest {
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results you want the request to return.
*/
maxResults?: MaxResults;
}
export interface ListGraphqlApisResponse {
/**
* The GraphqlApi objects.
*/
graphqlApis?: GraphqlApis;
/**
* An identifier to be passed in the next request to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListResolversByFunctionRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The Function ID.
*/
functionId: String;
/**
* An identifier that was returned from the previous call to this operation, which you can use to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results you want the request to return.
*/
maxResults?: MaxResults;
}
export interface ListResolversByFunctionResponse {
/**
* The list of resolvers.
*/
resolvers?: Resolvers;
/**
* An identifier that can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListResolversRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The type name.
*/
typeName: String;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results you want the request to return.
*/
maxResults?: MaxResults;
}
export interface ListResolversResponse {
/**
* The Resolver objects.
*/
resolvers?: Resolvers;
/**
* An identifier to be passed in the next request to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface ListTagsForResourceRequest {
/**
* The GraphqlApi ARN.
*/
resourceArn: ResourceArn;
}
export interface ListTagsForResourceResponse {
/**
* A TagMap object.
*/
tags?: TagMap;
}
export interface ListTypesRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The type format: SDL or JSON.
*/
format: TypeDefinitionFormat;
/**
* An identifier that was returned from the previous call to this operation, which can be used to return the next set of items in the list.
*/
nextToken?: PaginationToken;
/**
* The maximum number of results you want the request to return.
*/
maxResults?: MaxResults;
}
export interface ListTypesResponse {
/**
* The Type objects.
*/
types?: TypeList;
/**
* An identifier to be passed in the next request to this operation to return the next set of items in the list.
*/
nextToken?: PaginationToken;
}
export interface LogConfig {
/**
* The field logging level. Values can be NONE, ERROR, or ALL. NONE: No field-level logs are captured. ERROR: Logs the following information only for the fields that are in error: The error section in the server response. Field-level errors. The generated request/response functions that got resolved for error fields. ALL: The following information is logged for all fields in the query: Field-level tracing information. The generated request/response functions that got resolved for each field.
*/
fieldLogLevel: FieldLogLevel;
/**
* The service role that AWS AppSync will assume to publish to Amazon CloudWatch logs in your account.
*/
cloudWatchLogsRoleArn: String;
/**
* Set to TRUE to exclude sections that contain information such as headers, context, and evaluated mapping templates, regardless of logging level.
*/
excludeVerboseContent?: Boolean;
}
export type Long = number;
export type MapOfStringToString = {[key: string]: String};
export type MappingTemplate = string;
export type MaxResults = number;
export interface OpenIDConnectConfig {
/**
* The issuer for the OpenID Connect configuration. The issuer returned by discovery must exactly match the value of iss in the ID token.
*/
issuer: String;
/**
* The client identifier of the Relying party at the OpenID identity provider. This identifier is typically obtained when the Relying party is registered with the OpenID identity provider. You can specify a regular expression so the AWS AppSync can validate against multiple client identifiers at a time.
*/
clientId?: String;
/**
* The number of milliseconds a token is valid after being issued to a user.
*/
iatTTL?: Long;
/**
* The number of milliseconds a token is valid after being authenticated.
*/
authTTL?: Long;
}
export type OutputType = "SDL"|"JSON"|string;
export type PaginationToken = string;
export interface PipelineConfig {
/**
* A list of Function objects.
*/
functions?: FunctionsIds;
}
export interface RdsHttpEndpointConfig {
/**
* AWS Region for RDS HTTP endpoint.
*/
awsRegion?: String;
/**
* Amazon RDS cluster identifier.
*/
dbClusterIdentifier?: String;
/**
* Logical database name.
*/
databaseName?: String;
/**
* Logical schema name.
*/
schema?: String;
/**
* AWS secret store ARN for database credentials.
*/
awsSecretStoreArn?: String;
}
export interface RelationalDatabaseDataSourceConfig {
/**
* Source type for the relational database. RDS_HTTP_ENDPOINT: The relational database source type is an Amazon RDS HTTP endpoint.
*/
relationalDatabaseSourceType?: RelationalDatabaseSourceType;
/**
* Amazon RDS HTTP endpoint settings.
*/
rdsHttpEndpointConfig?: RdsHttpEndpointConfig;
}
export type RelationalDatabaseSourceType = "RDS_HTTP_ENDPOINT"|string;
export interface Resolver {
/**
* The resolver type name.
*/
typeName?: ResourceName;
/**
* The resolver field name.
*/
fieldName?: ResourceName;
/**
* The resolver data source name.
*/
dataSourceName?: ResourceName;
/**
* The resolver ARN.
*/
resolverArn?: String;
/**
* The request mapping template.
*/
requestMappingTemplate?: MappingTemplate;
/**
* The response mapping template.
*/
responseMappingTemplate?: MappingTemplate;
/**
* The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
*/
kind?: ResolverKind;
/**
* The PipelineConfig.
*/
pipelineConfig?: PipelineConfig;
/**
* The SyncConfig for a resolver attached to a versioned datasource.
*/
syncConfig?: SyncConfig;
/**
* The caching configuration for the resolver.
*/
cachingConfig?: CachingConfig;
}
export type ResolverKind = "UNIT"|"PIPELINE"|string;
export type Resolvers = Resolver[];
export type ResourceArn = string;
export type ResourceName = string;
export type SchemaStatus = "PROCESSING"|"ACTIVE"|"DELETING"|"FAILED"|"SUCCESS"|"NOT_APPLICABLE"|string;
export interface StartSchemaCreationRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The schema definition, in GraphQL schema language format.
*/
definition: _Blob;
}
export interface StartSchemaCreationResponse {
/**
* The current state of the schema (PROCESSING, FAILED, SUCCESS, or NOT_APPLICABLE). When the schema is in the ACTIVE state, you can add data.
*/
status?: SchemaStatus;
}
export type String = string;
export interface SyncConfig {
/**
* The Conflict Resolution strategy to perform in the event of a conflict. OPTIMISTIC_CONCURRENCY: Resolve conflicts by rejecting mutations when versions do not match the latest version at the server. AUTOMERGE: Resolve conflicts with the Automerge conflict resolution strategy. LAMBDA: Resolve conflicts with a Lambda function supplied in the LambdaConflictHandlerConfig.
*/
conflictHandler?: ConflictHandlerType;
/**
* The Conflict Detection strategy to use. VERSION: Detect conflicts based on object versions for this resolver. NONE: Do not detect conflicts when executing this resolver.
*/
conflictDetection?: ConflictDetectionType;
/**
* The LambdaConflictHandlerConfig when configuring LAMBDA as the Conflict Handler.
*/
lambdaConflictHandlerConfig?: LambdaConflictHandlerConfig;
}
export type TagKey = string;
export type TagKeyList = TagKey[];
export type TagMap = {[key: string]: TagValue};
export interface TagResourceRequest {
/**
* The GraphqlApi ARN.
*/
resourceArn: ResourceArn;
/**
* A TagMap object.
*/
tags: TagMap;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export interface Type {
/**
* The type name.
*/
name?: ResourceName;
/**
* The type description.
*/
description?: String;
/**
* The type ARN.
*/
arn?: String;
/**
* The type definition.
*/
definition?: String;
/**
* The type format: SDL or JSON.
*/
format?: TypeDefinitionFormat;
}
export type TypeDefinitionFormat = "SDL"|"JSON"|string;
export type TypeList = Type[];
export interface UntagResourceRequest {
/**
* The GraphqlApi ARN.
*/
resourceArn: ResourceArn;
/**
* A list of TagKey objects.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateApiCacheRequest {
/**
* The GraphQL API Id.
*/
apiId: String;
/**
* TTL in seconds for cache entries. Valid values are between 1 and 3600 seconds.
*/
ttl: Long;
/**
* Caching behavior. FULL_REQUEST_CACHING: All requests are fully cached. PER_RESOLVER_CACHING: Individual resovlers that you specify are cached.
*/
apiCachingBehavior: ApiCachingBehavior;
/**
* The cache instance type. T2_SMALL: A t2.small instance type. T2_MEDIUM: A t2.medium instance type. R4_LARGE: A r4.large instance type. R4_XLARGE: A r4.xlarge instance type. R4_2XLARGE: A r4.2xlarge instance type. R4_4XLARGE: A r4.4xlarge instance type. R4_8XLARGE: A r4.8xlarge instance type.
*/
type: ApiCacheType;
}
export interface UpdateApiCacheResponse {
/**
* The ApiCache object.
*/
apiCache?: ApiCache;
}
export interface UpdateApiKeyRequest {
/**
* The ID for the GraphQL API.
*/
apiId: String;
/**
* The API key ID.
*/
id: String;
/**
* A description of the purpose of the API key.
*/
description?: String;
/**
* The time from update time after which the API key expires. The date is represented as seconds since the epoch. For more information, see .
*/
expires?: Long;
}
export interface UpdateApiKeyResponse {
/**
* The API key.
*/
apiKey?: ApiKey;
}
export interface UpdateDataSourceRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The new name for the data source.
*/
name: ResourceName;
/**
* The new description for the data source.
*/
description?: String;
/**
* The new data source type.
*/
type: DataSourceType;
/**
* The new service role ARN for the data source.
*/
serviceRoleArn?: String;
/**
* The new Amazon DynamoDB configuration.
*/
dynamodbConfig?: DynamodbDataSourceConfig;
/**
* The new AWS Lambda configuration.
*/
lambdaConfig?: LambdaDataSourceConfig;
/**
* The new Elasticsearch Service configuration.
*/
elasticsearchConfig?: ElasticsearchDataSourceConfig;
/**
* The new HTTP endpoint configuration.
*/
httpConfig?: HttpDataSourceConfig;
/**
* The new relational database configuration.
*/
relationalDatabaseConfig?: RelationalDatabaseDataSourceConfig;
}
export interface UpdateDataSourceResponse {
/**
* The updated DataSource object.
*/
dataSource?: DataSource;
}
export interface UpdateFunctionRequest {
/**
* The GraphQL API ID.
*/
apiId: String;
/**
* The Function name.
*/
name: ResourceName;
/**
* The Function description.
*/
description?: String;
/**
* The function ID.
*/
functionId: ResourceName;
/**
* The Function DataSource name.
*/
dataSourceName: ResourceName;
/**
* The Function request mapping template. Functions support only the 2018-05-29 version of the request mapping template.
*/
requestMappingTemplate: MappingTemplate;
/**
* The Function request mapping template.
*/
responseMappingTemplate?: MappingTemplate;
/**
* The version of the request mapping template. Currently the supported value is 2018-05-29.
*/
functionVersion: String;
}
export interface UpdateFunctionResponse {
/**
* The Function object.
*/
functionConfiguration?: FunctionConfiguration;
}
export interface UpdateGraphqlApiRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The new name for the GraphqlApi object.
*/
name: String;
/**
* The Amazon CloudWatch Logs configuration for the GraphqlApi object.
*/
logConfig?: LogConfig;
/**
* The new authentication type for the GraphqlApi object.
*/
authenticationType?: AuthenticationType;
/**
* The new Amazon Cognito user pool configuration for the GraphqlApi object.
*/
userPoolConfig?: UserPoolConfig;
/**
* The OpenID Connect configuration for the GraphqlApi object.
*/
openIDConnectConfig?: OpenIDConnectConfig;
/**
* A list of additional authentication providers for the GraphqlApi API.
*/
additionalAuthenticationProviders?: AdditionalAuthenticationProviders;
}
export interface UpdateGraphqlApiResponse {
/**
* The updated GraphqlApi object.
*/
graphqlApi?: GraphqlApi;
}
export interface UpdateResolverRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The new type name.
*/
typeName: ResourceName;
/**
* The new field name.
*/
fieldName: ResourceName;
/**
* The new data source name.
*/
dataSourceName?: ResourceName;
/**
* The new request mapping template.
*/
requestMappingTemplate: MappingTemplate;
/**
* The new response mapping template.
*/
responseMappingTemplate?: MappingTemplate;
/**
* The resolver type. UNIT: A UNIT resolver type. A UNIT resolver is the default resolver type. A UNIT resolver enables you to execute a GraphQL query against a single data source. PIPELINE: A PIPELINE resolver type. A PIPELINE resolver enables you to execute a series of Function in a serial manner. You can use a pipeline resolver to execute a GraphQL query against multiple data sources.
*/
kind?: ResolverKind;
/**
* The PipelineConfig.
*/
pipelineConfig?: PipelineConfig;
/**
* The SyncConfig for a resolver attached to a versioned datasource.
*/
syncConfig?: SyncConfig;
/**
* The caching configuration for the resolver.
*/
cachingConfig?: CachingConfig;
}
export interface UpdateResolverResponse {
/**
* The updated Resolver object.
*/
resolver?: Resolver;
}
export interface UpdateTypeRequest {
/**
* The API ID.
*/
apiId: String;
/**
* The new type name.
*/
typeName: ResourceName;
/**
* The new definition.
*/
definition?: String;
/**
* The new type format: SDL or JSON.
*/
format: TypeDefinitionFormat;
}
export interface UpdateTypeResponse {
/**
* The updated Type object.
*/
type?: Type;
}
export interface UserPoolConfig {
/**
* The user pool ID.
*/
userPoolId: String;
/**
* The AWS Region in which the user pool was created.
*/
awsRegion: String;
/**
* The action that you want your GraphQL API to take when a request that uses Amazon Cognito user pool authentication doesn't match the Amazon Cognito user pool configuration.
*/
defaultAction: DefaultAction;
/**
* A regular expression for validating the incoming Amazon Cognito user pool app client ID.
*/
appIdClientRegex?: String;
}
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2017-07-25"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the AppSync client.
*/
export import Types = AppSync;
}
export = AppSync;