pinpoint.d.ts
349 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
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
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-base';
interface Blob {}
declare class Pinpoint extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Pinpoint.Types.ClientConfiguration)
config: Config & Pinpoint.Types.ClientConfiguration;
/**
* Creates an application.
*/
createApp(params: Pinpoint.Types.CreateAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request<Pinpoint.Types.CreateAppResponse, AWSError>;
/**
* Creates an application.
*/
createApp(callback?: (err: AWSError, data: Pinpoint.Types.CreateAppResponse) => void): Request<Pinpoint.Types.CreateAppResponse, AWSError>;
/**
* Creates a new campaign for an application or updates the settings of an existing campaign for an application.
*/
createCampaign(params: Pinpoint.Types.CreateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request<Pinpoint.Types.CreateCampaignResponse, AWSError>;
/**
* Creates a new campaign for an application or updates the settings of an existing campaign for an application.
*/
createCampaign(callback?: (err: AWSError, data: Pinpoint.Types.CreateCampaignResponse) => void): Request<Pinpoint.Types.CreateCampaignResponse, AWSError>;
/**
* Creates a message template for messages that are sent through the email channel.
*/
createEmailTemplate(params: Pinpoint.Types.CreateEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateEmailTemplateResponse) => void): Request<Pinpoint.Types.CreateEmailTemplateResponse, AWSError>;
/**
* Creates a message template for messages that are sent through the email channel.
*/
createEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateEmailTemplateResponse) => void): Request<Pinpoint.Types.CreateEmailTemplateResponse, AWSError>;
/**
* Creates an export job for an application.
*/
createExportJob(params: Pinpoint.Types.CreateExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request<Pinpoint.Types.CreateExportJobResponse, AWSError>;
/**
* Creates an export job for an application.
*/
createExportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateExportJobResponse) => void): Request<Pinpoint.Types.CreateExportJobResponse, AWSError>;
/**
* Creates an import job for an application.
*/
createImportJob(params: Pinpoint.Types.CreateImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request<Pinpoint.Types.CreateImportJobResponse, AWSError>;
/**
* Creates an import job for an application.
*/
createImportJob(callback?: (err: AWSError, data: Pinpoint.Types.CreateImportJobResponse) => void): Request<Pinpoint.Types.CreateImportJobResponse, AWSError>;
/**
* Creates a journey for an application.
*/
createJourney(params: Pinpoint.Types.CreateJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateJourneyResponse) => void): Request<Pinpoint.Types.CreateJourneyResponse, AWSError>;
/**
* Creates a journey for an application.
*/
createJourney(callback?: (err: AWSError, data: Pinpoint.Types.CreateJourneyResponse) => void): Request<Pinpoint.Types.CreateJourneyResponse, AWSError>;
/**
* Creates a message template for messages that are sent through a push notification channel.
*/
createPushTemplate(params: Pinpoint.Types.CreatePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreatePushTemplateResponse) => void): Request<Pinpoint.Types.CreatePushTemplateResponse, AWSError>;
/**
* Creates a message template for messages that are sent through a push notification channel.
*/
createPushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreatePushTemplateResponse) => void): Request<Pinpoint.Types.CreatePushTemplateResponse, AWSError>;
/**
* Creates an Amazon Pinpoint configuration for a recommender model.
*/
createRecommenderConfiguration(params: Pinpoint.Types.CreateRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.CreateRecommenderConfigurationResponse, AWSError>;
/**
* Creates an Amazon Pinpoint configuration for a recommender model.
*/
createRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.CreateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.CreateRecommenderConfigurationResponse, AWSError>;
/**
* Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
*/
createSegment(params: Pinpoint.Types.CreateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
/**
* Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
*/
createSegment(callback?: (err: AWSError, data: Pinpoint.Types.CreateSegmentResponse) => void): Request<Pinpoint.Types.CreateSegmentResponse, AWSError>;
/**
* Creates a message template for messages that are sent through the SMS channel.
*/
createSmsTemplate(params: Pinpoint.Types.CreateSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateSmsTemplateResponse) => void): Request<Pinpoint.Types.CreateSmsTemplateResponse, AWSError>;
/**
* Creates a message template for messages that are sent through the SMS channel.
*/
createSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateSmsTemplateResponse) => void): Request<Pinpoint.Types.CreateSmsTemplateResponse, AWSError>;
/**
* Creates a message template for messages that are sent through the voice channel.
*/
createVoiceTemplate(params: Pinpoint.Types.CreateVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.CreateVoiceTemplateResponse) => void): Request<Pinpoint.Types.CreateVoiceTemplateResponse, AWSError>;
/**
* Creates a message template for messages that are sent through the voice channel.
*/
createVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.CreateVoiceTemplateResponse) => void): Request<Pinpoint.Types.CreateVoiceTemplateResponse, AWSError>;
/**
* Disables the ADM channel for an application and deletes any existing settings for the channel.
*/
deleteAdmChannel(params: Pinpoint.Types.DeleteAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
/**
* Disables the ADM channel for an application and deletes any existing settings for the channel.
*/
deleteAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAdmChannelResponse) => void): Request<Pinpoint.Types.DeleteAdmChannelResponse, AWSError>;
/**
* Disables the APNs channel for an application and deletes any existing settings for the channel.
*/
deleteApnsChannel(params: Pinpoint.Types.DeleteApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
/**
* Disables the APNs channel for an application and deletes any existing settings for the channel.
*/
deleteApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsChannelResponse, AWSError>;
/**
* Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
*/
deleteApnsSandboxChannel(params: Pinpoint.Types.DeleteApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
/**
* Disables the APNs sandbox channel for an application and deletes any existing settings for the channel.
*/
deleteApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsSandboxChannelResponse, AWSError>;
/**
* Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
*/
deleteApnsVoipChannel(params: Pinpoint.Types.DeleteApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
/**
* Disables the APNs VoIP channel for an application and deletes any existing settings for the channel.
*/
deleteApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipChannelResponse, AWSError>;
/**
* Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
*/
deleteApnsVoipSandboxChannel(params: Pinpoint.Types.DeleteApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
/**
* Disables the APNs VoIP sandbox channel for an application and deletes any existing settings for the channel.
*/
deleteApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.DeleteApnsVoipSandboxChannelResponse, AWSError>;
/**
* Deletes an application.
*/
deleteApp(params: Pinpoint.Types.DeleteAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
/**
* Deletes an application.
*/
deleteApp(callback?: (err: AWSError, data: Pinpoint.Types.DeleteAppResponse) => void): Request<Pinpoint.Types.DeleteAppResponse, AWSError>;
/**
* Disables the Baidu channel for an application and deletes any existing settings for the channel.
*/
deleteBaiduChannel(params: Pinpoint.Types.DeleteBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
/**
* Disables the Baidu channel for an application and deletes any existing settings for the channel.
*/
deleteBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteBaiduChannelResponse) => void): Request<Pinpoint.Types.DeleteBaiduChannelResponse, AWSError>;
/**
* Deletes a campaign from an application.
*/
deleteCampaign(params: Pinpoint.Types.DeleteCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
/**
* Deletes a campaign from an application.
*/
deleteCampaign(callback?: (err: AWSError, data: Pinpoint.Types.DeleteCampaignResponse) => void): Request<Pinpoint.Types.DeleteCampaignResponse, AWSError>;
/**
* Disables the email channel for an application and deletes any existing settings for the channel.
*/
deleteEmailChannel(params: Pinpoint.Types.DeleteEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
/**
* Disables the email channel for an application and deletes any existing settings for the channel.
*/
deleteEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailChannelResponse) => void): Request<Pinpoint.Types.DeleteEmailChannelResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through the email channel.
*/
deleteEmailTemplate(params: Pinpoint.Types.DeleteEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailTemplateResponse) => void): Request<Pinpoint.Types.DeleteEmailTemplateResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through the email channel.
*/
deleteEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEmailTemplateResponse) => void): Request<Pinpoint.Types.DeleteEmailTemplateResponse, AWSError>;
/**
* Deletes an endpoint from an application.
*/
deleteEndpoint(params: Pinpoint.Types.DeleteEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
/**
* Deletes an endpoint from an application.
*/
deleteEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEndpointResponse) => void): Request<Pinpoint.Types.DeleteEndpointResponse, AWSError>;
/**
* Deletes the event stream for an application.
*/
deleteEventStream(params: Pinpoint.Types.DeleteEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
/**
* Deletes the event stream for an application.
*/
deleteEventStream(callback?: (err: AWSError, data: Pinpoint.Types.DeleteEventStreamResponse) => void): Request<Pinpoint.Types.DeleteEventStreamResponse, AWSError>;
/**
* Disables the GCM channel for an application and deletes any existing settings for the channel.
*/
deleteGcmChannel(params: Pinpoint.Types.DeleteGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
/**
* Disables the GCM channel for an application and deletes any existing settings for the channel.
*/
deleteGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteGcmChannelResponse) => void): Request<Pinpoint.Types.DeleteGcmChannelResponse, AWSError>;
/**
* Deletes a journey from an application.
*/
deleteJourney(params: Pinpoint.Types.DeleteJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteJourneyResponse) => void): Request<Pinpoint.Types.DeleteJourneyResponse, AWSError>;
/**
* Deletes a journey from an application.
*/
deleteJourney(callback?: (err: AWSError, data: Pinpoint.Types.DeleteJourneyResponse) => void): Request<Pinpoint.Types.DeleteJourneyResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through a push notification channel.
*/
deletePushTemplate(params: Pinpoint.Types.DeletePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeletePushTemplateResponse) => void): Request<Pinpoint.Types.DeletePushTemplateResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through a push notification channel.
*/
deletePushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeletePushTemplateResponse) => void): Request<Pinpoint.Types.DeletePushTemplateResponse, AWSError>;
/**
* Deletes an Amazon Pinpoint configuration for a recommender model.
*/
deleteRecommenderConfiguration(params: Pinpoint.Types.DeleteRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.DeleteRecommenderConfigurationResponse, AWSError>;
/**
* Deletes an Amazon Pinpoint configuration for a recommender model.
*/
deleteRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.DeleteRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.DeleteRecommenderConfigurationResponse, AWSError>;
/**
* Deletes a segment from an application.
*/
deleteSegment(params: Pinpoint.Types.DeleteSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
/**
* Deletes a segment from an application.
*/
deleteSegment(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSegmentResponse) => void): Request<Pinpoint.Types.DeleteSegmentResponse, AWSError>;
/**
* Disables the SMS channel for an application and deletes any existing settings for the channel.
*/
deleteSmsChannel(params: Pinpoint.Types.DeleteSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
/**
* Disables the SMS channel for an application and deletes any existing settings for the channel.
*/
deleteSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsChannelResponse) => void): Request<Pinpoint.Types.DeleteSmsChannelResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through the SMS channel.
*/
deleteSmsTemplate(params: Pinpoint.Types.DeleteSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsTemplateResponse) => void): Request<Pinpoint.Types.DeleteSmsTemplateResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through the SMS channel.
*/
deleteSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteSmsTemplateResponse) => void): Request<Pinpoint.Types.DeleteSmsTemplateResponse, AWSError>;
/**
* Deletes all the endpoints that are associated with a specific user ID.
*/
deleteUserEndpoints(params: Pinpoint.Types.DeleteUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
/**
* Deletes all the endpoints that are associated with a specific user ID.
*/
deleteUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.DeleteUserEndpointsResponse) => void): Request<Pinpoint.Types.DeleteUserEndpointsResponse, AWSError>;
/**
* Disables the voice channel for an application and deletes any existing settings for the channel.
*/
deleteVoiceChannel(params: Pinpoint.Types.DeleteVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
/**
* Disables the voice channel for an application and deletes any existing settings for the channel.
*/
deleteVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceChannelResponse) => void): Request<Pinpoint.Types.DeleteVoiceChannelResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through the voice channel.
*/
deleteVoiceTemplate(params: Pinpoint.Types.DeleteVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceTemplateResponse) => void): Request<Pinpoint.Types.DeleteVoiceTemplateResponse, AWSError>;
/**
* Deletes a message template for messages that were sent through the voice channel.
*/
deleteVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.DeleteVoiceTemplateResponse) => void): Request<Pinpoint.Types.DeleteVoiceTemplateResponse, AWSError>;
/**
* Retrieves information about the status and settings of the ADM channel for an application.
*/
getAdmChannel(params: Pinpoint.Types.GetAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the ADM channel for an application.
*/
getAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetAdmChannelResponse) => void): Request<Pinpoint.Types.GetAdmChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs channel for an application.
*/
getApnsChannel(params: Pinpoint.Types.GetApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs channel for an application.
*/
getApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsChannelResponse) => void): Request<Pinpoint.Types.GetApnsChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs sandbox channel for an application.
*/
getApnsSandboxChannel(params: Pinpoint.Types.GetApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs sandbox channel for an application.
*/
getApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsSandboxChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs VoIP channel for an application.
*/
getApnsVoipChannel(params: Pinpoint.Types.GetApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs VoIP channel for an application.
*/
getApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
*/
getApnsVoipSandboxChannel(params: Pinpoint.Types.GetApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the APNs VoIP sandbox channel for an application.
*/
getApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.GetApnsVoipSandboxChannelResponse, AWSError>;
/**
* Retrieves information about an application.
*/
getApp(params: Pinpoint.Types.GetAppRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
/**
* Retrieves information about an application.
*/
getApp(callback?: (err: AWSError, data: Pinpoint.Types.GetAppResponse) => void): Request<Pinpoint.Types.GetAppResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
*/
getApplicationDateRangeKpi(params: Pinpoint.Types.GetApplicationDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetApplicationDateRangeKpiResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard metric that applies to an application.
*/
getApplicationDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetApplicationDateRangeKpiResponse, AWSError>;
/**
* Retrieves information about the settings for an application.
*/
getApplicationSettings(params: Pinpoint.Types.GetApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
/**
* Retrieves information about the settings for an application.
*/
getApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.GetApplicationSettingsResponse) => void): Request<Pinpoint.Types.GetApplicationSettingsResponse, AWSError>;
/**
* Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
*/
getApps(params: Pinpoint.Types.GetAppsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
/**
* Retrieves information about all the applications that are associated with your Amazon Pinpoint account.
*/
getApps(callback?: (err: AWSError, data: Pinpoint.Types.GetAppsResponse) => void): Request<Pinpoint.Types.GetAppsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the Baidu channel for an application.
*/
getBaiduChannel(params: Pinpoint.Types.GetBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the Baidu channel for an application.
*/
getBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetBaiduChannelResponse) => void): Request<Pinpoint.Types.GetBaiduChannelResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for a campaign.
*/
getCampaign(params: Pinpoint.Types.GetCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for a campaign.
*/
getCampaign(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignResponse) => void): Request<Pinpoint.Types.GetCampaignResponse, AWSError>;
/**
* Retrieves information about all the activities for a campaign.
*/
getCampaignActivities(params: Pinpoint.Types.GetCampaignActivitiesRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
/**
* Retrieves information about all the activities for a campaign.
*/
getCampaignActivities(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignActivitiesResponse) => void): Request<Pinpoint.Types.GetCampaignActivitiesResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
*/
getCampaignDateRangeKpi(params: Pinpoint.Types.GetCampaignDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetCampaignDateRangeKpiResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard metric that applies to a campaign.
*/
getCampaignDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetCampaignDateRangeKpiResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
*/
getCampaignVersion(params: Pinpoint.Types.GetCampaignVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for a specific version of a campaign.
*/
getCampaignVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionResponse) => void): Request<Pinpoint.Types.GetCampaignVersionResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for all versions of a campaign.
*/
getCampaignVersions(params: Pinpoint.Types.GetCampaignVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for all versions of a campaign.
*/
getCampaignVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignVersionsResponse) => void): Request<Pinpoint.Types.GetCampaignVersionsResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
*/
getCampaigns(params: Pinpoint.Types.GetCampaignsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for all the campaigns that are associated with an application.
*/
getCampaigns(callback?: (err: AWSError, data: Pinpoint.Types.GetCampaignsResponse) => void): Request<Pinpoint.Types.GetCampaignsResponse, AWSError>;
/**
* Retrieves information about the history and status of each channel for an application.
*/
getChannels(params: Pinpoint.Types.GetChannelsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
/**
* Retrieves information about the history and status of each channel for an application.
*/
getChannels(callback?: (err: AWSError, data: Pinpoint.Types.GetChannelsResponse) => void): Request<Pinpoint.Types.GetChannelsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the email channel for an application.
*/
getEmailChannel(params: Pinpoint.Types.GetEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the email channel for an application.
*/
getEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailChannelResponse) => void): Request<Pinpoint.Types.GetEmailChannelResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through the email channel.
*/
getEmailTemplate(params: Pinpoint.Types.GetEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEmailTemplateResponse) => void): Request<Pinpoint.Types.GetEmailTemplateResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through the email channel.
*/
getEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetEmailTemplateResponse) => void): Request<Pinpoint.Types.GetEmailTemplateResponse, AWSError>;
/**
* Retrieves information about the settings and attributes of a specific endpoint for an application.
*/
getEndpoint(params: Pinpoint.Types.GetEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
/**
* Retrieves information about the settings and attributes of a specific endpoint for an application.
*/
getEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.GetEndpointResponse) => void): Request<Pinpoint.Types.GetEndpointResponse, AWSError>;
/**
* Retrieves information about the event stream settings for an application.
*/
getEventStream(params: Pinpoint.Types.GetEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
/**
* Retrieves information about the event stream settings for an application.
*/
getEventStream(callback?: (err: AWSError, data: Pinpoint.Types.GetEventStreamResponse) => void): Request<Pinpoint.Types.GetEventStreamResponse, AWSError>;
/**
* Retrieves information about the status and settings of a specific export job for an application.
*/
getExportJob(params: Pinpoint.Types.GetExportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
/**
* Retrieves information about the status and settings of a specific export job for an application.
*/
getExportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobResponse) => void): Request<Pinpoint.Types.GetExportJobResponse, AWSError>;
/**
* Retrieves information about the status and settings of all the export jobs for an application.
*/
getExportJobs(params: Pinpoint.Types.GetExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
/**
* Retrieves information about the status and settings of all the export jobs for an application.
*/
getExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetExportJobsResponse) => void): Request<Pinpoint.Types.GetExportJobsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the GCM channel for an application.
*/
getGcmChannel(params: Pinpoint.Types.GetGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the GCM channel for an application.
*/
getGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetGcmChannelResponse) => void): Request<Pinpoint.Types.GetGcmChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of a specific import job for an application.
*/
getImportJob(params: Pinpoint.Types.GetImportJobRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
/**
* Retrieves information about the status and settings of a specific import job for an application.
*/
getImportJob(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobResponse) => void): Request<Pinpoint.Types.GetImportJobResponse, AWSError>;
/**
* Retrieves information about the status and settings of all the import jobs for an application.
*/
getImportJobs(params: Pinpoint.Types.GetImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
/**
* Retrieves information about the status and settings of all the import jobs for an application.
*/
getImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetImportJobsResponse) => void): Request<Pinpoint.Types.GetImportJobsResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for a journey.
*/
getJourney(params: Pinpoint.Types.GetJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyResponse) => void): Request<Pinpoint.Types.GetJourneyResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for a journey.
*/
getJourney(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyResponse) => void): Request<Pinpoint.Types.GetJourneyResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
*/
getJourneyDateRangeKpi(params: Pinpoint.Types.GetJourneyDateRangeKpiRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetJourneyDateRangeKpiResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard engagement metric that applies to a journey.
*/
getJourneyDateRangeKpi(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyDateRangeKpiResponse) => void): Request<Pinpoint.Types.GetJourneyDateRangeKpiResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
*/
getJourneyExecutionActivityMetrics(params: Pinpoint.Types.GetJourneyExecutionActivityMetricsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey activity.
*/
getJourneyExecutionActivityMetrics(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionActivityMetricsResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
*/
getJourneyExecutionMetrics(params: Pinpoint.Types.GetJourneyExecutionMetricsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionMetricsResponse, AWSError>;
/**
* Retrieves (queries) pre-aggregated data for a standard execution metric that applies to a journey.
*/
getJourneyExecutionMetrics(callback?: (err: AWSError, data: Pinpoint.Types.GetJourneyExecutionMetricsResponse) => void): Request<Pinpoint.Types.GetJourneyExecutionMetricsResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
*/
getPushTemplate(params: Pinpoint.Types.GetPushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetPushTemplateResponse) => void): Request<Pinpoint.Types.GetPushTemplateResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through a push notification channel.
*/
getPushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetPushTemplateResponse) => void): Request<Pinpoint.Types.GetPushTemplateResponse, AWSError>;
/**
* Retrieves information about an Amazon Pinpoint configuration for a recommender model.
*/
getRecommenderConfiguration(params: Pinpoint.Types.GetRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationResponse, AWSError>;
/**
* Retrieves information about an Amazon Pinpoint configuration for a recommender model.
*/
getRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationResponse, AWSError>;
/**
* Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
*/
getRecommenderConfigurations(params: Pinpoint.Types.GetRecommenderConfigurationsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationsResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationsResponse, AWSError>;
/**
* Retrieves information about all the recommender model configurations that are associated with your Amazon Pinpoint account.
*/
getRecommenderConfigurations(callback?: (err: AWSError, data: Pinpoint.Types.GetRecommenderConfigurationsResponse) => void): Request<Pinpoint.Types.GetRecommenderConfigurationsResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
*/
getSegment(params: Pinpoint.Types.GetSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for a specific segment that's associated with an application.
*/
getSegment(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentResponse) => void): Request<Pinpoint.Types.GetSegmentResponse, AWSError>;
/**
* Retrieves information about the status and settings of the export jobs for a segment.
*/
getSegmentExportJobs(params: Pinpoint.Types.GetSegmentExportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the export jobs for a segment.
*/
getSegmentExportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentExportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentExportJobsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the import jobs for a segment.
*/
getSegmentImportJobs(params: Pinpoint.Types.GetSegmentImportJobsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the import jobs for a segment.
*/
getSegmentImportJobs(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentImportJobsResponse) => void): Request<Pinpoint.Types.GetSegmentImportJobsResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
*/
getSegmentVersion(params: Pinpoint.Types.GetSegmentVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for a specific version of a segment that's associated with an application.
*/
getSegmentVersion(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionResponse) => void): Request<Pinpoint.Types.GetSegmentVersionResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
*/
getSegmentVersions(params: Pinpoint.Types.GetSegmentVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for all the versions of a specific segment that's associated with an application.
*/
getSegmentVersions(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentVersionsResponse) => void): Request<Pinpoint.Types.GetSegmentVersionsResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
*/
getSegments(params: Pinpoint.Types.GetSegmentsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
/**
* Retrieves information about the configuration, dimension, and other settings for all the segments that are associated with an application.
*/
getSegments(callback?: (err: AWSError, data: Pinpoint.Types.GetSegmentsResponse) => void): Request<Pinpoint.Types.GetSegmentsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the SMS channel for an application.
*/
getSmsChannel(params: Pinpoint.Types.GetSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the SMS channel for an application.
*/
getSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsChannelResponse) => void): Request<Pinpoint.Types.GetSmsChannelResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
*/
getSmsTemplate(params: Pinpoint.Types.GetSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetSmsTemplateResponse) => void): Request<Pinpoint.Types.GetSmsTemplateResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through the SMS channel.
*/
getSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetSmsTemplateResponse) => void): Request<Pinpoint.Types.GetSmsTemplateResponse, AWSError>;
/**
* Retrieves information about all the endpoints that are associated with a specific user ID.
*/
getUserEndpoints(params: Pinpoint.Types.GetUserEndpointsRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
/**
* Retrieves information about all the endpoints that are associated with a specific user ID.
*/
getUserEndpoints(callback?: (err: AWSError, data: Pinpoint.Types.GetUserEndpointsResponse) => void): Request<Pinpoint.Types.GetUserEndpointsResponse, AWSError>;
/**
* Retrieves information about the status and settings of the voice channel for an application.
*/
getVoiceChannel(params: Pinpoint.Types.GetVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
/**
* Retrieves information about the status and settings of the voice channel for an application.
*/
getVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceChannelResponse) => void): Request<Pinpoint.Types.GetVoiceChannelResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through the voice channel.
*/
getVoiceTemplate(params: Pinpoint.Types.GetVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceTemplateResponse) => void): Request<Pinpoint.Types.GetVoiceTemplateResponse, AWSError>;
/**
* Retrieves the content and settings of a message template for messages that are sent through the voice channel.
*/
getVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.GetVoiceTemplateResponse) => void): Request<Pinpoint.Types.GetVoiceTemplateResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
*/
listJourneys(params: Pinpoint.Types.ListJourneysRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListJourneysResponse) => void): Request<Pinpoint.Types.ListJourneysResponse, AWSError>;
/**
* Retrieves information about the status, configuration, and other settings for all the journeys that are associated with an application.
*/
listJourneys(callback?: (err: AWSError, data: Pinpoint.Types.ListJourneysResponse) => void): Request<Pinpoint.Types.ListJourneysResponse, AWSError>;
/**
* Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
*/
listTagsForResource(params: Pinpoint.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves all the tags (keys and values) that are associated with an application, campaign, message template, or segment.
*/
listTagsForResource(callback?: (err: AWSError, data: Pinpoint.Types.ListTagsForResourceResponse) => void): Request<Pinpoint.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves information about all the versions of a specific message template.
*/
listTemplateVersions(params: Pinpoint.Types.ListTemplateVersionsRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTemplateVersionsResponse) => void): Request<Pinpoint.Types.ListTemplateVersionsResponse, AWSError>;
/**
* Retrieves information about all the versions of a specific message template.
*/
listTemplateVersions(callback?: (err: AWSError, data: Pinpoint.Types.ListTemplateVersionsResponse) => void): Request<Pinpoint.Types.ListTemplateVersionsResponse, AWSError>;
/**
* Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
*/
listTemplates(params: Pinpoint.Types.ListTemplatesRequest, callback?: (err: AWSError, data: Pinpoint.Types.ListTemplatesResponse) => void): Request<Pinpoint.Types.ListTemplatesResponse, AWSError>;
/**
* Retrieves information about all the message templates that are associated with your Amazon Pinpoint account.
*/
listTemplates(callback?: (err: AWSError, data: Pinpoint.Types.ListTemplatesResponse) => void): Request<Pinpoint.Types.ListTemplatesResponse, AWSError>;
/**
* Retrieves information about a phone number.
*/
phoneNumberValidate(params: Pinpoint.Types.PhoneNumberValidateRequest, callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
/**
* Retrieves information about a phone number.
*/
phoneNumberValidate(callback?: (err: AWSError, data: Pinpoint.Types.PhoneNumberValidateResponse) => void): Request<Pinpoint.Types.PhoneNumberValidateResponse, AWSError>;
/**
* Creates a new event stream for an application or updates the settings of an existing event stream for an application.
*/
putEventStream(params: Pinpoint.Types.PutEventStreamRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
/**
* Creates a new event stream for an application or updates the settings of an existing event stream for an application.
*/
putEventStream(callback?: (err: AWSError, data: Pinpoint.Types.PutEventStreamResponse) => void): Request<Pinpoint.Types.PutEventStreamResponse, AWSError>;
/**
* Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
*/
putEvents(params: Pinpoint.Types.PutEventsRequest, callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
/**
* Creates a new event to record for endpoints, or creates or updates endpoint data that existing events are associated with.
*/
putEvents(callback?: (err: AWSError, data: Pinpoint.Types.PutEventsResponse) => void): Request<Pinpoint.Types.PutEventsResponse, AWSError>;
/**
* Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
*/
removeAttributes(params: Pinpoint.Types.RemoveAttributesRequest, callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
/**
* Removes one or more attributes, of the same attribute type, from all the endpoints that are associated with an application.
*/
removeAttributes(callback?: (err: AWSError, data: Pinpoint.Types.RemoveAttributesResponse) => void): Request<Pinpoint.Types.RemoveAttributesResponse, AWSError>;
/**
* Creates and sends a direct message.
*/
sendMessages(params: Pinpoint.Types.SendMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
/**
* Creates and sends a direct message.
*/
sendMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendMessagesResponse) => void): Request<Pinpoint.Types.SendMessagesResponse, AWSError>;
/**
* Creates and sends a message to a list of users.
*/
sendUsersMessages(params: Pinpoint.Types.SendUsersMessagesRequest, callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
/**
* Creates and sends a message to a list of users.
*/
sendUsersMessages(callback?: (err: AWSError, data: Pinpoint.Types.SendUsersMessagesResponse) => void): Request<Pinpoint.Types.SendUsersMessagesResponse, AWSError>;
/**
* Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
*/
tagResource(params: Pinpoint.Types.TagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Adds one or more tags (keys and values) to an application, campaign, message template, or segment.
*/
tagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
*/
untagResource(params: Pinpoint.Types.UntagResourceRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Removes one or more tags (keys and values) from an application, campaign, message template, or segment.
*/
untagResource(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
*/
updateAdmChannel(params: Pinpoint.Types.UpdateAdmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
/**
* Enables the ADM channel for an application or updates the status and settings of the ADM channel for an application.
*/
updateAdmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateAdmChannelResponse) => void): Request<Pinpoint.Types.UpdateAdmChannelResponse, AWSError>;
/**
* Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
*/
updateApnsChannel(params: Pinpoint.Types.UpdateApnsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
/**
* Enables the APNs channel for an application or updates the status and settings of the APNs channel for an application.
*/
updateApnsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsChannelResponse, AWSError>;
/**
* Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
*/
updateApnsSandboxChannel(params: Pinpoint.Types.UpdateApnsSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
/**
* Enables the APNs sandbox channel for an application or updates the status and settings of the APNs sandbox channel for an application.
*/
updateApnsSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsSandboxChannelResponse, AWSError>;
/**
* Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
*/
updateApnsVoipChannel(params: Pinpoint.Types.UpdateApnsVoipChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
/**
* Enables the APNs VoIP channel for an application or updates the status and settings of the APNs VoIP channel for an application.
*/
updateApnsVoipChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipChannelResponse, AWSError>;
/**
* Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
*/
updateApnsVoipSandboxChannel(params: Pinpoint.Types.UpdateApnsVoipSandboxChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
/**
* Enables the APNs VoIP sandbox channel for an application or updates the status and settings of the APNs VoIP sandbox channel for an application.
*/
updateApnsVoipSandboxChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse) => void): Request<Pinpoint.Types.UpdateApnsVoipSandboxChannelResponse, AWSError>;
/**
* Updates the settings for an application.
*/
updateApplicationSettings(params: Pinpoint.Types.UpdateApplicationSettingsRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
/**
* Updates the settings for an application.
*/
updateApplicationSettings(callback?: (err: AWSError, data: Pinpoint.Types.UpdateApplicationSettingsResponse) => void): Request<Pinpoint.Types.UpdateApplicationSettingsResponse, AWSError>;
/**
* Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
*/
updateBaiduChannel(params: Pinpoint.Types.UpdateBaiduChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
/**
* Enables the Baidu channel for an application or updates the status and settings of the Baidu channel for an application.
*/
updateBaiduChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateBaiduChannelResponse) => void): Request<Pinpoint.Types.UpdateBaiduChannelResponse, AWSError>;
/**
* Updates the configuration and other settings for a campaign.
*/
updateCampaign(params: Pinpoint.Types.UpdateCampaignRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
/**
* Updates the configuration and other settings for a campaign.
*/
updateCampaign(callback?: (err: AWSError, data: Pinpoint.Types.UpdateCampaignResponse) => void): Request<Pinpoint.Types.UpdateCampaignResponse, AWSError>;
/**
* Enables the email channel for an application or updates the status and settings of the email channel for an application.
*/
updateEmailChannel(params: Pinpoint.Types.UpdateEmailChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
/**
* Enables the email channel for an application or updates the status and settings of the email channel for an application.
*/
updateEmailChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailChannelResponse) => void): Request<Pinpoint.Types.UpdateEmailChannelResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through the email channel.
*/
updateEmailTemplate(params: Pinpoint.Types.UpdateEmailTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailTemplateResponse) => void): Request<Pinpoint.Types.UpdateEmailTemplateResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through the email channel.
*/
updateEmailTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEmailTemplateResponse) => void): Request<Pinpoint.Types.UpdateEmailTemplateResponse, AWSError>;
/**
* Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
*/
updateEndpoint(params: Pinpoint.Types.UpdateEndpointRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
/**
* Creates a new endpoint for an application or updates the settings and attributes of an existing endpoint for an application. You can also use this operation to define custom attributes for an endpoint. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
*/
updateEndpoint(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointResponse) => void): Request<Pinpoint.Types.UpdateEndpointResponse, AWSError>;
/**
* Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
*/
updateEndpointsBatch(params: Pinpoint.Types.UpdateEndpointsBatchRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
/**
* Creates a new batch of endpoints for an application or updates the settings and attributes of a batch of existing endpoints for an application. You can also use this operation to define custom attributes for a batch of endpoints. If an update includes one or more values for a custom attribute, Amazon Pinpoint replaces (overwrites) any existing values with the new values.
*/
updateEndpointsBatch(callback?: (err: AWSError, data: Pinpoint.Types.UpdateEndpointsBatchResponse) => void): Request<Pinpoint.Types.UpdateEndpointsBatchResponse, AWSError>;
/**
* Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
*/
updateGcmChannel(params: Pinpoint.Types.UpdateGcmChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
/**
* Enables the GCM channel for an application or updates the status and settings of the GCM channel for an application.
*/
updateGcmChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateGcmChannelResponse) => void): Request<Pinpoint.Types.UpdateGcmChannelResponse, AWSError>;
/**
* Updates the configuration and other settings for a journey.
*/
updateJourney(params: Pinpoint.Types.UpdateJourneyRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyResponse) => void): Request<Pinpoint.Types.UpdateJourneyResponse, AWSError>;
/**
* Updates the configuration and other settings for a journey.
*/
updateJourney(callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyResponse) => void): Request<Pinpoint.Types.UpdateJourneyResponse, AWSError>;
/**
* Cancels (stops) an active journey.
*/
updateJourneyState(params: Pinpoint.Types.UpdateJourneyStateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyStateResponse) => void): Request<Pinpoint.Types.UpdateJourneyStateResponse, AWSError>;
/**
* Cancels (stops) an active journey.
*/
updateJourneyState(callback?: (err: AWSError, data: Pinpoint.Types.UpdateJourneyStateResponse) => void): Request<Pinpoint.Types.UpdateJourneyStateResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through a push notification channel.
*/
updatePushTemplate(params: Pinpoint.Types.UpdatePushTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdatePushTemplateResponse) => void): Request<Pinpoint.Types.UpdatePushTemplateResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through a push notification channel.
*/
updatePushTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdatePushTemplateResponse) => void): Request<Pinpoint.Types.UpdatePushTemplateResponse, AWSError>;
/**
* Updates an Amazon Pinpoint configuration for a recommender model.
*/
updateRecommenderConfiguration(params: Pinpoint.Types.UpdateRecommenderConfigurationRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.UpdateRecommenderConfigurationResponse, AWSError>;
/**
* Updates an Amazon Pinpoint configuration for a recommender model.
*/
updateRecommenderConfiguration(callback?: (err: AWSError, data: Pinpoint.Types.UpdateRecommenderConfigurationResponse) => void): Request<Pinpoint.Types.UpdateRecommenderConfigurationResponse, AWSError>;
/**
* Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
*/
updateSegment(params: Pinpoint.Types.UpdateSegmentRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
/**
* Creates a new segment for an application or updates the configuration, dimension, and other settings for an existing segment that's associated with an application.
*/
updateSegment(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSegmentResponse) => void): Request<Pinpoint.Types.UpdateSegmentResponse, AWSError>;
/**
* Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
*/
updateSmsChannel(params: Pinpoint.Types.UpdateSmsChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
/**
* Enables the SMS channel for an application or updates the status and settings of the SMS channel for an application.
*/
updateSmsChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsChannelResponse) => void): Request<Pinpoint.Types.UpdateSmsChannelResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through the SMS channel.
*/
updateSmsTemplate(params: Pinpoint.Types.UpdateSmsTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsTemplateResponse) => void): Request<Pinpoint.Types.UpdateSmsTemplateResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through the SMS channel.
*/
updateSmsTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateSmsTemplateResponse) => void): Request<Pinpoint.Types.UpdateSmsTemplateResponse, AWSError>;
/**
* Changes the status of a specific version of a message template to active.
*/
updateTemplateActiveVersion(params: Pinpoint.Types.UpdateTemplateActiveVersionRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateTemplateActiveVersionResponse) => void): Request<Pinpoint.Types.UpdateTemplateActiveVersionResponse, AWSError>;
/**
* Changes the status of a specific version of a message template to active.
*/
updateTemplateActiveVersion(callback?: (err: AWSError, data: Pinpoint.Types.UpdateTemplateActiveVersionResponse) => void): Request<Pinpoint.Types.UpdateTemplateActiveVersionResponse, AWSError>;
/**
* Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
*/
updateVoiceChannel(params: Pinpoint.Types.UpdateVoiceChannelRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
/**
* Enables the voice channel for an application or updates the status and settings of the voice channel for an application.
*/
updateVoiceChannel(callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceChannelResponse) => void): Request<Pinpoint.Types.UpdateVoiceChannelResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through the voice channel.
*/
updateVoiceTemplate(params: Pinpoint.Types.UpdateVoiceTemplateRequest, callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceTemplateResponse) => void): Request<Pinpoint.Types.UpdateVoiceTemplateResponse, AWSError>;
/**
* Updates an existing message template for messages that are sent through the voice channel.
*/
updateVoiceTemplate(callback?: (err: AWSError, data: Pinpoint.Types.UpdateVoiceTemplateResponse) => void): Request<Pinpoint.Types.UpdateVoiceTemplateResponse, AWSError>;
}
declare namespace Pinpoint {
export interface ADMChannelRequest {
/**
* The Client ID that you received from Amazon to send messages by using ADM.
*/
ClientId: __string;
/**
* The Client Secret that you received from Amazon to send messages by using ADM.
*/
ClientSecret: __string;
/**
* Specifies whether to enable the ADM channel for the application.
*/
Enabled?: __boolean;
}
export interface ADMChannelResponse {
/**
* The unique identifier for the application that the ADM channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time when the ADM channel was enabled.
*/
CreationDate?: __string;
/**
* Specifies whether the ADM channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* (Deprecated) An identifier for the ADM channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the ADM channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the ADM channel.
*/
LastModifiedBy?: __string;
/**
* The date and time when the ADM channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the ADM channel, this value is ADM.
*/
Platform: __string;
/**
* The current version of the ADM channel.
*/
Version?: __integer;
}
export interface ADMMessage {
/**
* The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The body of the notification message.
*/
Body?: __string;
/**
* An arbitrary string that indicates that multiple messages are logically the same and that Amazon Device Messaging (ADM) can drop previously enqueued messages in favor of this message.
*/
ConsolidationKey?: __string;
/**
* The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/
Data?: MapOf__string;
/**
* The amount of time, in seconds, that ADM should store the message if the recipient's device is offline. Amazon Pinpoint specifies this value in the expiresAfter parameter when it sends the notification message to ADM.
*/
ExpiresAfter?: __string;
/**
* The icon image name of the asset saved in your app.
*/
IconReference?: __string;
/**
* The URL of the large icon image to display in the content view of the push notification.
*/
ImageIconUrl?: __string;
/**
* The URL of an image to display in the push notification.
*/
ImageUrl?: __string;
/**
* The base64-encoded, MD5 checksum of the value specified by the Data property. ADM uses the MD5 value to verify the integrity of the data.
*/
MD5?: __string;
/**
* The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
*/
RawContent?: __string;
/**
* Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
*/
SilentPush?: __boolean;
/**
* The URL of the small icon image to display in the status bar and the content view of the push notification.
*/
SmallImageIconUrl?: __string;
/**
* The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
*/
Sound?: __string;
/**
* The default message variables to use in the notification message. You can override the default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The title to display above the notification message on the recipient's device.
*/
Title?: __string;
/**
* The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/
Url?: __string;
}
export interface APNSChannelRequest {
/**
* The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
*/
BundleId?: __string;
/**
* The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
*/
Certificate?: __string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether to enable the APNs channel for the application.
*/
Enabled?: __boolean;
/**
* The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
*/
PrivateKey?: __string;
/**
* The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
*/
TeamId?: __string;
/**
* The authentication key to use for APNs tokens.
*/
TokenKey?: __string;
/**
* The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
*/
TokenKeyId?: __string;
}
export interface APNSChannelResponse {
/**
* The unique identifier for the application that the APNs channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time when the APNs channel was enabled.
*/
CreationDate?: __string;
/**
* The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether the APNs channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* Specifies whether the APNs channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
*/
HasTokenKey?: __boolean;
/**
* (Deprecated) An identifier for the APNs channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the APNs channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the APNs channel.
*/
LastModifiedBy?: __string;
/**
* The date and time when the APNs channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the APNs channel, this value is APNS.
*/
Platform: __string;
/**
* The current version of the APNs channel.
*/
Version?: __integer;
}
export interface APNSMessage {
/**
* The type of push notification to send. Valid values are: alert - For a standard notification that's displayed on recipients' devices and prompts a recipient to interact with the notification. background - For a silent notification that delivers content in the background and isn't displayed on recipients' devices. complication - For a notification that contains update information for an app’s complication timeline. fileprovider - For a notification that signals changes to a File Provider extension. mdm - For a notification that tells managed devices to contact the MDM server. voip - For a notification that provides information about an incoming VoIP call. Amazon Pinpoint specifies this value in the apns-push-type request header when it sends the notification message to APNs. If you don't specify a value for this property, Amazon Pinpoint sets the value to alert or background automatically, based on the value that you specify for the SilentPush or RawContent property of the message. For more information about the apns-push-type request header, see Sending Notification Requests to APNs on the Apple Developer website.
*/
APNSPushType?: __string;
/**
* The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The key that indicates whether and how to modify the badge of your app's icon when the recipient receives the push notification. If this key isn't included in the dictionary, the badge doesn't change. To remove the badge, set this value to 0.
*/
Badge?: __integer;
/**
* The body of the notification message.
*/
Body?: __string;
/**
* The key that indicates the notification type for the push notification. This key is a value that's defined by the identifier property of one of your app's registered categories.
*/
Category?: __string;
/**
* An arbitrary identifier that, if assigned to multiple messages, APNs uses to coalesce the messages into a single push notification instead of delivering each message individually. This value can't exceed 64 bytes. Amazon Pinpoint specifies this value in the apns-collapse-id request header when it sends the notification message to APNs.
*/
CollapseId?: __string;
/**
* The JSON payload to use for a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/
Data?: MapOf__string;
/**
* The URL of an image or video to display in the push notification.
*/
MediaUrl?: __string;
/**
* The authentication method that you want Amazon Pinpoint to use when authenticating with APNs, CERTIFICATE or TOKEN.
*/
PreferredAuthenticationMethod?: __string;
/**
* para>5 - Low priority, the notification might be delayed, delivered as part of a group, or throttled./listitem> 10 - High priority, the notification is sent immediately. This is the default value. A high priority notification should trigger an alert, play a sound, or badge your app's icon on the recipient's device./para> Amazon Pinpoint specifies this value in the apns-priority request header when it sends the notification message to APNs. The equivalent values for Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), are normal, for 5, and high, for 10. If you specify an FCM value for this property, Amazon Pinpoint accepts and converts the value to the corresponding APNs value.
*/
Priority?: __string;
/**
* The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. The value of the content-available key has to be an integer, and can only be 0 or 1. If you're sending a standard notification, set the value of content-available to 0. If you're sending a silent (background) notification, set the value of content-available to 1. Additionally, silent notification payloads can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website.
*/
RawContent?: __string;
/**
* Specifies whether the notification is a silent push notification. A silent (or background) push notification isn't displayed on recipients' devices. You can use silent push notifications to make small updates to your app, or to display messages in an in-app message center. Amazon Pinpoint uses this property to determine the correct value for the apns-push-type request header when it sends the notification message to APNs. If you specify a value of true for this property, Amazon Pinpoint sets the value for the apns-push-type header field to background. If you specify the raw content of an APNs push notification, the message payload has to include the content-available key. For silent (background) notifications, set the value of content-available to 1. Additionally, the message payload for a silent notification can't include the alert, badge, or sound keys. For more information, see Generating a Remote Notification and Pushing Background Updates to Your App on the Apple Developer website. Apple has indicated that they will throttle "excessive" background notifications based on current traffic volumes. To prevent your notifications being throttled, Apple recommends that you send no more than 3 silent push notifications to each recipient per hour.
*/
SilentPush?: __boolean;
/**
* The key for the sound to play when the recipient receives the push notification. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
*/
Sound?: __string;
/**
* The default message variables to use in the notification message. You can override these default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The key that represents your app-specific identifier for grouping notifications. If you provide a Notification Content app extension, you can use this value to group your notifications together.
*/
ThreadId?: __string;
/**
* The amount of time, in seconds, that APNs should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If this value is 0, APNs treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. Amazon Pinpoint specifies this value in the apns-expiration request header when it sends the notification message to APNs.
*/
TimeToLive?: __integer;
/**
* The title to display above the notification message on the recipient's device.
*/
Title?: __string;
/**
* The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/
Url?: __string;
}
export interface APNSPushNotificationTemplate {
/**
* The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The message body to use in push notifications that are based on the message template.
*/
Body?: __string;
/**
* The URL of an image or video to display in push notifications that are based on the message template.
*/
MediaUrl?: __string;
/**
* The raw, JSON-formatted string to use as the payload for push notifications that are based on the message template. If specified, this value overrides all other content for the message template.
*/
RawContent?: __string;
/**
* The key for the sound to play when the recipient receives a push notification that's based on the message template. The value for this key is the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
*/
Sound?: __string;
/**
* The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
*/
Title?: __string;
/**
* The URL to open in the recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
*/
Url?: __string;
}
export interface APNSSandboxChannelRequest {
/**
* The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
*/
BundleId?: __string;
/**
* The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
*/
Certificate?: __string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether to enable the APNs sandbox channel for the application.
*/
Enabled?: __boolean;
/**
* The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
*/
PrivateKey?: __string;
/**
* The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
*/
TeamId?: __string;
/**
* The authentication key to use for APNs tokens.
*/
TokenKey?: __string;
/**
* The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
*/
TokenKeyId?: __string;
}
export interface APNSSandboxChannelResponse {
/**
* The unique identifier for the application that the APNs sandbox channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time when the APNs sandbox channel was enabled.
*/
CreationDate?: __string;
/**
* The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether the APNs sandbox channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* Specifies whether the APNs sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
*/
HasTokenKey?: __boolean;
/**
* (Deprecated) An identifier for the APNs sandbox channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the APNs sandbox channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the APNs sandbox channel.
*/
LastModifiedBy?: __string;
/**
* The date and time when the APNs sandbox channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the APNs sandbox channel, this value is APNS_SANDBOX.
*/
Platform: __string;
/**
* The current version of the APNs sandbox channel.
*/
Version?: __integer;
}
export interface APNSVoipChannelRequest {
/**
* The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
*/
BundleId?: __string;
/**
* The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with APNs by using an APNs certificate.
*/
Certificate?: __string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with APNs, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether to enable the APNs VoIP channel for the application.
*/
Enabled?: __boolean;
/**
* The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with APNs.
*/
PrivateKey?: __string;
/**
* The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
*/
TeamId?: __string;
/**
* The authentication key to use for APNs tokens.
*/
TokenKey?: __string;
/**
* The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with APNs by using APNs tokens.
*/
TokenKeyId?: __string;
}
export interface APNSVoipChannelResponse {
/**
* The unique identifier for the application that the APNs VoIP channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time when the APNs VoIP channel was enabled.
*/
CreationDate?: __string;
/**
* The default authentication method that Amazon Pinpoint uses to authenticate with APNs for this channel, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether the APNs VoIP channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* Specifies whether the APNs VoIP channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
*/
HasTokenKey?: __boolean;
/**
* (Deprecated) An identifier for the APNs VoIP channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the APNs VoIP channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the APNs VoIP channel.
*/
LastModifiedBy?: __string;
/**
* The date and time when the APNs VoIP channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the APNs VoIP channel, this value is APNS_VOIP.
*/
Platform: __string;
/**
* The current version of the APNs VoIP channel.
*/
Version?: __integer;
}
export interface APNSVoipSandboxChannelRequest {
/**
* The bundle identifier that's assigned to your iOS app. This identifier is used for APNs tokens.
*/
BundleId?: __string;
/**
* The APNs client certificate that you received from Apple, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using an APNs certificate.
*/
Certificate?: __string;
/**
* The default authentication method that you want Amazon Pinpoint to use when authenticating with the APNs sandbox environment for this channel, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether the APNs VoIP sandbox channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* The private key for the APNs client certificate that you want Amazon Pinpoint to use to communicate with the APNs sandbox environment.
*/
PrivateKey?: __string;
/**
* The identifier that's assigned to your Apple developer account team. This identifier is used for APNs tokens.
*/
TeamId?: __string;
/**
* The authentication key to use for APNs tokens.
*/
TokenKey?: __string;
/**
* The key identifier that's assigned to your APNs signing key, if you want Amazon Pinpoint to communicate with the APNs sandbox environment by using APNs tokens.
*/
TokenKeyId?: __string;
}
export interface APNSVoipSandboxChannelResponse {
/**
* The unique identifier for the application that the APNs VoIP sandbox channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time when the APNs VoIP sandbox channel was enabled.
*/
CreationDate?: __string;
/**
* The default authentication method that Amazon Pinpoint uses to authenticate with the APNs sandbox environment for this channel, key or certificate.
*/
DefaultAuthenticationMethod?: __string;
/**
* Specifies whether the APNs VoIP sandbox channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* Specifies whether the APNs VoIP sandbox channel is configured to communicate with APNs by using APNs tokens. To provide an authentication key for APNs tokens, set the TokenKey property of the channel.
*/
HasTokenKey?: __boolean;
/**
* (Deprecated) An identifier for the APNs VoIP sandbox channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the APNs VoIP sandbox channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the APNs VoIP sandbox channel.
*/
LastModifiedBy?: __string;
/**
* The date and time when the APNs VoIP sandbox channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the APNs VoIP sandbox channel, this value is APNS_VOIP_SANDBOX.
*/
Platform: __string;
/**
* The current version of the APNs VoIP sandbox channel.
*/
Version?: __integer;
}
export type Action = "OPEN_APP"|"DEEP_LINK"|"URL"|string;
export interface ActivitiesResponse {
/**
* An array of responses, one for each activity that was performed by the campaign.
*/
Item: ListOfActivityResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export interface Activity {
/**
* The settings for a custom message activity. This type of activity calls an AWS Lambda function or web hook that sends messages to participants.
*/
CUSTOM?: CustomMessageActivity;
/**
* The settings for a yes/no split activity. This type of activity sends participants down one of two paths in a journey, based on conditions that you specify.
*/
ConditionalSplit?: ConditionalSplitActivity;
/**
* The custom description of the activity.
*/
Description?: __string;
/**
* The settings for an email activity. This type of activity sends an email message to participants.
*/
EMAIL?: EmailMessageActivity;
/**
* The settings for a holdout activity. This type of activity stops a journey for a specified percentage of participants.
*/
Holdout?: HoldoutActivity;
/**
* The settings for a multivariate split activity. This type of activity sends participants down one of as many as five paths (including a default Else path) in a journey, based on conditions that you specify.
*/
MultiCondition?: MultiConditionalSplitActivity;
/**
* The settings for a push notification activity. This type of activity sends a push notification to participants.
*/
PUSH?: PushMessageActivity;
/**
* The settings for a random split activity. This type of activity randomly sends specified percentages of participants down one of as many as five paths in a journey, based on conditions that you specify.
*/
RandomSplit?: RandomSplitActivity;
/**
* The settings for an SMS activity. This type of activity sends a text message to participants.
*/
SMS?: SMSMessageActivity;
/**
* The settings for a wait activity. This type of activity waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
*/
Wait?: WaitActivity;
}
export interface ActivityResponse {
/**
* The unique identifier for the application that the campaign applies to.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign that the activity applies to.
*/
CampaignId: __string;
/**
* The actual time, in ISO 8601 format, when the activity was marked CANCELLED or COMPLETED.
*/
End?: __string;
/**
* The unique identifier for the activity.
*/
Id: __string;
/**
* Specifies whether the activity succeeded. Possible values are SUCCESS and FAIL.
*/
Result?: __string;
/**
* The scheduled start time, in ISO 8601 format, for the activity.
*/
ScheduledStart?: __string;
/**
* The actual start time, in ISO 8601 format, of the activity.
*/
Start?: __string;
/**
* The current status of the activity. Possible values are: PENDING, INITIALIZING, RUNNING, PAUSED, CANCELLED, and COMPLETED.
*/
State?: __string;
/**
* The total number of endpoints that the campaign successfully delivered messages to.
*/
SuccessfulEndpointCount?: __integer;
/**
* The total number of time zones that were completed.
*/
TimezonesCompletedCount?: __integer;
/**
* The total number of unique time zones that are in the segment for the campaign.
*/
TimezonesTotalCount?: __integer;
/**
* The total number of endpoints that the campaign attempted to deliver messages to.
*/
TotalEndpointCount?: __integer;
/**
* The unique identifier for the campaign treatment that the activity applies to. A treatment is a variation of a campaign that's used for A/B testing of a campaign.
*/
TreatmentId?: __string;
}
export interface AddressConfiguration {
/**
* The message body to use instead of the default message body. This value overrides the default message body.
*/
BodyOverride?: __string;
/**
* The channel to use when sending the message.
*/
ChannelType?: ChannelType;
/**
* An object that maps custom attributes to attributes for the address and is attached to the message. Attribute names are case sensitive. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
*/
Context?: MapOf__string;
/**
* The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
*/
RawContent?: __string;
/**
* A map of the message variables to merge with the variables specified by properties of the DefaultMessage object. The variables specified in this map take precedence over all other variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The message title to use instead of the default message title. This value overrides the default message title.
*/
TitleOverride?: __string;
}
export interface AndroidPushNotificationTemplate {
/**
* The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The message body to use in a push notification that's based on the message template.
*/
Body?: __string;
/**
* The URL of the large icon image to display in the content view of a push notification that's based on the message template.
*/
ImageIconUrl?: __string;
/**
* The URL of an image to display in a push notification that's based on the message template.
*/
ImageUrl?: __string;
/**
* The raw, JSON-formatted string to use as the payload for a push notification that's based on the message template. If specified, this value overrides all other content for the message template.
*/
RawContent?: __string;
/**
* The URL of the small icon image to display in the status bar and the content view of a push notification that's based on the message template.
*/
SmallImageIconUrl?: __string;
/**
* The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
*/
Sound?: __string;
/**
* The title to use in a push notification that's based on the message template. This title appears above the notification message on a recipient's device.
*/
Title?: __string;
/**
* The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
*/
Url?: __string;
}
export interface ApplicationDateRangeKpiResponse {
/**
* The unique identifier for the application that the metric applies to.
*/
ApplicationId: __string;
/**
* The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/
EndTime: __timestampIso8601;
/**
* The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
*/
KpiName: __string;
/**
* An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
*/
KpiResult: BaseKpiResult;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Application Metrics resource because the resource returns all results in a single page.
*/
NextToken?: __string;
/**
* The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/
StartTime: __timestampIso8601;
}
export interface ApplicationResponse {
/**
* The Amazon Resource Name (ARN) of the application.
*/
Arn: __string;
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
Id: __string;
/**
* The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
*/
Name: __string;
/**
* A string-to-string map of key-value pairs that identifies the tags that are associated with the application. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
}
export interface ApplicationSettingsResource {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application.
*/
CampaignHook?: CampaignHook;
/**
* The date and time, in ISO 8601 format, when the application's settings were last modified.
*/
LastModifiedDate?: __string;
/**
* The default sending limits for campaigns in the application.
*/
Limits?: CampaignLimits;
/**
* The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings). The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled.
*/
QuietTime?: QuietTime;
}
export interface ApplicationsResponse {
/**
* An array of responses, one for each application that was returned.
*/
Item?: ListOfApplicationResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export interface AttributeDimension {
/**
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
*/
AttributeType?: AttributeType;
/**
* The criteria values to use for the segment dimension. Depending on the value of the AttributeType property, endpoints are included or excluded from the segment if their attribute values match the criteria values.
*/
Values: ListOf__string;
}
export type AttributeType = "INCLUSIVE"|"EXCLUSIVE"|string;
export interface AttributesResource {
/**
* The unique identifier for the application.
*/
ApplicationId: __string;
/**
* The type of attribute or attributes that were removed from the endpoints. Valid values are: endpoint-custom-attributes - Custom attributes that describe endpoints. endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints. endpoint-user-attributes - Custom attributes that describe users.
*/
AttributeType: __string;
/**
* An array that specifies the names of the attributes that were removed from the endpoints.
*/
Attributes?: ListOf__string;
}
export interface BaiduChannelRequest {
/**
* The API key that you received from the Baidu Cloud Push service to communicate with the service.
*/
ApiKey: __string;
/**
* Specifies whether to enable the Baidu channel for the application.
*/
Enabled?: __boolean;
/**
* The secret key that you received from the Baidu Cloud Push service to communicate with the service.
*/
SecretKey: __string;
}
export interface BaiduChannelResponse {
/**
* The unique identifier for the application that the Baidu channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time when the Baidu channel was enabled.
*/
CreationDate?: __string;
/**
* The API key that you received from the Baidu Cloud Push service to communicate with the service.
*/
Credential: __string;
/**
* Specifies whether the Baidu channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* (Deprecated) An identifier for the Baidu channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the Baidu channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the Baidu channel.
*/
LastModifiedBy?: __string;
/**
* The date and time when the Baidu channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the Baidu channel, this value is BAIDU.
*/
Platform: __string;
/**
* The current version of the Baidu channel.
*/
Version?: __integer;
}
export interface BaiduMessage {
/**
* The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The body of the notification message.
*/
Body?: __string;
/**
* The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/
Data?: MapOf__string;
/**
* The icon image name of the asset saved in your app.
*/
IconReference?: __string;
/**
* The URL of the large icon image to display in the content view of the push notification.
*/
ImageIconUrl?: __string;
/**
* The URL of an image to display in the push notification.
*/
ImageUrl?: __string;
/**
* The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
*/
RawContent?: __string;
/**
* Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
*/
SilentPush?: __boolean;
/**
* The URL of the small icon image to display in the status bar and the content view of the push notification.
*/
SmallImageIconUrl?: __string;
/**
* The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
*/
Sound?: __string;
/**
* The default message variables to use in the notification message. You can override the default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The amount of time, in seconds, that the Baidu Cloud Push service should store the message if the recipient's device is offline. The default value and maximum supported time is 604,800 seconds (7 days).
*/
TimeToLive?: __integer;
/**
* The title to display above the notification message on the recipient's device.
*/
Title?: __string;
/**
* The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/
Url?: __string;
}
export interface BaseKpiResult {
/**
* An array of objects that provides the results of a query that retrieved the data for a standard metric that applies to an application, campaign, or journey.
*/
Rows: ListOfResultRow;
}
export interface CampaignCustomMessage {
/**
* The raw, JSON-formatted string to use as the payload for the message. The maximum size is 5 KB.
*/
Data?: __string;
}
export interface CampaignDateRangeKpiResponse {
/**
* The unique identifier for the application that the metric applies to.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign that the metric applies to.
*/
CampaignId: __string;
/**
* The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/
EndTime: __timestampIso8601;
/**
* The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
*/
KpiName: __string;
/**
* An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
*/
KpiResult: BaseKpiResult;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Campaign Metrics resource because the resource returns all results in a single page.
*/
NextToken?: __string;
/**
* The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/
StartTime: __timestampIso8601;
}
export interface CampaignEmailMessage {
/**
* The body of the email for recipients whose email clients don't render HTML content.
*/
Body?: __string;
/**
* The verified email address to send the email from. The default address is the FromAddress specified for the email channel for the application.
*/
FromAddress?: __string;
/**
* The body of the email, in HTML format, for recipients whose email clients render HTML content.
*/
HtmlBody?: __string;
/**
* The subject line, or title, of the email.
*/
Title?: __string;
}
export interface CampaignEventFilter {
/**
* The dimension settings of the event filter for the campaign.
*/
Dimensions: EventDimensions;
/**
* The type of event that causes the campaign to be sent. Valid values are: SYSTEM, sends the campaign when a system event occurs; and, ENDPOINT, sends the campaign when an endpoint event (Events resource) occurs.
*/
FilterType: FilterType;
}
export interface CampaignHook {
/**
* The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to customize a segment for a campaign.
*/
LambdaFunctionName?: __string;
/**
* The mode that Amazon Pinpoint uses to invoke the AWS Lambda function. Possible values are: FILTER - Invoke the function to customize the segment that's used by a campaign. DELIVERY - (Deprecated) Previously, invoked the function to send a campaign through a custom channel. This functionality is not supported anymore. To send a campaign through a custom channel, use the CustomDeliveryConfiguration and CampaignCustomMessage objects of the campaign.
*/
Mode?: Mode;
/**
* The web URL that Amazon Pinpoint calls to invoke the AWS Lambda function over HTTPS.
*/
WebUrl?: __string;
}
export interface CampaignLimits {
/**
* The maximum number of messages that a campaign can send to a single endpoint during a 24-hour period. For an application, this value specifies the default limit for the number of messages that campaigns and journeys can send to a single endpoint during a 24-hour period. The maximum value is 100.
*/
Daily?: __integer;
/**
* The maximum amount of time, in seconds, that a campaign can attempt to deliver a message after the scheduled start time for the campaign. The minimum value is 60 seconds.
*/
MaximumDuration?: __integer;
/**
* The maximum number of messages that a campaign can send each second. For an application, this value specifies the default limit for the number of messages that campaigns can send each second. The minimum value is 50. The maximum value is 20,000.
*/
MessagesPerSecond?: __integer;
/**
* The maximum number of messages that a campaign can send to a single endpoint during the course of the campaign. If a campaign recurs, this setting applies to all runs of the campaign. The maximum value is 100.
*/
Total?: __integer;
}
export interface CampaignResponse {
/**
* An array of responses, one for each treatment that you defined for the campaign, in addition to the default treatment.
*/
AdditionalTreatments?: ListOfTreatmentResource;
/**
* The unique identifier for the application that the campaign applies to.
*/
ApplicationId: __string;
/**
* The Amazon Resource Name (ARN) of the campaign.
*/
Arn: __string;
/**
* The date, in ISO 8601 format, when the campaign was created.
*/
CreationDate: __string;
/**
* The delivery configuration settings for sending the campaign through a custom channel.
*/
CustomDeliveryConfiguration?: CustomDeliveryConfiguration;
/**
* The current status of the campaign's default treatment. This value exists only for campaigns that have more than one treatment.
*/
DefaultState?: CampaignState;
/**
* The custom description of the campaign.
*/
Description?: __string;
/**
* The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
*/
HoldoutPercent?: __integer;
/**
* The settings for the AWS Lambda function to use as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
*/
Hook?: CampaignHook;
/**
* The unique identifier for the campaign.
*/
Id: __string;
/**
* Specifies whether the campaign is paused. A paused campaign doesn't run unless you resume it by changing this value to false.
*/
IsPaused?: __boolean;
/**
* The date, in ISO 8601 format, when the campaign was last modified.
*/
LastModifiedDate: __string;
/**
* The messaging limits for the campaign.
*/
Limits?: CampaignLimits;
/**
* The message configuration settings for the campaign.
*/
MessageConfiguration?: MessageConfiguration;
/**
* The name of the campaign.
*/
Name?: __string;
/**
* The schedule settings for the campaign.
*/
Schedule?: Schedule;
/**
* The unique identifier for the segment that's associated with the campaign.
*/
SegmentId: __string;
/**
* The version number of the segment that's associated with the campaign.
*/
SegmentVersion: __integer;
/**
* The current status of the campaign.
*/
State?: CampaignState;
/**
* A string-to-string map of key-value pairs that identifies the tags that are associated with the campaign. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* The message template that’s used for the campaign.
*/
TemplateConfiguration?: TemplateConfiguration;
/**
* The custom description of the default treatment for the campaign.
*/
TreatmentDescription?: __string;
/**
* The custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
*/
TreatmentName?: __string;
/**
* The version number of the campaign.
*/
Version?: __integer;
}
export interface CampaignSmsMessage {
/**
* The body of the SMS message.
*/
Body?: __string;
/**
* The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
*/
MessageType?: MessageType;
/**
* The sender ID to display on recipients' devices when they receive the SMS message.
*/
SenderId?: __string;
}
export interface CampaignState {
/**
* The current status of the campaign, or the current status of a treatment that belongs to an A/B test campaign. If a campaign uses A/B testing, the campaign has a status of COMPLETED only if all campaign treatments have a status of COMPLETED. If you delete the segment that's associated with a campaign, the campaign fails and has a status of DELETED.
*/
CampaignStatus?: CampaignStatus;
}
export type CampaignStatus = "SCHEDULED"|"EXECUTING"|"PENDING_NEXT_RUN"|"COMPLETED"|"PAUSED"|"DELETED"|"INVALID"|string;
export interface CampaignsResponse {
/**
* An array of responses, one for each campaign that's associated with the application.
*/
Item: ListOfCampaignResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export interface ChannelResponse {
/**
* The unique identifier for the application.
*/
ApplicationId?: __string;
/**
* The date and time, in ISO 8601 format, when the channel was enabled.
*/
CreationDate?: __string;
/**
* Specifies whether the channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* (Deprecated) An identifier for the channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the channel.
*/
LastModifiedBy?: __string;
/**
* The date and time, in ISO 8601 format, when the channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The current version of the channel.
*/
Version?: __integer;
}
export type ChannelType = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string;
export interface ChannelsResponse {
/**
* A map that contains a multipart response for each channel. For each item in this object, the ChannelType is the key and the Channel is the value.
*/
Channels: MapOfChannelResponse;
}
export interface Condition {
/**
* The conditions to evaluate for the activity.
*/
Conditions?: ListOfSimpleCondition;
/**
* Specifies how to handle multiple conditions for the activity. For example, if you specify two conditions for an activity, whether both or only one of the conditions must be met for the activity to be performed.
*/
Operator?: Operator;
}
export interface ConditionalSplitActivity {
/**
* The conditions that define the paths for the activity, and the relationship between the conditions.
*/
Condition?: Condition;
/**
* The amount of time to wait before determining whether the conditions are met, or the date and time when Amazon Pinpoint determines whether the conditions are met.
*/
EvaluationWaitTime?: WaitTime;
/**
* The unique identifier for the activity to perform if the conditions aren't met.
*/
FalseActivity?: __string;
/**
* The unique identifier for the activity to perform if the conditions are met.
*/
TrueActivity?: __string;
}
export interface CreateAppRequest {
CreateApplicationRequest: CreateApplicationRequest;
}
export interface CreateAppResponse {
ApplicationResponse: ApplicationResponse;
}
export interface CreateApplicationRequest {
/**
* The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
*/
Name: __string;
/**
* A string-to-string map of key-value pairs that defines the tags to associate with the application. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
}
export interface CreateCampaignRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
WriteCampaignRequest: WriteCampaignRequest;
}
export interface CreateCampaignResponse {
CampaignResponse: CampaignResponse;
}
export interface CreateEmailTemplateRequest {
EmailTemplateRequest: EmailTemplateRequest;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
}
export interface CreateEmailTemplateResponse {
CreateTemplateMessageBody: CreateTemplateMessageBody;
}
export interface CreateExportJobRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
ExportJobRequest: ExportJobRequest;
}
export interface CreateExportJobResponse {
ExportJobResponse: ExportJobResponse;
}
export interface CreateImportJobRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
ImportJobRequest: ImportJobRequest;
}
export interface CreateImportJobResponse {
ImportJobResponse: ImportJobResponse;
}
export interface CreateJourneyRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
WriteJourneyRequest: WriteJourneyRequest;
}
export interface CreateJourneyResponse {
JourneyResponse: JourneyResponse;
}
export interface CreatePushTemplateRequest {
PushNotificationTemplateRequest: PushNotificationTemplateRequest;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
}
export interface CreatePushTemplateResponse {
CreateTemplateMessageBody: CreateTemplateMessageBody;
}
export interface CreateRecommenderConfiguration {
/**
* A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template. In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names: An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique. An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
*/
Attributes?: MapOf__string;
/**
* A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
*/
Description?: __string;
/**
* A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
*/
Name?: __string;
/**
* The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are: PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value. PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
*/
RecommendationProviderIdType?: __string;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
*/
RecommendationProviderRoleArn: __string;
/**
* The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
*/
RecommendationProviderUri: __string;
/**
* The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
*/
RecommendationTransformerUri?: __string;
/**
* A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
*/
RecommendationsDisplayName?: __string;
/**
* The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5. To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/
RecommendationsPerMessage?: __integer;
}
export interface CreateRecommenderConfigurationRequest {
CreateRecommenderConfiguration: CreateRecommenderConfiguration;
}
export interface CreateRecommenderConfigurationResponse {
RecommenderConfigurationResponse: RecommenderConfigurationResponse;
}
export interface CreateSegmentRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
WriteSegmentRequest: WriteSegmentRequest;
}
export interface CreateSegmentResponse {
SegmentResponse: SegmentResponse;
}
export interface CreateSmsTemplateRequest {
SMSTemplateRequest: SMSTemplateRequest;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
}
export interface CreateSmsTemplateResponse {
CreateTemplateMessageBody: CreateTemplateMessageBody;
}
export interface CreateTemplateMessageBody {
/**
* The Amazon Resource Name (ARN) of the message template that was created.
*/
Arn?: __string;
/**
* The message that's returned from the API for the request to create the message template.
*/
Message?: __string;
/**
* The unique identifier for the request to create the message template.
*/
RequestID?: __string;
}
export interface CreateVoiceTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
VoiceTemplateRequest: VoiceTemplateRequest;
}
export interface CreateVoiceTemplateResponse {
CreateTemplateMessageBody: CreateTemplateMessageBody;
}
export interface CustomDeliveryConfiguration {
/**
* The destination to send the campaign or treatment to. This value can be one of the following: The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment. The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
*/
DeliveryUri: __string;
/**
* The types of endpoints to send the campaign or treatment to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
*/
EndpointTypes?: ListOf__EndpointTypesElement;
}
export interface CustomMessageActivity {
/**
* The destination to send the campaign or treatment to. This value can be one of the following: The name or Amazon Resource Name (ARN) of an AWS Lambda function to invoke to handle delivery of the campaign or treatment. The URL for a web application or service that supports HTTPS and can receive the message. The URL has to be a full URL, including the HTTPS protocol.
*/
DeliveryUri?: __string;
/**
* The types of endpoints to send the custom message to. Each valid value maps to a type of channel that you can associate with an endpoint by using the ChannelType property of an endpoint.
*/
EndpointTypes?: ListOf__EndpointTypesElement;
/**
* Specifies the message data included in a custom channel message that's sent to participants in a journey.
*/
MessageConfig?: JourneyCustomMessage;
/**
* The unique identifier for the next activity to perform, after Amazon Pinpoint calls the AWS Lambda function or web hook.
*/
NextActivity?: __string;
/**
* The name of the custom message template to use for the message. If specified, this value must match the name of an existing message template.
*/
TemplateName?: __string;
/**
* The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource. If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/
TemplateVersion?: __string;
}
export interface DefaultMessage {
/**
* The default body of the message.
*/
Body?: __string;
/**
* The default message variables to use in the message. You can override these default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
}
export interface DefaultPushNotificationMessage {
/**
* The default action to occur if a recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The default body of the notification message.
*/
Body?: __string;
/**
* The JSON data payload to use for the default push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/
Data?: MapOf__string;
/**
* Specifies whether the default notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or delivering messages to an in-app notification center.
*/
SilentPush?: __boolean;
/**
* The default message variables to use in the notification message. You can override the default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The default title to display above the notification message on a recipient's device.
*/
Title?: __string;
/**
* The default URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/
Url?: __string;
}
export interface DefaultPushNotificationTemplate {
/**
* The action to occur if a recipient taps a push notification that's based on the message template. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of the iOS and Android platforms. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The message body to use in push notifications that are based on the message template.
*/
Body?: __string;
/**
* The sound to play when a recipient receives a push notification that's based on the message template. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/. For an iOS platform, this value is the key for the name of a sound file in your app's main bundle or the Library/Sounds folder in your app's data container. If the sound file can't be found or you specify default for the value, the system plays the default alert sound.
*/
Sound?: __string;
/**
* The title to use in push notifications that are based on the message template. This title appears above the notification message on a recipient's device.
*/
Title?: __string;
/**
* The URL to open in a recipient's default mobile browser, if a recipient taps a push notification that's based on the message template and the value of the Action property is URL.
*/
Url?: __string;
}
export interface DeleteAdmChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteAdmChannelResponse {
ADMChannelResponse: ADMChannelResponse;
}
export interface DeleteApnsChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteApnsChannelResponse {
APNSChannelResponse: APNSChannelResponse;
}
export interface DeleteApnsSandboxChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteApnsSandboxChannelResponse {
APNSSandboxChannelResponse: APNSSandboxChannelResponse;
}
export interface DeleteApnsVoipChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteApnsVoipChannelResponse {
APNSVoipChannelResponse: APNSVoipChannelResponse;
}
export interface DeleteApnsVoipSandboxChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteApnsVoipSandboxChannelResponse {
APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
}
export interface DeleteAppRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteAppResponse {
ApplicationResponse: ApplicationResponse;
}
export interface DeleteBaiduChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteBaiduChannelResponse {
BaiduChannelResponse: BaiduChannelResponse;
}
export interface DeleteCampaignRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign.
*/
CampaignId: __string;
}
export interface DeleteCampaignResponse {
CampaignResponse: CampaignResponse;
}
export interface DeleteEmailChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteEmailChannelResponse {
EmailChannelResponse: EmailChannelResponse;
}
export interface DeleteEmailTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface DeleteEmailTemplateResponse {
MessageBody: MessageBody;
}
export interface DeleteEndpointRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the endpoint.
*/
EndpointId: __string;
}
export interface DeleteEndpointResponse {
EndpointResponse: EndpointResponse;
}
export interface DeleteEventStreamRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteEventStreamResponse {
EventStream: EventStream;
}
export interface DeleteGcmChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteGcmChannelResponse {
GCMChannelResponse: GCMChannelResponse;
}
export interface DeleteJourneyRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the journey.
*/
JourneyId: __string;
}
export interface DeleteJourneyResponse {
JourneyResponse: JourneyResponse;
}
export interface DeletePushTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface DeletePushTemplateResponse {
MessageBody: MessageBody;
}
export interface DeleteRecommenderConfigurationRequest {
/**
* The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
*/
RecommenderId: __string;
}
export interface DeleteRecommenderConfigurationResponse {
RecommenderConfigurationResponse: RecommenderConfigurationResponse;
}
export interface DeleteSegmentRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the segment.
*/
SegmentId: __string;
}
export interface DeleteSegmentResponse {
SegmentResponse: SegmentResponse;
}
export interface DeleteSmsChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteSmsChannelResponse {
SMSChannelResponse: SMSChannelResponse;
}
export interface DeleteSmsTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface DeleteSmsTemplateResponse {
MessageBody: MessageBody;
}
export interface DeleteUserEndpointsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the user.
*/
UserId: __string;
}
export interface DeleteUserEndpointsResponse {
EndpointsResponse: EndpointsResponse;
}
export interface DeleteVoiceChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface DeleteVoiceChannelResponse {
VoiceChannelResponse: VoiceChannelResponse;
}
export interface DeleteVoiceTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface DeleteVoiceTemplateResponse {
MessageBody: MessageBody;
}
export type DeliveryStatus = "SUCCESSFUL"|"THROTTLED"|"TEMPORARY_FAILURE"|"PERMANENT_FAILURE"|"UNKNOWN_FAILURE"|"OPT_OUT"|"DUPLICATE"|string;
export type DimensionType = "INCLUSIVE"|"EXCLUSIVE"|string;
export interface DirectMessageConfiguration {
/**
* The default push notification message for the ADM (Amazon Device Messaging) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/
ADMMessage?: ADMMessage;
/**
* The default push notification message for the APNs (Apple Push Notification service) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/
APNSMessage?: APNSMessage;
/**
* The default push notification message for the Baidu (Baidu Cloud Push) channel. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/
BaiduMessage?: BaiduMessage;
/**
* The default message for all channels.
*/
DefaultMessage?: DefaultMessage;
/**
* The default push notification message for all push notification channels.
*/
DefaultPushNotificationMessage?: DefaultPushNotificationMessage;
/**
* The default message for the email channel. This message overrides the default message (DefaultMessage).
*/
EmailMessage?: EmailMessage;
/**
* The default push notification message for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message overrides the default push notification message (DefaultPushNotificationMessage).
*/
GCMMessage?: GCMMessage;
/**
* The default message for the SMS channel. This message overrides the default message (DefaultMessage).
*/
SMSMessage?: SMSMessage;
/**
* The default message for the voice channel. This message overrides the default message (DefaultMessage).
*/
VoiceMessage?: VoiceMessage;
}
export type Duration = "HR_24"|"DAY_7"|"DAY_14"|"DAY_30"|string;
export interface EmailChannelRequest {
/**
* The Amazon SES configuration set that you want to apply to messages that you send through the channel.
*/
ConfigurationSet?: __string;
/**
* Specifies whether to enable the email channel for the application.
*/
Enabled?: __boolean;
/**
* The verified email address that you want to send email from when you send email through the channel.
*/
FromAddress: __string;
/**
* The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that you want to use when you send email through the channel.
*/
Identity: __string;
/**
* The ARN of the AWS Identity and Access Management (IAM) role that you want Amazon Pinpoint to use when it submits email-related event data for the channel.
*/
RoleArn?: __string;
}
export interface EmailChannelResponse {
/**
* The unique identifier for the application that the email channel applies to.
*/
ApplicationId?: __string;
/**
* The Amazon SES configuration set that's applied to messages that are sent through the channel.
*/
ConfigurationSet?: __string;
/**
* The date and time, in ISO 8601 format, when the email channel was enabled.
*/
CreationDate?: __string;
/**
* Specifies whether the email channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* The verified email address that email is sent from when you send email through the channel.
*/
FromAddress?: __string;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* (Deprecated) An identifier for the email channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* The Amazon Resource Name (ARN) of the identity, verified with Amazon Simple Email Service (Amazon SES), that's used when you send email through the channel.
*/
Identity?: __string;
/**
* Specifies whether the email channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the email channel.
*/
LastModifiedBy?: __string;
/**
* The date and time, in ISO 8601 format, when the email channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The maximum number of emails that can be sent through the channel each second.
*/
MessagesPerSecond?: __integer;
/**
* The type of messaging or notification platform for the channel. For the email channel, this value is EMAIL.
*/
Platform: __string;
/**
* The ARN of the AWS Identity and Access Management (IAM) role that Amazon Pinpoint uses to submit email-related event data for the channel.
*/
RoleArn?: __string;
/**
* The current version of the email channel.
*/
Version?: __integer;
}
export interface EmailMessage {
/**
* The body of the email message.
*/
Body?: __string;
/**
* The email address to forward bounces and complaints to, if feedback forwarding is enabled.
*/
FeedbackForwardingAddress?: __string;
/**
* The verified email address to send the email message from. The default value is the FromAddress specified for the email channel.
*/
FromAddress?: __string;
/**
* The email message, represented as a raw MIME message.
*/
RawEmail?: RawEmail;
/**
* The reply-to email address(es) for the email message. If a recipient replies to the email, each reply-to address receives the reply.
*/
ReplyToAddresses?: ListOf__string;
/**
* The email message, composed of a subject, a text part, and an HTML part.
*/
SimpleEmail?: SimpleEmail;
/**
* The default message variables to use in the email message. You can override the default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
}
export interface EmailMessageActivity {
/**
* Specifies the sender address for an email message that's sent to participants in the journey.
*/
MessageConfig?: JourneyEmailMessage;
/**
* The unique identifier for the next activity to perform, after the message is sent.
*/
NextActivity?: __string;
/**
* The name of the email message template to use for the message. If specified, this value must match the name of an existing message template.
*/
TemplateName?: __string;
/**
* The unique identifier for the version of the email template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource. If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/
TemplateVersion?: __string;
}
export interface EmailTemplateRequest {
/**
* A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/
DefaultSubstitutions?: __string;
/**
* The message body, in HTML format, to use in email messages that are based on the message template. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
*/
HtmlPart?: __string;
/**
* The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
*/
RecommenderId?: __string;
/**
* The subject line, or title, to use in email messages that are based on the message template.
*/
Subject?: __string;
/**
* A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* A custom description of the message template.
*/
TemplateDescription?: __string;
/**
* The message body, in plain text format, to use in email messages that are based on the message template. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
*/
TextPart?: __string;
}
export interface EmailTemplateResponse {
/**
* The Amazon Resource Name (ARN) of the message template.
*/
Arn?: __string;
/**
* The date, in ISO 8601 format, when the message template was created.
*/
CreationDate: __string;
/**
* The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/
DefaultSubstitutions?: __string;
/**
* The message body, in HTML format, that's used in email messages that are based on the message template.
*/
HtmlPart?: __string;
/**
* The date, in ISO 8601 format, when the message template was last modified.
*/
LastModifiedDate: __string;
/**
* The unique identifier for the recommender model that's used by the message template.
*/
RecommenderId?: __string;
/**
* The subject line, or title, that's used in email messages that are based on the message template.
*/
Subject?: __string;
/**
* A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* The custom description of the message template.
*/
TemplateDescription?: __string;
/**
* The name of the message template.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. For an email template, this value is EMAIL.
*/
TemplateType: TemplateType;
/**
* The message body, in plain text format, that's used in email messages that are based on the message template.
*/
TextPart?: __string;
/**
* The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/
Version?: __string;
}
export interface EndpointBatchItem {
/**
* The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
*/
Address?: __string;
/**
* One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive. An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
*/
Attributes?: MapOfListOf__string;
/**
* The channel to use when sending messages or push notifications to the endpoint.
*/
ChannelType?: ChannelType;
/**
* The demographic information for the endpoint, such as the time zone and platform.
*/
Demographic?: EndpointDemographic;
/**
* The date and time, in ISO 8601 format, when the endpoint was created or updated.
*/
EffectiveDate?: __string;
/**
* Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/
EndpointStatus?: __string;
/**
* The unique identifier for the endpoint in the context of the batch.
*/
Id?: __string;
/**
* The geographic information for the endpoint.
*/
Location?: EndpointLocation;
/**
* One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/
Metrics?: MapOf__double;
/**
* Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/
OptOut?: __string;
/**
* The unique identifier for the request to create or update the endpoint.
*/
RequestId?: __string;
/**
* One or more custom attributes that describe the user who's associated with the endpoint.
*/
User?: EndpointUser;
}
export interface EndpointBatchRequest {
/**
* An array that defines the endpoints to create or update and, for each endpoint, the property values to set or change. An array can contain a maximum of 100 items.
*/
Item: ListOfEndpointBatchItem;
}
export interface EndpointDemographic {
/**
* The version of the app that's associated with the endpoint.
*/
AppVersion?: __string;
/**
* The locale of the endpoint, in the following format: the ISO 639-1 alpha-2 code, followed by an underscore (_), followed by an ISO 3166-1 alpha-2 value.
*/
Locale?: __string;
/**
* The manufacturer of the endpoint device, such as apple or samsung.
*/
Make?: __string;
/**
* The model name or number of the endpoint device, such as iPhone or SM-G900F.
*/
Model?: __string;
/**
* The model version of the endpoint device.
*/
ModelVersion?: __string;
/**
* The platform of the endpoint device, such as ios.
*/
Platform?: __string;
/**
* The platform version of the endpoint device.
*/
PlatformVersion?: __string;
/**
* The time zone of the endpoint, specified as a tz database name value, such as America/Los_Angeles.
*/
Timezone?: __string;
}
export interface EndpointItemResponse {
/**
* The custom message that's returned in the response as a result of processing the endpoint data.
*/
Message?: __string;
/**
* The status code that's returned in the response as a result of processing the endpoint data.
*/
StatusCode?: __integer;
}
export interface EndpointLocation {
/**
* The name of the city where the endpoint is located.
*/
City?: __string;
/**
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the endpoint is located. For example, US for the United States.
*/
Country?: __string;
/**
* The latitude coordinate of the endpoint location, rounded to one decimal place.
*/
Latitude?: __double;
/**
* The longitude coordinate of the endpoint location, rounded to one decimal place.
*/
Longitude?: __double;
/**
* The postal or ZIP code for the area where the endpoint is located.
*/
PostalCode?: __string;
/**
* The name of the region where the endpoint is located. For locations in the United States, this value is the name of a state.
*/
Region?: __string;
}
export interface EndpointMessageResult {
/**
* The endpoint address that the message was delivered to.
*/
Address?: __string;
/**
* The delivery status of the message. Possible values are: DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again. OPT_OUT - The user who's associated with the endpoint has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again. PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint. Amazon Pinpoint won't attempt to send the message again. SUCCESSFUL - The message was successfully delivered to the endpoint. TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again. THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint. TIMEOUT - The message couldn't be sent within the timeout period. UNKNOWN_FAILURE - An unknown error occurred.
*/
DeliveryStatus: DeliveryStatus;
/**
* The unique identifier for the message that was sent.
*/
MessageId?: __string;
/**
* The downstream service status code for delivering the message.
*/
StatusCode: __integer;
/**
* The status message for delivering the message.
*/
StatusMessage?: __string;
/**
* For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
*/
UpdatedToken?: __string;
}
export interface EndpointRequest {
/**
* The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For a push-notification channel, use the token provided by the push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. For the SMS channel, use a phone number in E.164 format, such as +12065550100. For the email channel, use an email address.
*/
Address?: __string;
/**
* One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive. An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
*/
Attributes?: MapOfListOf__string;
/**
* The channel to use when sending messages or push notifications to the endpoint.
*/
ChannelType?: ChannelType;
/**
* The demographic information for the endpoint, such as the time zone and platform.
*/
Demographic?: EndpointDemographic;
/**
* The date and time, in ISO 8601 format, when the endpoint is updated.
*/
EffectiveDate?: __string;
/**
* Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/
EndpointStatus?: __string;
/**
* The geographic information for the endpoint.
*/
Location?: EndpointLocation;
/**
* One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/
Metrics?: MapOf__double;
/**
* Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/
OptOut?: __string;
/**
* The unique identifier for the most recent request to update the endpoint.
*/
RequestId?: __string;
/**
* One or more custom attributes that describe the user who's associated with the endpoint.
*/
User?: EndpointUser;
}
export interface EndpointResponse {
/**
* The destination address for messages or push notifications that you send to the endpoint. The address varies by channel. For example, the address for a push-notification channel is typically the token provided by a push notification service, such as an Apple Push Notification service (APNs) device token or a Firebase Cloud Messaging (FCM) registration token. The address for the SMS channel is a phone number in E.164 format, such as +12065550100. The address for the email channel is an email address.
*/
Address?: __string;
/**
* The unique identifier for the application that's associated with the endpoint.
*/
ApplicationId?: __string;
/**
* One or more custom attributes that describe the endpoint by associating a name with an array of values. For example, the value of a custom attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments.
*/
Attributes?: MapOfListOf__string;
/**
* The channel that's used when sending messages or push notifications to the endpoint.
*/
ChannelType?: ChannelType;
/**
* A number from 0-99 that represents the cohort that the endpoint is assigned to. Endpoints are grouped into cohorts randomly, and each cohort contains approximately 1 percent of the endpoints for an application. Amazon Pinpoint assigns cohorts to the holdout or treatment allocations for campaigns.
*/
CohortId?: __string;
/**
* The date and time, in ISO 8601 format, when the endpoint was created.
*/
CreationDate?: __string;
/**
* The demographic information for the endpoint, such as the time zone and platform.
*/
Demographic?: EndpointDemographic;
/**
* The date and time, in ISO 8601 format, when the endpoint was last updated.
*/
EffectiveDate?: __string;
/**
* Specifies whether messages or push notifications are sent to the endpoint. Possible values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/
EndpointStatus?: __string;
/**
* The unique identifier that you assigned to the endpoint. The identifier should be a globally unique identifier (GUID) to ensure that it doesn't conflict with other endpoint identifiers that are associated with the application.
*/
Id?: __string;
/**
* The geographic information for the endpoint.
*/
Location?: EndpointLocation;
/**
* One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/
Metrics?: MapOf__double;
/**
* Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/
OptOut?: __string;
/**
* The unique identifier for the most recent request to update the endpoint.
*/
RequestId?: __string;
/**
* One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
*/
User?: EndpointUser;
}
export interface EndpointSendConfiguration {
/**
* The body of the message. If specified, this value overrides the default message body.
*/
BodyOverride?: __string;
/**
* A map of custom attributes to attach to the message for the address. Attribute names are case sensitive. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
*/
Context?: MapOf__string;
/**
* The raw, JSON-formatted string to use as the payload for the message. If specified, this value overrides all other values for the message.
*/
RawContent?: __string;
/**
* A map of the message variables to merge with the variables specified for the default message (DefaultMessage.Substitutions). The variables specified in this map take precedence over all other variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The title or subject line of the message. If specified, this value overrides the default message title or subject line.
*/
TitleOverride?: __string;
}
export interface EndpointUser {
/**
* One or more custom attributes that describe the user by associating a name with an array of values. For example, the value of an attribute named Interests might be: ["Science", "Music", "Travel"]. You can use these attributes as filter criteria when you create segments. Attribute names are case sensitive. An attribute name can contain up to 50 characters. An attribute value can contain up to 100 characters. When you define the name of a custom attribute, avoid using the following characters: number sign (#), colon (:), question mark (?), backslash (\), and slash (/). The Amazon Pinpoint console can't display attribute names that contain these characters. This restriction doesn't apply to attribute values.
*/
UserAttributes?: MapOfListOf__string;
/**
* The unique identifier for the user.
*/
UserId?: __string;
}
export interface EndpointsResponse {
/**
* An array of responses, one for each endpoint that's associated with the user ID.
*/
Item: ListOfEndpointResponse;
}
export interface Event {
/**
* The package name of the app that's recording the event.
*/
AppPackageName?: __string;
/**
* The title of the app that's recording the event.
*/
AppTitle?: __string;
/**
* The version number of the app that's recording the event.
*/
AppVersionCode?: __string;
/**
* One or more custom attributes that are associated with the event.
*/
Attributes?: MapOf__string;
/**
* The version of the SDK that's running on the client device.
*/
ClientSdkVersion?: __string;
/**
* The name of the event.
*/
EventType: __string;
/**
* One or more custom metrics that are associated with the event.
*/
Metrics?: MapOf__double;
/**
* The name of the SDK that's being used to record the event.
*/
SdkName?: __string;
/**
* Information about the session in which the event occurred.
*/
Session?: Session;
/**
* The date and time, in ISO 8601 format, when the event occurred.
*/
Timestamp: __string;
}
export interface EventCondition {
/**
* The dimensions for the event filter to use for the activity.
*/
Dimensions?: EventDimensions;
/**
* The message identifier (message_id) for the message to use when determining whether message events meet the condition.
*/
MessageActivity?: __string;
}
export interface EventDimensions {
/**
* One or more custom attributes that your application reports to Amazon Pinpoint. You can use these attributes as selection criteria when you create an event filter.
*/
Attributes?: MapOfAttributeDimension;
/**
* The name of the event that causes the campaign to be sent or the journey activity to be performed. This can be a standard event that Amazon Pinpoint generates, such as _email.delivered. For campaigns, this can also be a custom event that's specific to your application. For information about standard events, see Streaming Amazon Pinpoint Events in the Amazon Pinpoint Developer Guide.
*/
EventType?: SetDimension;
/**
* One or more custom metrics that your application reports to Amazon Pinpoint. You can use these metrics as selection criteria when you create an event filter.
*/
Metrics?: MapOfMetricDimension;
}
export interface EventFilter {
/**
* The dimensions for the event filter to use for the campaign or the journey activity.
*/
Dimensions: EventDimensions;
/**
* The type of event that causes the campaign to be sent or the journey activity to be performed. Valid values are: SYSTEM, sends the campaign or performs the activity when a system event occurs; and, ENDPOINT, sends the campaign or performs the activity when an endpoint event (Events resource) occurs.
*/
FilterType: FilterType;
}
export interface EventItemResponse {
/**
* A custom message that's returned in the response as a result of processing the event.
*/
Message?: __string;
/**
* The status code that's returned in the response as a result of processing the event. Possible values are: 202, for events that were accepted; and, 400, for events that weren't valid.
*/
StatusCode?: __integer;
}
export interface EventStartCondition {
EventFilter?: EventFilter;
SegmentId?: __string;
}
export interface EventStream {
/**
* The unique identifier for the application to publish event data for.
*/
ApplicationId: __string;
/**
* The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
*/
DestinationStreamArn: __string;
/**
* (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when publishing event data, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/
ExternalId?: __string;
/**
* The date, in ISO 8601 format, when the event stream was last modified.
*/
LastModifiedDate?: __string;
/**
* The IAM user who last modified the event stream.
*/
LastUpdatedBy?: __string;
/**
* The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
*/
RoleArn: __string;
}
export interface EventsBatch {
/**
* A set of properties and attributes that are associated with the endpoint.
*/
Endpoint: PublicEndpoint;
/**
* A set of properties that are associated with the event.
*/
Events: MapOfEvent;
}
export interface EventsRequest {
/**
* The batch of events to process. For each item in a batch, the endpoint ID acts as a key that has an EventsBatch object as its value.
*/
BatchItem: MapOfEventsBatch;
}
export interface EventsResponse {
/**
* A map that contains a multipart response for each endpoint. For each item in this object, the endpoint ID is the key and the item response is the value. If no item response exists, the value can also be one of the following: 202, the request was processed successfully; or 400, the payload wasn't valid or required fields were missing.
*/
Results?: MapOfItemResponse;
}
export interface ExportJobRequest {
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location where you want to export endpoint definitions to.
*/
RoleArn: __string;
/**
* The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where you want to export endpoint definitions to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
*/
S3UrlPrefix: __string;
/**
* The identifier for the segment to export endpoint definitions from. If you don't specify this value, Amazon Pinpoint exports definitions for all the endpoints that are associated with the application.
*/
SegmentId?: __string;
/**
* The version of the segment to export endpoint definitions from, if specified.
*/
SegmentVersion?: __integer;
}
export interface ExportJobResource {
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location where the endpoint definitions were exported to.
*/
RoleArn: __string;
/**
* The URL of the location in an Amazon Simple Storage Service (Amazon S3) bucket where the endpoint definitions were exported to. This location is typically a folder that contains multiple files. The URL should be in the following format: s3://bucket-name/folder-name/.
*/
S3UrlPrefix: __string;
/**
* The identifier for the segment that the endpoint definitions were exported from. If this value isn't present, Amazon Pinpoint exported definitions for all the endpoints that are associated with the application.
*/
SegmentId?: __string;
/**
* The version of the segment that the endpoint definitions were exported from.
*/
SegmentVersion?: __integer;
}
export interface ExportJobResponse {
/**
* The unique identifier for the application that's associated with the export job.
*/
ApplicationId: __string;
/**
* The number of pieces that were processed successfully (completed) by the export job, as of the time of the request.
*/
CompletedPieces?: __integer;
/**
* The date, in ISO 8601 format, when the export job was completed.
*/
CompletionDate?: __string;
/**
* The date, in ISO 8601 format, when the export job was created.
*/
CreationDate: __string;
/**
* The resource settings that apply to the export job.
*/
Definition: ExportJobResource;
/**
* The number of pieces that weren't processed successfully (failed) by the export job, as of the time of the request.
*/
FailedPieces?: __integer;
/**
* An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the export job, if any.
*/
Failures?: ListOf__string;
/**
* The unique identifier for the export job.
*/
Id: __string;
/**
* The status of the export job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
*/
JobStatus: JobStatus;
/**
* The total number of endpoint definitions that weren't processed successfully (failed) by the export job, typically because an error, such as a syntax error, occurred.
*/
TotalFailures?: __integer;
/**
* The total number of pieces that must be processed to complete the export job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the export job.
*/
TotalPieces?: __integer;
/**
* The total number of endpoint definitions that were processed by the export job.
*/
TotalProcessed?: __integer;
/**
* The job type. This value is EXPORT for export jobs.
*/
Type: __string;
}
export interface ExportJobsResponse {
/**
* An array of responses, one for each export job that's associated with the application (Export Jobs resource) or segment (Segment Export Jobs resource).
*/
Item: ListOfExportJobResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export type FilterType = "SYSTEM"|"ENDPOINT"|string;
export type Format = "CSV"|"JSON"|string;
export type Frequency = "ONCE"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|"EVENT"|string;
export interface GCMChannelRequest {
/**
* The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
*/
ApiKey: __string;
/**
* Specifies whether to enable the GCM channel for the application.
*/
Enabled?: __boolean;
}
export interface GCMChannelResponse {
/**
* The unique identifier for the application that the GCM channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time when the GCM channel was enabled.
*/
CreationDate?: __string;
/**
* The Web API Key, also referred to as an API_KEY or server key, that you received from Google to communicate with Google services.
*/
Credential: __string;
/**
* Specifies whether the GCM channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* (Deprecated) An identifier for the GCM channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the GCM channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the GCM channel.
*/
LastModifiedBy?: __string;
/**
* The date and time when the GCM channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the GCM channel, this value is GCM.
*/
Platform: __string;
/**
* The current version of the GCM channel.
*/
Version?: __integer;
}
export interface GCMMessage {
/**
* The action to occur if the recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This action uses the deep-linking features of the Android platform. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The body of the notification message.
*/
Body?: __string;
/**
* An arbitrary string that identifies a group of messages that can be collapsed to ensure that only the last message is sent when delivery can resume. This helps avoid sending too many instances of the same messages when the recipient's device comes online again or becomes active. Amazon Pinpoint specifies this value in the Firebase Cloud Messaging (FCM) collapse_key parameter when it sends the notification message to FCM.
*/
CollapseKey?: __string;
/**
* The JSON data payload to use for the push notification, if the notification is a silent push notification. This payload is added to the data.pinpoint.jsonBody object of the notification.
*/
Data?: MapOf__string;
/**
* The icon image name of the asset saved in your app.
*/
IconReference?: __string;
/**
* The URL of the large icon image to display in the content view of the push notification.
*/
ImageIconUrl?: __string;
/**
* The URL of an image to display in the push notification.
*/
ImageUrl?: __string;
/**
* para>normal - The notification might be delayed. Delivery is optimized for battery usage on the recipient's device. Use this value unless immediate delivery is required./listitem> high - The notification is sent immediately and might wake a sleeping device./para> Amazon Pinpoint specifies this value in the FCM priority parameter when it sends the notification message to FCM. The equivalent values for Apple Push Notification service (APNs) are 5, for normal, and 10, for high. If you specify an APNs value for this property, Amazon Pinpoint accepts and converts the value to the corresponding FCM value.
*/
Priority?: __string;
/**
* The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
*/
RawContent?: __string;
/**
* The package name of the application where registration tokens must match in order for the recipient to receive the message.
*/
RestrictedPackageName?: __string;
/**
* Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration or supporting phone home functionality.
*/
SilentPush?: __boolean;
/**
* The URL of the small icon image to display in the status bar and the content view of the push notification.
*/
SmallImageIconUrl?: __string;
/**
* The sound to play when the recipient receives the push notification. You can use the default stream or specify the file name of a sound resource that's bundled in your app. On an Android platform, the sound file must reside in /res/raw/.
*/
Sound?: __string;
/**
* The default message variables to use in the notification message. You can override the default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The amount of time, in seconds, that FCM should store and attempt to deliver the push notification, if the service is unable to deliver the notification the first time. If you don't specify this value, FCM defaults to the maximum value, which is 2,419,200 seconds (28 days). Amazon Pinpoint specifies this value in the FCM time_to_live parameter when it sends the notification message to FCM.
*/
TimeToLive?: __integer;
/**
* The title to display above the notification message on the recipient's device.
*/
Title?: __string;
/**
* The URL to open in the recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/
Url?: __string;
}
export interface GPSCoordinates {
/**
* The latitude coordinate of the location.
*/
Latitude: __double;
/**
* The longitude coordinate of the location.
*/
Longitude: __double;
}
export interface GPSPointDimension {
/**
* The GPS coordinates to measure distance from.
*/
Coordinates: GPSCoordinates;
/**
* The range, in kilometers, from the GPS coordinates.
*/
RangeInKilometers?: __double;
}
export interface GetAdmChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetAdmChannelResponse {
ADMChannelResponse: ADMChannelResponse;
}
export interface GetApnsChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetApnsChannelResponse {
APNSChannelResponse: APNSChannelResponse;
}
export interface GetApnsSandboxChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetApnsSandboxChannelResponse {
APNSSandboxChannelResponse: APNSSandboxChannelResponse;
}
export interface GetApnsVoipChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetApnsVoipChannelResponse {
APNSVoipChannelResponse: APNSVoipChannelResponse;
}
export interface GetApnsVoipSandboxChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetApnsVoipSandboxChannelResponse {
APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
}
export interface GetAppRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetAppResponse {
ApplicationResponse: ApplicationResponse;
}
export interface GetApplicationDateRangeKpiRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
*/
EndTime?: __timestampIso8601;
/**
* The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
*/
KpiName: __string;
/**
* The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
NextToken?: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
*/
StartTime?: __timestampIso8601;
}
export interface GetApplicationDateRangeKpiResponse {
ApplicationDateRangeKpiResponse: ApplicationDateRangeKpiResponse;
}
export interface GetApplicationSettingsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetApplicationSettingsResponse {
ApplicationSettingsResource: ApplicationSettingsResource;
}
export interface GetAppsRequest {
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetAppsResponse {
ApplicationsResponse: ApplicationsResponse;
}
export interface GetBaiduChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetBaiduChannelResponse {
BaiduChannelResponse: BaiduChannelResponse;
}
export interface GetCampaignActivitiesRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign.
*/
CampaignId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetCampaignActivitiesResponse {
ActivitiesResponse: ActivitiesResponse;
}
export interface GetCampaignDateRangeKpiRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign.
*/
CampaignId: __string;
/**
* The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
*/
EndTime?: __timestampIso8601;
/**
* The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
*/
KpiName: __string;
/**
* The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
NextToken?: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
*/
StartTime?: __timestampIso8601;
}
export interface GetCampaignDateRangeKpiResponse {
CampaignDateRangeKpiResponse: CampaignDateRangeKpiResponse;
}
export interface GetCampaignRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign.
*/
CampaignId: __string;
}
export interface GetCampaignResponse {
CampaignResponse: CampaignResponse;
}
export interface GetCampaignVersionRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign.
*/
CampaignId: __string;
/**
* The unique version number (Version property) for the campaign version.
*/
Version: __string;
}
export interface GetCampaignVersionResponse {
CampaignResponse: CampaignResponse;
}
export interface GetCampaignVersionsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign.
*/
CampaignId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetCampaignVersionsResponse {
CampaignsResponse: CampaignsResponse;
}
export interface GetCampaignsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetCampaignsResponse {
CampaignsResponse: CampaignsResponse;
}
export interface GetChannelsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetChannelsResponse {
ChannelsResponse: ChannelsResponse;
}
export interface GetEmailChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetEmailChannelResponse {
EmailChannelResponse: EmailChannelResponse;
}
export interface GetEmailTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface GetEmailTemplateResponse {
EmailTemplateResponse: EmailTemplateResponse;
}
export interface GetEndpointRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the endpoint.
*/
EndpointId: __string;
}
export interface GetEndpointResponse {
EndpointResponse: EndpointResponse;
}
export interface GetEventStreamRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetEventStreamResponse {
EventStream: EventStream;
}
export interface GetExportJobRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the job.
*/
JobId: __string;
}
export interface GetExportJobResponse {
ExportJobResponse: ExportJobResponse;
}
export interface GetExportJobsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetExportJobsResponse {
ExportJobsResponse: ExportJobsResponse;
}
export interface GetGcmChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetGcmChannelResponse {
GCMChannelResponse: GCMChannelResponse;
}
export interface GetImportJobRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the job.
*/
JobId: __string;
}
export interface GetImportJobResponse {
ImportJobResponse: ImportJobResponse;
}
export interface GetImportJobsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetImportJobsResponse {
ImportJobsResponse: ImportJobsResponse;
}
export interface GetJourneyDateRangeKpiRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The last date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-26T20:00:00Z for 8:00 PM UTC July 26, 2019.
*/
EndTime?: __timestampIso8601;
/**
* The unique identifier for the journey.
*/
JourneyId: __string;
/**
* The name of the metric, also referred to as a key performance indicator (KPI), to retrieve data for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. Examples are email-open-rate and successful-delivery-rate. For a list of valid values, see the Amazon Pinpoint Developer Guide.
*/
KpiName: __string;
/**
* The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
NextToken?: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The first date and time to retrieve data for, as part of an inclusive date range that filters the query results. This value should be in extended ISO 8601 format and use Coordinated Universal Time (UTC), for example: 2019-07-19T20:00:00Z for 8:00 PM UTC July 19, 2019. This value should also be fewer than 90 days from the current day.
*/
StartTime?: __timestampIso8601;
}
export interface GetJourneyDateRangeKpiResponse {
JourneyDateRangeKpiResponse: JourneyDateRangeKpiResponse;
}
export interface GetJourneyExecutionActivityMetricsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the journey activity.
*/
JourneyActivityId: __string;
/**
* The unique identifier for the journey.
*/
JourneyId: __string;
/**
* The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
NextToken?: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
}
export interface GetJourneyExecutionActivityMetricsResponse {
JourneyExecutionActivityMetricsResponse: JourneyExecutionActivityMetricsResponse;
}
export interface GetJourneyExecutionMetricsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the journey.
*/
JourneyId: __string;
/**
* The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
NextToken?: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
}
export interface GetJourneyExecutionMetricsResponse {
JourneyExecutionMetricsResponse: JourneyExecutionMetricsResponse;
}
export interface GetJourneyRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the journey.
*/
JourneyId: __string;
}
export interface GetJourneyResponse {
JourneyResponse: JourneyResponse;
}
export interface GetPushTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface GetPushTemplateResponse {
PushNotificationTemplateResponse: PushNotificationTemplateResponse;
}
export interface GetRecommenderConfigurationRequest {
/**
* The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
*/
RecommenderId: __string;
}
export interface GetRecommenderConfigurationResponse {
RecommenderConfigurationResponse: RecommenderConfigurationResponse;
}
export interface GetRecommenderConfigurationsRequest {
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetRecommenderConfigurationsResponse {
ListRecommenderConfigurationsResponse: ListRecommenderConfigurationsResponse;
}
export interface GetSegmentExportJobsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The unique identifier for the segment.
*/
SegmentId: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetSegmentExportJobsResponse {
ExportJobsResponse: ExportJobsResponse;
}
export interface GetSegmentImportJobsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The unique identifier for the segment.
*/
SegmentId: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetSegmentImportJobsResponse {
ImportJobsResponse: ImportJobsResponse;
}
export interface GetSegmentRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the segment.
*/
SegmentId: __string;
}
export interface GetSegmentResponse {
SegmentResponse: SegmentResponse;
}
export interface GetSegmentVersionRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the segment.
*/
SegmentId: __string;
/**
* The unique version number (Version property) for the campaign version.
*/
Version: __string;
}
export interface GetSegmentVersionResponse {
SegmentResponse: SegmentResponse;
}
export interface GetSegmentVersionsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The unique identifier for the segment.
*/
SegmentId: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetSegmentVersionsResponse {
SegmentsResponse: SegmentsResponse;
}
export interface GetSegmentsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface GetSegmentsResponse {
SegmentsResponse: SegmentsResponse;
}
export interface GetSmsChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetSmsChannelResponse {
SMSChannelResponse: SMSChannelResponse;
}
export interface GetSmsTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface GetSmsTemplateResponse {
SMSTemplateResponse: SMSTemplateResponse;
}
export interface GetUserEndpointsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the user.
*/
UserId: __string;
}
export interface GetUserEndpointsResponse {
EndpointsResponse: EndpointsResponse;
}
export interface GetVoiceChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface GetVoiceChannelResponse {
VoiceChannelResponse: VoiceChannelResponse;
}
export interface GetVoiceTemplateRequest {
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface GetVoiceTemplateResponse {
VoiceTemplateResponse: VoiceTemplateResponse;
}
export interface HoldoutActivity {
/**
* The unique identifier for the next activity to perform, after performing the holdout activity.
*/
NextActivity?: __string;
/**
* The percentage of participants who shouldn't continue the journey. To determine which participants are held out, Amazon Pinpoint applies a probability-based algorithm to the percentage that you specify. Therefore, the actual percentage of participants who are held out may not be equal to the percentage that you specify.
*/
Percentage: __integer;
}
export interface ImportJobRequest {
/**
* Specifies whether to create a segment that contains the endpoints, when the endpoint definitions are imported.
*/
DefineSegment?: __boolean;
/**
* (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/
ExternalId?: __string;
/**
* The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the Amazon S3 location stores multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
*/
Format: Format;
/**
* Specifies whether to register the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
*/
RegisterEndpoints?: __boolean;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
*/
RoleArn: __string;
/**
* The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
*/
S3Url: __string;
/**
* The identifier for the segment to update or add the imported endpoint definitions to, if the import job is meant to update an existing segment.
*/
SegmentId?: __string;
/**
* A custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
*/
SegmentName?: __string;
}
export interface ImportJobResource {
/**
* Specifies whether the import job creates a segment that contains the endpoints, when the endpoint definitions are imported.
*/
DefineSegment?: __boolean;
/**
* (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/
ExternalId?: __string;
/**
* The format of the files that contain the endpoint definitions to import. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format. If the files are stored in an Amazon S3 location and that location contains multiple files that use different formats, Amazon Pinpoint imports data only from the files that use the specified format.
*/
Format: Format;
/**
* Specifies whether the import job registers the endpoints with Amazon Pinpoint, when the endpoint definitions are imported.
*/
RegisterEndpoints?: __boolean;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
*/
RoleArn: __string;
/**
* The URL of the Amazon Simple Storage Service (Amazon S3) bucket that contains the endpoint definitions to import. This location can be a folder or a single file. If the location is a folder, Amazon Pinpoint imports endpoint definitions from the files in this location, including any subfolders that the folder contains. The URL should be in the following format: s3://bucket-name/folder-name/file-name. The location can end with the key for an individual object or a prefix that qualifies multiple objects.
*/
S3Url: __string;
/**
* The identifier for the segment that the import job updates or adds endpoint definitions to, if the import job updates an existing segment.
*/
SegmentId?: __string;
/**
* The custom name for the segment that's created by the import job, if the value of the DefineSegment property is true.
*/
SegmentName?: __string;
}
export interface ImportJobResponse {
/**
* The unique identifier for the application that's associated with the import job.
*/
ApplicationId: __string;
/**
* The number of pieces that were processed successfully (completed) by the import job, as of the time of the request.
*/
CompletedPieces?: __integer;
/**
* The date, in ISO 8601 format, when the import job was completed.
*/
CompletionDate?: __string;
/**
* The date, in ISO 8601 format, when the import job was created.
*/
CreationDate: __string;
/**
* The resource settings that apply to the import job.
*/
Definition: ImportJobResource;
/**
* The number of pieces that weren't processed successfully (failed) by the import job, as of the time of the request.
*/
FailedPieces?: __integer;
/**
* An array of entries, one for each of the first 100 entries that weren't processed successfully (failed) by the import job, if any.
*/
Failures?: ListOf__string;
/**
* The unique identifier for the import job.
*/
Id: __string;
/**
* The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
*/
JobStatus: JobStatus;
/**
* The total number of endpoint definitions that weren't processed successfully (failed) by the import job, typically because an error, such as a syntax error, occurred.
*/
TotalFailures?: __integer;
/**
* The total number of pieces that must be processed to complete the import job. Each piece consists of an approximately equal portion of the endpoint definitions that are part of the import job.
*/
TotalPieces?: __integer;
/**
* The total number of endpoint definitions that were processed by the import job.
*/
TotalProcessed?: __integer;
/**
* The job type. This value is IMPORT for import jobs.
*/
Type: __string;
}
export interface ImportJobsResponse {
/**
* An array of responses, one for each import job that's associated with the application (Import Jobs resource) or segment (Segment Import Jobs resource).
*/
Item: ListOfImportJobResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export type Include = "ALL"|"ANY"|"NONE"|string;
export interface ItemResponse {
/**
* The response that was received after the endpoint data was accepted.
*/
EndpointItemResponse?: EndpointItemResponse;
/**
* A multipart response object that contains a key and a value for each event in the request. In each object, the event ID is the key and an EventItemResponse object is the value.
*/
EventsItemResponse?: MapOfEventItemResponse;
}
export type JobStatus = "CREATED"|"PREPARING_FOR_INITIALIZATION"|"INITIALIZING"|"PROCESSING"|"PENDING_JOB"|"COMPLETING"|"COMPLETED"|"FAILING"|"FAILED"|string;
export interface JourneyCustomMessage {
/**
* The message content that's passed to an AWS Lambda function or to a web hook.
*/
Data?: __string;
}
export interface JourneyDateRangeKpiResponse {
/**
* The unique identifier for the application that the metric applies to.
*/
ApplicationId: __string;
/**
* The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/
EndTime: __timestampIso8601;
/**
* The unique identifier for the journey that the metric applies to.
*/
JourneyId: __string;
/**
* The name of the metric, also referred to as a key performance indicator (KPI), that the data was retrieved for. This value describes the associated metric and consists of two or more terms, which are comprised of lowercase alphanumeric characters, separated by a hyphen. For a list of possible values, see the Amazon Pinpoint Developer Guide.
*/
KpiName: __string;
/**
* An array of objects that contains the results of the query. Each object contains the value for the metric and metadata about that value.
*/
KpiResult: BaseKpiResult;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null for the Journey Engagement Metrics resource because the resource returns all results in a single page.
*/
NextToken?: __string;
/**
* The first date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
*/
StartTime: __timestampIso8601;
}
export interface JourneyEmailMessage {
/**
* The verified email address to send the email message from. The default address is the FromAddress specified for the email channel for the application.
*/
FromAddress?: __string;
}
export interface JourneyExecutionActivityMetricsResponse {
/**
* The type of activity that the metric applies to. Possible values are: CONDITIONAL_SPLIT - For a yes/no split activity, which is an activity that sends participants down one of two paths in a journey. HOLDOUT - For a holdout activity, which is an activity that stops a journey for a specified percentage of participants. MESSAGE - For an email activity, which is an activity that sends an email message to participants. MULTI_CONDITIONAL_SPLIT - For a multivariate split activity, which is an activity that sends participants down one of as many as five paths in a journey. RANDOM_SPLIT - For a random split activity, which is an activity that sends specified percentages of participants down one of as many as five paths in a journey. WAIT - For a wait activity, which is an activity that waits for a certain amount of time or until a specific date and time before moving participants to the next activity in a journey.
*/
ActivityType: __string;
/**
* The unique identifier for the application that the metric applies to.
*/
ApplicationId: __string;
/**
* The unique identifier for the activity that the metric applies to.
*/
JourneyActivityId: __string;
/**
* The unique identifier for the journey that the metric applies to.
*/
JourneyId: __string;
/**
* The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the execution status of the activity and updated the data for the metric.
*/
LastEvaluatedTime: __string;
/**
* A JSON object that contains the results of the query. The results vary depending on the type of activity (ActivityType). For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
*/
Metrics: MapOf__string;
}
export interface JourneyExecutionMetricsResponse {
/**
* The unique identifier for the application that the metric applies to.
*/
ApplicationId: __string;
/**
* The unique identifier for the journey that the metric applies to.
*/
JourneyId: __string;
/**
* The date and time, in ISO 8601 format, when Amazon Pinpoint last evaluated the journey and updated the data for the metric.
*/
LastEvaluatedTime: __string;
/**
* A JSON object that contains the results of the query. For information about the structure and contents of the results, see the Amazon Pinpoint Developer Guide.
*/
Metrics: MapOf__string;
}
export interface JourneyLimits {
/**
* The maximum number of messages that the journey can send to a single participant during a 24-hour period. The maximum value is 100.
*/
DailyCap?: __integer;
/**
* The maximum number of times that a participant can enter the journey. The maximum value is 100. To allow participants to enter the journey an unlimited number of times, set this value to 0.
*/
EndpointReentryCap?: __integer;
/**
* The maximum number of messages that the journey can send each second.
*/
MessagesPerSecond?: __integer;
}
export interface JourneyPushMessage {
/**
* The number of seconds that the push notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
*/
TimeToLive?: __string;
}
export interface JourneyResponse {
/**
* A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity.
*/
Activities?: MapOfActivity;
/**
* The unique identifier for the application that the journey applies to.
*/
ApplicationId: __string;
/**
* The date, in ISO 8601 format, when the journey was created.
*/
CreationDate?: __string;
/**
* The unique identifier for the journey.
*/
Id: __string;
/**
* The date, in ISO 8601 format, when the journey was last modified.
*/
LastModifiedDate?: __string;
/**
* The messaging and entry limits for the journey.
*/
Limits?: JourneyLimits;
/**
* Specifies whether the journey's scheduled start and end times use each participant's local time. If this value is true, the schedule uses each participant's local time.
*/
LocalTime?: __boolean;
/**
* The name of the journey.
*/
Name: __string;
/**
* The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value. The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey. The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey. If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
*/
QuietTime?: QuietTime;
/**
* The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
*/
RefreshFrequency?: __string;
/**
* The schedule settings for the journey.
*/
Schedule?: JourneySchedule;
/**
* The unique identifier for the first activity in the journey.
*/
StartActivity?: __string;
/**
* The segment that defines which users are participants in the journey.
*/
StartCondition?: StartCondition;
/**
* The current status of the journey. Possible values are: DRAFT - The journey is being developed and hasn't been published yet. ACTIVE - The journey has been developed and published. Depending on the journey's schedule, the journey may currently be running or scheduled to start running at a later time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it. COMPLETED - The journey has been published and has finished running. All participants have entered the journey and no participants are waiting to complete the journey or any activities in the journey. CANCELLED - The journey has been stopped. If a journey's status is CANCELLED, you can't add, change, or remove activities or segment settings from the journey. CLOSED - The journey has been published and has started running. It may have also passed its scheduled end time, or passed its scheduled start time and a refresh frequency hasn't been specified for it. If a journey's status is CLOSED, you can't add participants to it, and no existing participants can enter the journey for the first time. However, any existing participants who are currently waiting to start an activity may continue the journey.
*/
State?: State;
/**
* This object is not used or supported.
*/
tags?: MapOf__string;
}
export interface JourneySMSMessage {
/**
* The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
*/
MessageType?: MessageType;
/**
* The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region. For more information, see Supported Countries and Regions in the Amazon Pinpoint User Guide.
*/
SenderId?: __string;
}
export interface JourneySchedule {
/**
* The scheduled time, in ISO 8601 format, when the journey ended or will end.
*/
EndTime?: __timestampIso8601;
/**
* The scheduled time, in ISO 8601 format, when the journey began or will begin.
*/
StartTime?: __timestampIso8601;
/**
* The starting UTC offset for the journey schedule, if the value of the journey's LocalTime property is true. Valid values are: UTC,
UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05, UTC+05:30,
UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+08:45, UTC+09, UTC+09:30,
UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+12:45, UTC+13, UTC+13:45, UTC-02,
UTC-02:30, UTC-03, UTC-03:30, UTC-04, UTC-05, UTC-06, UTC-07, UTC-08, UTC-09,
UTC-09:30, UTC-10, and UTC-11.
*/
Timezone?: __string;
}
export interface JourneyStateRequest {
/**
* The status of the journey. Currently, the only supported value is CANCELLED. If you cancel a journey, Amazon Pinpoint continues to perform activities that are currently in progress, until those activities are complete. Amazon Pinpoint also continues to collect and aggregate analytics data for those activities, until they are complete, and any activities that were complete when you cancelled the journey. After you cancel a journey, you can't add, change, or remove any activities from the journey. In addition, Amazon Pinpoint stops evaluating the journey and doesn't perform any activities that haven't started.
*/
State?: State;
}
export interface JourneysResponse {
/**
* An array of responses, one for each journey that's associated with the application.
*/
Item: ListOfJourneyResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export interface ListJourneysRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The NextToken string that specifies which page of results to return in a paginated response.
*/
Token?: __string;
}
export interface ListJourneysResponse {
JourneysResponse: JourneysResponse;
}
export interface ListRecommenderConfigurationsResponse {
/**
* An array of responses, one for each recommender model configuration that's associated with your Amazon Pinpoint account.
*/
Item: ListOfRecommenderConfigurationResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export interface ListTagsForResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn: __string;
}
export interface ListTagsForResourceResponse {
TagsModel: TagsModel;
}
export interface ListTemplateVersionsRequest {
/**
* The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
NextToken?: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
*/
TemplateType: __string;
}
export interface ListTemplateVersionsResponse {
TemplateVersionsResponse: TemplateVersionsResponse;
}
export interface ListTemplatesRequest {
/**
* The string that specifies which page of results to return in a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
NextToken?: __string;
/**
* The maximum number of items to include in each page of a paginated response. This parameter is not supported for application, campaign, and journey metrics.
*/
PageSize?: __string;
/**
* The substring to match in the names of the message templates to include in the results. If you specify this value, Amazon Pinpoint returns only those templates whose names begin with the value that you specify.
*/
Prefix?: __string;
/**
* The type of message template to include in the results. Valid values are: EMAIL, PUSH, SMS, and VOICE. To include all types of templates in the results, don't include this parameter in your request.
*/
TemplateType?: __string;
}
export interface ListTemplatesResponse {
TemplatesResponse: TemplatesResponse;
}
export interface Message {
/**
* The action to occur if a recipient taps the push notification. Valid values are: OPEN_APP - Your app opens or it becomes the foreground app if it was sent to the background. This is the default action. DEEP_LINK - Your app opens and displays a designated user interface in the app. This setting uses the deep-linking features of iOS and Android. URL - The default mobile browser on the recipient's device opens and loads the web page at a URL that you specify.
*/
Action?: Action;
/**
* The body of the notification message. The maximum number of characters is 200.
*/
Body?: __string;
/**
* The URL of the image to display as the push-notification icon, such as the icon for the app.
*/
ImageIconUrl?: __string;
/**
* The URL of the image to display as the small, push-notification icon, such as a small version of the icon for the app.
*/
ImageSmallIconUrl?: __string;
/**
* The URL of an image to display in the push notification.
*/
ImageUrl?: __string;
/**
* The JSON payload to use for a silent push notification.
*/
JsonBody?: __string;
/**
* The URL of the image or video to display in the push notification.
*/
MediaUrl?: __string;
/**
* The raw, JSON-formatted string to use as the payload for the notification message. If specified, this value overrides all other content for the message.
*/
RawContent?: __string;
/**
* Specifies whether the notification is a silent push notification, which is a push notification that doesn't display on a recipient's device. Silent push notifications can be used for cases such as updating an app's configuration, displaying messages in an in-app message center, or supporting phone home functionality.
*/
SilentPush?: __boolean;
/**
* The number of seconds that the push-notification service should keep the message, if the service is unable to deliver the notification the first time. This value is converted to an expiration value when it's sent to a push-notification service. If this value is 0, the service treats the notification as if it expires immediately and the service doesn't store or try to deliver the notification again. This value doesn't apply to messages that are sent through the Amazon Device Messaging (ADM) service.
*/
TimeToLive?: __integer;
/**
* The title to display above the notification message on a recipient's device.
*/
Title?: __string;
/**
* The URL to open in a recipient's default mobile browser, if a recipient taps the push notification and the value of the Action property is URL.
*/
Url?: __string;
}
export interface MessageBody {
/**
* The message that's returned from the API.
*/
Message?: __string;
/**
* The unique identifier for the request or response.
*/
RequestID?: __string;
}
export interface MessageConfiguration {
/**
* The message that the campaign sends through the ADM (Amazon Device Messaging) channel. If specified, this message overrides the default message.
*/
ADMMessage?: Message;
/**
* The message that the campaign sends through the APNs (Apple Push Notification service) channel. If specified, this message overrides the default message.
*/
APNSMessage?: Message;
/**
* The message that the campaign sends through the Baidu (Baidu Cloud Push) channel. If specified, this message overrides the default message.
*/
BaiduMessage?: Message;
/**
* The message that the campaign sends through a custom channel, as specified by the delivery configuration (CustomDeliveryConfiguration) settings for the campaign. If specified, this message overrides the default message.
*/
CustomMessage?: CampaignCustomMessage;
/**
* The default message that the campaign sends through all the channels that are configured for the campaign.
*/
DefaultMessage?: Message;
/**
* The message that the campaign sends through the email channel. If specified, this message overrides the default message.
*/
EmailMessage?: CampaignEmailMessage;
/**
* The message that the campaign sends through the GCM channel, which enables Amazon Pinpoint to send push notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. If specified, this message overrides the default message.
*/
GCMMessage?: Message;
/**
* The message that the campaign sends through the SMS channel. If specified, this message overrides the default message.
*/
SMSMessage?: CampaignSmsMessage;
}
export interface MessageRequest {
/**
* A map of key-value pairs, where each key is an address and each value is an AddressConfiguration object. An address can be a push notification token, a phone number, or an email address. You can use an AddressConfiguration object to tailor the message for an address by specifying settings such as content overrides and message variables.
*/
Addresses?: MapOfAddressConfiguration;
/**
* A map of custom attributes to attach to the message. For a push notification, this payload is added to the data.pinpoint object. For an email or text message, this payload is added to email/SMS delivery receipt event attributes.
*/
Context?: MapOf__string;
/**
* A map of key-value pairs, where each key is an endpoint ID and each value is an EndpointSendConfiguration object. You can use an EndpointSendConfiguration object to tailor the message for an endpoint by specifying settings such as content overrides and message variables.
*/
Endpoints?: MapOfEndpointSendConfiguration;
/**
* The settings and content for the default message and any default messages that you defined for specific channels.
*/
MessageConfiguration: DirectMessageConfiguration;
/**
* The message template to use for the message.
*/
TemplateConfiguration?: TemplateConfiguration;
/**
* The unique identifier for tracing the message. This identifier is visible to message recipients.
*/
TraceId?: __string;
}
export interface MessageResponse {
/**
* The unique identifier for the application that was used to send the message.
*/
ApplicationId: __string;
/**
* A map that contains a multipart response for each address that the message was sent to. In the map, the endpoint ID is the key and the result is the value.
*/
EndpointResult?: MapOfEndpointMessageResult;
/**
* The identifier for the original request that the message was delivered for.
*/
RequestId?: __string;
/**
* A map that contains a multipart response for each address (email address, phone number, or push notification token) that the message was sent to. In the map, the address is the key and the result is the value.
*/
Result?: MapOfMessageResult;
}
export interface MessageResult {
/**
* The delivery status of the message. Possible values are: DUPLICATE - The endpoint address is a duplicate of another endpoint address. Amazon Pinpoint won't attempt to send the message again. OPT_OUT - The user who's associated with the endpoint address has opted out of receiving messages from you. Amazon Pinpoint won't attempt to send the message again. PERMANENT_FAILURE - An error occurred when delivering the message to the endpoint address. Amazon Pinpoint won't attempt to send the message again. SUCCESSFUL - The message was successfully delivered to the endpoint address. TEMPORARY_FAILURE - A temporary error occurred. Amazon Pinpoint won't attempt to send the message again. THROTTLED - Amazon Pinpoint throttled the operation to send the message to the endpoint address. TIMEOUT - The message couldn't be sent within the timeout period. UNKNOWN_FAILURE - An unknown error occurred.
*/
DeliveryStatus: DeliveryStatus;
/**
* The unique identifier for the message that was sent.
*/
MessageId?: __string;
/**
* The downstream service status code for delivering the message.
*/
StatusCode: __integer;
/**
* The status message for delivering the message.
*/
StatusMessage?: __string;
/**
* For push notifications that are sent through the GCM channel, specifies whether the endpoint's device registration token was updated as part of delivering the message.
*/
UpdatedToken?: __string;
}
export type MessageType = "TRANSACTIONAL"|"PROMOTIONAL"|string;
export interface MetricDimension {
/**
* The operator to use when comparing metric values. Valid values are: GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN_OR_EQUAL, and EQUAL.
*/
ComparisonOperator: __string;
/**
* The value to compare.
*/
Value: __double;
}
export type Mode = "DELIVERY"|"FILTER"|string;
export interface MultiConditionalBranch {
/**
* The condition to evaluate for the activity path.
*/
Condition?: SimpleCondition;
/**
* The unique identifier for the next activity to perform, after completing the activity for the path.
*/
NextActivity?: __string;
}
export interface MultiConditionalSplitActivity {
/**
* The paths for the activity, including the conditions for entering each path and the activity to perform for each path.
*/
Branches?: ListOfMultiConditionalBranch;
/**
* The unique identifier for the activity to perform for participants who don't meet any of the conditions specified for other paths in the activity.
*/
DefaultActivity?: __string;
/**
* The amount of time to wait or the date and time when Amazon Pinpoint determines whether the conditions are met.
*/
EvaluationWaitTime?: WaitTime;
}
export interface NumberValidateRequest {
/**
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
*/
IsoCountryCode?: __string;
/**
* The phone number to retrieve information about. The phone number that you provide should include a valid numeric country code. Otherwise, the operation might result in an error.
*/
PhoneNumber?: __string;
}
export interface NumberValidateResponse {
/**
* The carrier or service provider that the phone number is currently registered with. In some countries and regions, this value may be the carrier or service provider that the phone number was originally registered with.
*/
Carrier?: __string;
/**
* The name of the city where the phone number was originally registered.
*/
City?: __string;
/**
* The cleansed phone number, in E.164 format, for the location where the phone number was originally registered.
*/
CleansedPhoneNumberE164?: __string;
/**
* The cleansed phone number, in the format for the location where the phone number was originally registered.
*/
CleansedPhoneNumberNational?: __string;
/**
* The name of the country or region where the phone number was originally registered.
*/
Country?: __string;
/**
* The two-character code, in ISO 3166-1 alpha-2 format, for the country or region where the phone number was originally registered.
*/
CountryCodeIso2?: __string;
/**
* The numeric code for the country or region where the phone number was originally registered.
*/
CountryCodeNumeric?: __string;
/**
* The name of the county where the phone number was originally registered.
*/
County?: __string;
/**
* The two-character code, in ISO 3166-1 alpha-2 format, that was sent in the request body.
*/
OriginalCountryCodeIso2?: __string;
/**
* The phone number that was sent in the request body.
*/
OriginalPhoneNumber?: __string;
/**
* The description of the phone type. Valid values are: MOBILE, LANDLINE, VOIP,
INVALID, PREPAID, and OTHER.
*/
PhoneType?: __string;
/**
* The phone type, represented by an integer. Valid values are: 0 (mobile), 1 (landline), 2 (VoIP), 3 (invalid), 4 (other), and 5 (prepaid).
*/
PhoneTypeCode?: __integer;
/**
* The time zone for the location where the phone number was originally registered.
*/
Timezone?: __string;
/**
* The postal or ZIP code for the location where the phone number was originally registered.
*/
ZipCode?: __string;
}
export type Operator = "ALL"|"ANY"|string;
export interface PhoneNumberValidateRequest {
NumberValidateRequest: NumberValidateRequest;
}
export interface PhoneNumberValidateResponse {
NumberValidateResponse: NumberValidateResponse;
}
export interface PublicEndpoint {
/**
* The unique identifier for the recipient, such as a device token, email address, or mobile phone number.
*/
Address?: __string;
/**
* One or more custom attributes that describe the endpoint by associating a name with an array of values. You can use these attributes as filter criteria when you create segments.
*/
Attributes?: MapOfListOf__string;
/**
* The channel that's used when sending messages or push notifications to the endpoint.
*/
ChannelType?: ChannelType;
/**
* The demographic information for the endpoint, such as the time zone and platform.
*/
Demographic?: EndpointDemographic;
/**
* The date and time, in ISO 8601 format, when the endpoint was last updated.
*/
EffectiveDate?: __string;
/**
* Specifies whether to send messages or push notifications to the endpoint. Valid values are: ACTIVE, messages are sent to the endpoint; and, INACTIVE, messages aren’t sent to the endpoint. Amazon Pinpoint automatically sets this value to ACTIVE when you create an endpoint or update an existing endpoint. Amazon Pinpoint automatically sets this value to INACTIVE if you update another endpoint that has the same address specified by the Address property.
*/
EndpointStatus?: __string;
/**
* The geographic information for the endpoint.
*/
Location?: EndpointLocation;
/**
* One or more custom metrics that your app reports to Amazon Pinpoint for the endpoint.
*/
Metrics?: MapOf__double;
/**
* Specifies whether the user who's associated with the endpoint has opted out of receiving messages and push notifications from you. Possible values are: ALL, the user has opted out and doesn't want to receive any messages or push notifications; and, NONE, the user hasn't opted out and wants to receive all messages and push notifications.
*/
OptOut?: __string;
/**
* A unique identifier that's generated each time the endpoint is updated.
*/
RequestId?: __string;
/**
* One or more custom user attributes that your app reports to Amazon Pinpoint for the user who's associated with the endpoint.
*/
User?: EndpointUser;
}
export interface PushMessageActivity {
/**
* Specifies the time to live (TTL) value for push notifications that are sent to participants in a journey.
*/
MessageConfig?: JourneyPushMessage;
/**
* The unique identifier for the next activity to perform, after the message is sent.
*/
NextActivity?: __string;
/**
* The name of the push notification template to use for the message. If specified, this value must match the name of an existing message template.
*/
TemplateName?: __string;
/**
* The unique identifier for the version of the push notification template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource. If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/
TemplateVersion?: __string;
}
export interface PushNotificationTemplateRequest {
/**
* The message template to use for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
ADM?: AndroidPushNotificationTemplate;
/**
* The message template to use for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
APNS?: APNSPushNotificationTemplate;
/**
* The message template to use for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
Baidu?: AndroidPushNotificationTemplate;
/**
* The default message template to use for push notification channels.
*/
Default?: DefaultPushNotificationTemplate;
/**
* A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/
DefaultSubstitutions?: __string;
/**
* The message template to use for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
GCM?: AndroidPushNotificationTemplate;
/**
* The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
*/
RecommenderId?: __string;
/**
* A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* A custom description of the message template.
*/
TemplateDescription?: __string;
}
export interface PushNotificationTemplateResponse {
/**
* The message template that's used for the ADM (Amazon Device Messaging) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
ADM?: AndroidPushNotificationTemplate;
/**
* The message template that's used for the APNs (Apple Push Notification service) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
APNS?: APNSPushNotificationTemplate;
/**
* The Amazon Resource Name (ARN) of the message template.
*/
Arn?: __string;
/**
* The message template that's used for the Baidu (Baidu Cloud Push) channel. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
Baidu?: AndroidPushNotificationTemplate;
/**
* The date, in ISO 8601 format, when the message template was created.
*/
CreationDate: __string;
/**
* The default message template that's used for push notification channels.
*/
Default?: DefaultPushNotificationTemplate;
/**
* The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/
DefaultSubstitutions?: __string;
/**
* The message template that's used for the GCM channel, which is used to send notifications through the Firebase Cloud Messaging (FCM), formerly Google Cloud Messaging (GCM), service. This message template overrides the default template for push notification channels (DefaultPushNotificationTemplate).
*/
GCM?: AndroidPushNotificationTemplate;
/**
* The date, in ISO 8601 format, when the message template was last modified.
*/
LastModifiedDate: __string;
/**
* The unique identifier for the recommender model that's used by the message template.
*/
RecommenderId?: __string;
/**
* A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* The custom description of the message template.
*/
TemplateDescription?: __string;
/**
* The name of the message template.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. For a push notification template, this value is PUSH.
*/
TemplateType: TemplateType;
/**
* The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/
Version?: __string;
}
export interface PutEventStreamRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
WriteEventStream: WriteEventStream;
}
export interface PutEventStreamResponse {
EventStream: EventStream;
}
export interface PutEventsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
EventsRequest: EventsRequest;
}
export interface PutEventsResponse {
EventsResponse: EventsResponse;
}
export interface QuietTime {
/**
* The specific time when quiet time ends. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
*/
End?: __string;
/**
* The specific time when quiet time begins. This value has to use 24-hour notation and be in HH:MM format, where HH is the hour (with a leading zero, if applicable) and MM is the minutes. For example, use 02:30 to represent 2:30 AM, or 14:30 to represent 2:30 PM.
*/
Start?: __string;
}
export interface RandomSplitActivity {
/**
* The paths for the activity, including the percentage of participants to enter each path and the activity to perform for each path.
*/
Branches?: ListOfRandomSplitEntry;
}
export interface RandomSplitEntry {
/**
* The unique identifier for the next activity to perform, after completing the activity for the path.
*/
NextActivity?: __string;
/**
* The percentage of participants to send down the activity path. To determine which participants are sent down each path, Amazon Pinpoint applies a probability-based algorithm to the percentages that you specify for the paths. Therefore, the actual percentage of participants who are sent down a path may not be equal to the percentage that you specify.
*/
Percentage?: __integer;
}
export interface RawEmail {
/**
* The email message, represented as a raw MIME message. The entire message must be base64 encoded.
*/
Data?: __blob;
}
export type __blob = Buffer|Uint8Array|Blob|string;
export interface RecencyDimension {
/**
* The duration to use when determining whether an endpoint is active or inactive.
*/
Duration: Duration;
/**
* The type of recency dimension to use for the segment. Valid values are: ACTIVE, endpoints that were active within the specified duration are included in the segment; and, INACTIVE, endpoints that weren't active within the specified duration are included in the segment.
*/
RecencyType: RecencyType;
}
export type RecencyType = "ACTIVE"|"INACTIVE"|string;
export interface RecommenderConfigurationResponse {
/**
* A map that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template. This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/
Attributes?: MapOf__string;
/**
* The date, in extended ISO 8601 format, when the configuration was created for the recommender model.
*/
CreationDate: __string;
/**
* The custom description of the configuration for the recommender model.
*/
Description?: __string;
/**
* The unique identifier for the recommender model configuration.
*/
Id: __string;
/**
* The date, in extended ISO 8601 format, when the configuration for the recommender model was last modified.
*/
LastModifiedDate: __string;
/**
* The custom name of the configuration for the recommender model.
*/
Name?: __string;
/**
* The type of Amazon Pinpoint ID that's associated with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Possible values are: PINPOINT_ENDPOINT_ID - Each user in the model is associated with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value. PINPOINT_USER_ID - Each user in the model is associated with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If this value is specified, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
*/
RecommendationProviderIdType?: __string;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
*/
RecommendationProviderRoleArn: __string;
/**
* The Amazon Resource Name (ARN) of the recommender model that Amazon Pinpoint retrieves the recommendation data from. This value is the ARN of an Amazon Personalize campaign.
*/
RecommendationProviderUri: __string;
/**
* The name or Amazon Resource Name (ARN) of the AWS Lambda function that Amazon Pinpoint invokes to perform additional processing of recommendation data that it retrieves from the recommender model.
*/
RecommendationTransformerUri?: __string;
/**
* The custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. This value is null if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/
RecommendationsDisplayName?: __string;
/**
* The number of recommended items that are retrieved from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables.
*/
RecommendationsPerMessage?: __integer;
}
export interface RemoveAttributesRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The type of attribute or attributes to remove. Valid values are: endpoint-custom-attributes - Custom attributes that describe endpoints, such as the date when an associated user opted in or out of receiving communications from you through a specific type of channel. endpoint-metric-attributes - Custom metrics that your app reports to Amazon Pinpoint for endpoints, such as the number of app sessions or the number of items left in a cart. endpoint-user-attributes - Custom attributes that describe users, such as first name, last name, and age.
*/
AttributeType: __string;
UpdateAttributesRequest: UpdateAttributesRequest;
}
export interface RemoveAttributesResponse {
AttributesResource: AttributesResource;
}
export interface ResultRow {
/**
* An array of objects that defines the field and field values that were used to group data in a result set that contains multiple results. This value is null if the data in a result set isn’t grouped.
*/
GroupedBys: ListOfResultRowValue;
/**
* An array of objects that provides pre-aggregated values for a standard metric that applies to an application, campaign, or journey.
*/
Values: ListOfResultRowValue;
}
export interface ResultRowValue {
/**
* The friendly name of the metric whose value is specified by the Value property.
*/
Key: __string;
/**
* The data type of the value specified by the Value property.
*/
Type: __string;
/**
* In a Values object, the value for the metric that the query retrieved data for. In a GroupedBys object, the value for the field that was used to group data in a result set that contains multiple results (Values objects).
*/
Value: __string;
}
export interface SMSChannelRequest {
/**
* Specifies whether to enable the SMS channel for the application.
*/
Enabled?: __boolean;
/**
* The identity that you want to display on recipients' devices when they receive messages from the SMS channel.
*/
SenderId?: __string;
/**
* The registered short code that you want to use when you send messages through the SMS channel.
*/
ShortCode?: __string;
}
export interface SMSChannelResponse {
/**
* The unique identifier for the application that the SMS channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time, in ISO 8601 format, when the SMS channel was enabled.
*/
CreationDate?: __string;
/**
* Specifies whether the SMS channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* (Deprecated) An identifier for the SMS channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the SMS channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the SMS channel.
*/
LastModifiedBy?: __string;
/**
* The date and time, in ISO 8601 format, when the SMS channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the SMS channel, this value is SMS.
*/
Platform: __string;
/**
* The maximum number of promotional messages that you can send through the SMS channel each second.
*/
PromotionalMessagesPerSecond?: __integer;
/**
* The identity that displays on recipients' devices when they receive messages from the SMS channel.
*/
SenderId?: __string;
/**
* The registered short code to use when you send messages through the SMS channel.
*/
ShortCode?: __string;
/**
* The maximum number of transactional messages that you can send through the SMS channel each second.
*/
TransactionalMessagesPerSecond?: __integer;
/**
* The current version of the SMS channel.
*/
Version?: __integer;
}
export interface SMSMessage {
/**
* The body of the SMS message.
*/
Body?: __string;
/**
* The SMS program name that you provided to AWS Support when you requested your dedicated number.
*/
Keyword?: __string;
/**
* This field is reserved for future use.
*/
MediaUrl?: __string;
/**
* The SMS message type. Valid values are TRANSACTIONAL (for messages that are critical or time-sensitive, such as a one-time passwords) and PROMOTIONAL (for messsages that aren't critical or time-sensitive, such as marketing messages).
*/
MessageType?: MessageType;
/**
* The number to send the SMS message from. This value should be one of the dedicated long or short codes that's assigned to your AWS account. If you don't specify a long or short code, Amazon Pinpoint assigns a random long code to the SMS message and sends the message from that code.
*/
OriginationNumber?: __string;
/**
* The sender ID to display as the sender of the message on a recipient's device. Support for sender IDs varies by country or region.
*/
SenderId?: __string;
/**
* The message variables to use in the SMS message. You can override the default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
}
export interface SMSMessageActivity {
/**
* Specifies the sender ID and message type for an SMS message that's sent to participants in a journey.
*/
MessageConfig?: JourneySMSMessage;
/**
* The unique identifier for the next activity to perform, after the message is sent.
*/
NextActivity?: __string;
/**
* The name of the SMS message template to use for the message. If specified, this value must match the name of an existing message template.
*/
TemplateName?: __string;
/**
* The unique identifier for the version of the SMS template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource. If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/
TemplateVersion?: __string;
}
export interface SMSTemplateRequest {
/**
* The message body to use in text messages that are based on the message template.
*/
Body?: __string;
/**
* A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/
DefaultSubstitutions?: __string;
/**
* The unique identifier for the recommender model to use for the message template. Amazon Pinpoint uses this value to determine how to retrieve and process data from a recommender model when it sends messages that use the template, if the template contains message variables for recommendation data.
*/
RecommenderId?: __string;
/**
* A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* A custom description of the message template.
*/
TemplateDescription?: __string;
}
export interface SMSTemplateResponse {
/**
* The Amazon Resource Name (ARN) of the message template.
*/
Arn?: __string;
/**
* The message body that's used in text messages that are based on the message template.
*/
Body?: __string;
/**
* The date, in ISO 8601 format, when the message template was created.
*/
CreationDate: __string;
/**
* The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/
DefaultSubstitutions?: __string;
/**
* The date, in ISO 8601 format, when the message template was last modified.
*/
LastModifiedDate: __string;
/**
* The unique identifier for the recommender model that's used by the message template.
*/
RecommenderId?: __string;
/**
* A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* The custom description of the message template.
*/
TemplateDescription?: __string;
/**
* The name of the message template.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. For an SMS template, this value is SMS.
*/
TemplateType: TemplateType;
/**
* The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/
Version?: __string;
}
export interface Schedule {
/**
* The scheduled time, in ISO 8601 format, when the campaign ended or will end.
*/
EndTime?: __string;
/**
* The type of event that causes the campaign to be sent, if the value of the Frequency property is EVENT.
*/
EventFilter?: CampaignEventFilter;
/**
* Specifies how often the campaign is sent or whether the campaign is sent in response to a specific event.
*/
Frequency?: Frequency;
/**
* Specifies whether the start and end times for the campaign schedule use each recipient's local time. To base the schedule on each recipient's local time, set this value to true.
*/
IsLocalTime?: __boolean;
/**
* The default quiet time for the campaign. Quiet time is a specific time range when a campaign doesn't send messages to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the campaign. The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the campaign. If any of the preceding conditions isn't met, the endpoint will receive messages from the campaign, even if quiet time is enabled.
*/
QuietTime?: QuietTime;
/**
* The scheduled time when the campaign began or will begin. Valid values are: IMMEDIATE, to start the campaign immediately; or, a specific time in ISO 8601 format.
*/
StartTime: __string;
/**
* The starting UTC offset for the campaign schedule, if the value of the IsLocalTime property is true. Valid values are: UTC, UTC+01, UTC+02, UTC+03, UTC+03:30, UTC+04, UTC+04:30, UTC+05,
UTC+05:30, UTC+05:45, UTC+06, UTC+06:30, UTC+07, UTC+08, UTC+09, UTC+09:30,
UTC+10, UTC+10:30, UTC+11, UTC+12, UTC+13, UTC-02, UTC-03, UTC-04, UTC-05, UTC-06,
UTC-07, UTC-08, UTC-09, UTC-10, and UTC-11.
*/
Timezone?: __string;
}
export interface SegmentBehaviors {
/**
* The dimension settings that are based on how recently an endpoint was active.
*/
Recency?: RecencyDimension;
}
export interface SegmentCondition {
/**
* The unique identifier for the segment to associate with the activity.
*/
SegmentId: __string;
}
export interface SegmentDemographics {
/**
* The app version criteria for the segment.
*/
AppVersion?: SetDimension;
/**
* The channel criteria for the segment.
*/
Channel?: SetDimension;
/**
* The device type criteria for the segment.
*/
DeviceType?: SetDimension;
/**
* The device make criteria for the segment.
*/
Make?: SetDimension;
/**
* The device model criteria for the segment.
*/
Model?: SetDimension;
/**
* The device platform criteria for the segment.
*/
Platform?: SetDimension;
}
export interface SegmentDimensions {
/**
* One or more custom attributes to use as criteria for the segment.
*/
Attributes?: MapOfAttributeDimension;
/**
* The behavior-based criteria, such as how recently users have used your app, for the segment.
*/
Behavior?: SegmentBehaviors;
/**
* The demographic-based criteria, such as device platform, for the segment.
*/
Demographic?: SegmentDemographics;
/**
* The location-based criteria, such as region or GPS coordinates, for the segment.
*/
Location?: SegmentLocation;
/**
* One or more custom metrics to use as criteria for the segment.
*/
Metrics?: MapOfMetricDimension;
/**
* One or more custom user attributes to use as criteria for the segment.
*/
UserAttributes?: MapOfAttributeDimension;
}
export interface SegmentGroup {
/**
* An array that defines the dimensions for the segment.
*/
Dimensions?: ListOfSegmentDimensions;
/**
* The base segment to build the segment on. A base segment, also referred to as a source segment, defines the initial population of endpoints for a segment. When you add dimensions to a segment, Amazon Pinpoint filters the base segment by using the dimensions that you specify. You can specify more than one dimensional segment or only one imported segment. If you specify an imported segment, the Amazon Pinpoint console displays a segment size estimate that indicates the size of the imported segment without any filters applied to it.
*/
SourceSegments?: ListOfSegmentReference;
/**
* Specifies how to handle multiple base segments for the segment. For example, if you specify three base segments for the segment, whether the resulting segment is based on all, any, or none of the base segments.
*/
SourceType?: SourceType;
/**
* Specifies how to handle multiple dimensions for the segment. For example, if you specify three dimensions for the segment, whether the resulting segment includes endpoints that match all, any, or none of the dimensions.
*/
Type?: Type;
}
export interface SegmentGroupList {
/**
* An array that defines the set of segment criteria to evaluate when handling segment groups for the segment.
*/
Groups?: ListOfSegmentGroup;
/**
* Specifies how to handle multiple segment groups for the segment. For example, if the segment includes three segment groups, whether the resulting segment includes endpoints that match all, any, or none of the segment groups.
*/
Include?: Include;
}
export interface SegmentImportResource {
/**
* The number of channel types in the endpoint definitions that were imported to create the segment.
*/
ChannelCounts?: MapOf__integer;
/**
* (Deprecated) Your AWS account ID, which you assigned to an external ID key in an IAM trust policy. Amazon Pinpoint previously used this value to assume an IAM role when importing endpoint definitions, but we removed this requirement. We don't recommend use of external IDs for IAM roles that are assumed by Amazon Pinpoint.
*/
ExternalId: __string;
/**
* The format of the files that were imported to create the segment. Valid values are: CSV, for comma-separated values format; and, JSON, for newline-delimited JSON format.
*/
Format: Format;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorized Amazon Pinpoint to access the Amazon S3 location to import endpoint definitions from.
*/
RoleArn: __string;
/**
* The URL of the Amazon Simple Storage Service (Amazon S3) bucket that the endpoint definitions were imported from to create the segment.
*/
S3Url: __string;
/**
* The number of endpoint definitions that were imported successfully to create the segment.
*/
Size: __integer;
}
export interface SegmentLocation {
/**
* The country or region code, in ISO 3166-1 alpha-2 format, for the segment.
*/
Country?: SetDimension;
/**
* The GPS location and range for the segment.
*/
GPSPoint?: GPSPointDimension;
}
export interface SegmentReference {
/**
* The unique identifier for the segment.
*/
Id: __string;
/**
* The version number of the segment.
*/
Version?: __integer;
}
export interface SegmentResponse {
/**
* The unique identifier for the application that the segment is associated with.
*/
ApplicationId: __string;
/**
* The Amazon Resource Name (ARN) of the segment.
*/
Arn: __string;
/**
* The date and time when the segment was created.
*/
CreationDate: __string;
/**
* The dimension settings for the segment.
*/
Dimensions?: SegmentDimensions;
/**
* The unique identifier for the segment.
*/
Id: __string;
/**
* The settings for the import job that's associated with the segment.
*/
ImportDefinition?: SegmentImportResource;
/**
* The date and time when the segment was last modified.
*/
LastModifiedDate?: __string;
/**
* The name of the segment.
*/
Name?: __string;
/**
* A list of one or more segment groups that apply to the segment. Each segment group consists of zero or more base segments and the dimensions that are applied to those base segments.
*/
SegmentGroups?: SegmentGroupList;
/**
* The segment type. Valid values are: DIMENSIONAL - A dynamic segment, which is a segment that uses selection criteria that you specify and is based on endpoint data that's reported by your app. Dynamic segments can change over time. IMPORT - A static segment, which is a segment that uses selection criteria that you specify and is based on endpoint definitions that you import from a file. Imported segments are static; they don't change over time.
*/
SegmentType: SegmentType;
/**
* A string-to-string map of key-value pairs that identifies the tags that are associated with the segment. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* The version number of the segment.
*/
Version?: __integer;
}
export type SegmentType = "DIMENSIONAL"|"IMPORT"|string;
export interface SegmentsResponse {
/**
* An array of responses, one for each segment that's associated with the application (Segments resource) or each version of a segment that's associated with the application (Segment Versions resource).
*/
Item: ListOfSegmentResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export interface SendMessagesRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
MessageRequest: MessageRequest;
}
export interface SendMessagesResponse {
MessageResponse: MessageResponse;
}
export interface SendUsersMessageRequest {
/**
* A map of custom attribute-value pairs. For a push notification, Amazon Pinpoint adds these attributes to the data.pinpoint object in the body of the notification payload. Amazon Pinpoint also provides these attributes in the events that it generates for users-messages deliveries.
*/
Context?: MapOf__string;
/**
* The settings and content for the default message and any default messages that you defined for specific channels.
*/
MessageConfiguration: DirectMessageConfiguration;
/**
* The message template to use for the message.
*/
TemplateConfiguration?: TemplateConfiguration;
/**
* The unique identifier for tracing the message. This identifier is visible to message recipients.
*/
TraceId?: __string;
/**
* A map that associates user IDs with EndpointSendConfiguration objects. You can use an EndpointSendConfiguration object to tailor the message for a user by specifying settings such as content overrides and message variables.
*/
Users: MapOfEndpointSendConfiguration;
}
export interface SendUsersMessageResponse {
/**
* The unique identifier for the application that was used to send the message.
*/
ApplicationId: __string;
/**
* The unique identifier that was assigned to the message request.
*/
RequestId?: __string;
/**
* An object that indicates which endpoints the message was sent to, for each user. The object lists user IDs and, for each user ID, provides the endpoint IDs that the message was sent to. For each endpoint ID, it provides an EndpointMessageResult object.
*/
Result?: MapOfMapOfEndpointMessageResult;
}
export interface SendUsersMessagesRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
SendUsersMessageRequest: SendUsersMessageRequest;
}
export interface SendUsersMessagesResponse {
SendUsersMessageResponse: SendUsersMessageResponse;
}
export interface Session {
/**
* The duration of the session, in milliseconds.
*/
Duration?: __integer;
/**
* The unique identifier for the session.
*/
Id: __string;
/**
* The date and time when the session began.
*/
StartTimestamp: __string;
/**
* The date and time when the session ended.
*/
StopTimestamp?: __string;
}
export interface SetDimension {
/**
* The type of segment dimension to use. Valid values are: INCLUSIVE, endpoints that match the criteria are included in the segment; and, EXCLUSIVE, endpoints that match the criteria are excluded from the segment.
*/
DimensionType?: DimensionType;
/**
* The criteria values to use for the segment dimension. Depending on the value of the DimensionType property, endpoints are included or excluded from the segment if their values match the criteria values.
*/
Values: ListOf__string;
}
export interface SimpleCondition {
/**
* The dimension settings for the event that's associated with the activity.
*/
EventCondition?: EventCondition;
/**
* The segment that's associated with the activity.
*/
SegmentCondition?: SegmentCondition;
/**
* The dimension settings for the segment that's associated with the activity.
*/
SegmentDimensions?: SegmentDimensions;
}
export interface SimpleEmail {
/**
* The body of the email message, in HTML format. We recommend using HTML format for email clients that render HTML content. You can include links, formatted text, and more in an HTML message.
*/
HtmlPart?: SimpleEmailPart;
/**
* The subject line, or title, of the email.
*/
Subject?: SimpleEmailPart;
/**
* The body of the email message, in plain text format. We recommend using plain text format for email clients that don't render HTML content and clients that are connected to high-latency networks, such as mobile devices.
*/
TextPart?: SimpleEmailPart;
}
export interface SimpleEmailPart {
/**
* The applicable character set for the message content.
*/
Charset?: __string;
/**
* The textual data of the message content.
*/
Data?: __string;
}
export type SourceType = "ALL"|"ANY"|"NONE"|string;
export interface StartCondition {
/**
* The custom description of the condition.
*/
Description?: __string;
EventStartCondition?: EventStartCondition;
/**
* The segment that's associated with the first activity in the journey. This segment determines which users are participants in the journey.
*/
SegmentStartCondition?: SegmentCondition;
}
export type State = "DRAFT"|"ACTIVE"|"COMPLETED"|"CANCELLED"|"CLOSED"|string;
export interface TagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn: __string;
TagsModel: TagsModel;
}
export interface TagsModel {
/**
* A string-to-string map of key-value pairs that defines the tags for an application, campaign, message template, or segment. Each of these resources can have a maximum of 50 tags. Each tag consists of a required tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.
*/
tags: MapOf__string;
}
export interface Template {
/**
* The name of the message template to use for the message. If specified, this value must match the name of an existing message template.
*/
Name?: __string;
/**
* The unique identifier for the version of the message template to use for the message. If specified, this value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource. If you don't specify a value for this property, Amazon Pinpoint uses the active version of the template. The active version is typically the version of a template that's been most recently reviewed and approved for use, depending on your workflow. It isn't necessarily the latest version of a template.
*/
Version?: __string;
}
export interface TemplateActiveVersionRequest {
/**
* The version of the message template to use as the active version of the template. Valid values are: latest, for the most recent version of the template; or, the unique identifier for any existing version of the template. If you specify an identifier, the value must match the identifier for an existing template version. To retrieve a list of versions and version identifiers for a template, use the Template Versions resource.
*/
Version?: __string;
}
export interface TemplateConfiguration {
/**
* The email template to use for the message.
*/
EmailTemplate?: Template;
/**
* The push notification template to use for the message.
*/
PushTemplate?: Template;
/**
* The SMS template to use for the message.
*/
SMSTemplate?: Template;
/**
* The voice template to use for the message. This object isn't supported for campaigns.
*/
VoiceTemplate?: Template;
}
export interface TemplateResponse {
/**
* The Amazon Resource Name (ARN) of the message template. This value isn't included in a TemplateResponse object. To retrieve the ARN of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the ARN for.
*/
Arn?: __string;
/**
* The date, in ISO 8601 format, when the message template was created.
*/
CreationDate: __string;
/**
* The JSON object that specifies the default values that are used for message variables in the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
*/
DefaultSubstitutions?: __string;
/**
* The date, in ISO 8601 format, when the message template was last modified.
*/
LastModifiedDate: __string;
/**
* A map of key-value pairs that identifies the tags that are associated with the message template. This object isn't included in a TemplateResponse object. To retrieve this object for a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the object for.
*/
tags?: MapOf__string;
/**
* The custom description of the message template. This value isn't included in a TemplateResponse object. To retrieve the description of a template, use the GetEmailTemplate, GetPushTemplate, GetSmsTemplate, or GetVoiceTemplate operation, depending on the type of template that you want to retrieve the description for.
*/
TemplateDescription?: __string;
/**
* The name of the message template.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
*/
TemplateType: TemplateType;
/**
* The unique identifier, as an integer, for the active version of the message template.
*/
Version?: __string;
}
export type TemplateType = "EMAIL"|"SMS"|"VOICE"|"PUSH"|string;
export interface TemplateVersionResponse {
/**
* The date, in ISO 8601 format, when the version of the message template was created.
*/
CreationDate: __string;
/**
* A JSON object that specifies the default values that are used for message variables in the version of the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/
DefaultSubstitutions?: __string;
/**
* The date, in ISO 8601 format, when the version of the message template was last modified.
*/
LastModifiedDate: __string;
/**
* The custom description of the version of the message template.
*/
TemplateDescription?: __string;
/**
* The name of the message template.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. Possible values are: EMAIL, PUSH, SMS, and VOICE.
*/
TemplateType: __string;
/**
* The unique identifier for the version of the message template. This value is an integer that Amazon Pinpoint automatically increments and assigns to each new version of a template.
*/
Version?: __string;
}
export interface TemplateVersionsResponse {
/**
* An array of responses, one for each version of the message template.
*/
Item: ListOfTemplateVersionResponse;
/**
* The message that's returned from the API for the request to retrieve information about all the versions of the message template.
*/
Message?: __string;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
/**
* The unique identifier for the request to retrieve information about all the versions of the message template.
*/
RequestID?: __string;
}
export interface TemplatesResponse {
/**
* An array of responses, one for each message template that's associated with your Amazon Pinpoint account and meets any filter criteria that you specified in the request.
*/
Item: ListOfTemplateResponse;
/**
* The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.
*/
NextToken?: __string;
}
export interface TreatmentResource {
/**
* The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
*/
CustomDeliveryConfiguration?: CustomDeliveryConfiguration;
/**
* The unique identifier for the treatment.
*/
Id: __string;
/**
* The message configuration settings for the treatment.
*/
MessageConfiguration?: MessageConfiguration;
/**
* The schedule settings for the treatment.
*/
Schedule?: Schedule;
/**
* The allocated percentage of users (segment members) that the treatment is sent to.
*/
SizePercent: __integer;
/**
* The current status of the treatment.
*/
State?: CampaignState;
/**
* The message template to use for the treatment.
*/
TemplateConfiguration?: TemplateConfiguration;
/**
* The custom description of the treatment.
*/
TreatmentDescription?: __string;
/**
* The custom name of the treatment.
*/
TreatmentName?: __string;
}
export type Type = "ALL"|"ANY"|"NONE"|string;
export interface UntagResourceRequest {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
ResourceArn: __string;
/**
* The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).
*/
TagKeys: ListOf__string;
}
export interface UpdateAdmChannelRequest {
ADMChannelRequest: ADMChannelRequest;
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface UpdateAdmChannelResponse {
ADMChannelResponse: ADMChannelResponse;
}
export interface UpdateApnsChannelRequest {
APNSChannelRequest: APNSChannelRequest;
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface UpdateApnsChannelResponse {
APNSChannelResponse: APNSChannelResponse;
}
export interface UpdateApnsSandboxChannelRequest {
APNSSandboxChannelRequest: APNSSandboxChannelRequest;
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface UpdateApnsSandboxChannelResponse {
APNSSandboxChannelResponse: APNSSandboxChannelResponse;
}
export interface UpdateApnsVoipChannelRequest {
APNSVoipChannelRequest: APNSVoipChannelRequest;
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface UpdateApnsVoipChannelResponse {
APNSVoipChannelResponse: APNSVoipChannelResponse;
}
export interface UpdateApnsVoipSandboxChannelRequest {
APNSVoipSandboxChannelRequest: APNSVoipSandboxChannelRequest;
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
}
export interface UpdateApnsVoipSandboxChannelResponse {
APNSVoipSandboxChannelResponse: APNSVoipSandboxChannelResponse;
}
export interface UpdateApplicationSettingsRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
WriteApplicationSettingsRequest: WriteApplicationSettingsRequest;
}
export interface UpdateApplicationSettingsResponse {
ApplicationSettingsResource: ApplicationSettingsResource;
}
export interface UpdateAttributesRequest {
/**
* An array of the attributes to remove from all the endpoints that are associated with the application. The array can specify the complete, exact name of each attribute to remove or it can specify a glob pattern that an attribute name must match in order for the attribute to be removed.
*/
Blacklist?: ListOf__string;
}
export interface UpdateBaiduChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
BaiduChannelRequest: BaiduChannelRequest;
}
export interface UpdateBaiduChannelResponse {
BaiduChannelResponse: BaiduChannelResponse;
}
export interface UpdateCampaignRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the campaign.
*/
CampaignId: __string;
WriteCampaignRequest: WriteCampaignRequest;
}
export interface UpdateCampaignResponse {
CampaignResponse: CampaignResponse;
}
export interface UpdateEmailChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
EmailChannelRequest: EmailChannelRequest;
}
export interface UpdateEmailChannelResponse {
EmailChannelResponse: EmailChannelResponse;
}
export interface UpdateEmailTemplateRequest {
/**
* Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/
CreateNewVersion?: __boolean;
EmailTemplateRequest: EmailTemplateRequest;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface UpdateEmailTemplateResponse {
MessageBody: MessageBody;
}
export interface UpdateEndpointRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the endpoint.
*/
EndpointId: __string;
EndpointRequest: EndpointRequest;
}
export interface UpdateEndpointResponse {
MessageBody: MessageBody;
}
export interface UpdateEndpointsBatchRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
EndpointBatchRequest: EndpointBatchRequest;
}
export interface UpdateEndpointsBatchResponse {
MessageBody: MessageBody;
}
export interface UpdateGcmChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
GCMChannelRequest: GCMChannelRequest;
}
export interface UpdateGcmChannelResponse {
GCMChannelResponse: GCMChannelResponse;
}
export interface UpdateJourneyRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the journey.
*/
JourneyId: __string;
WriteJourneyRequest: WriteJourneyRequest;
}
export interface UpdateJourneyResponse {
JourneyResponse: JourneyResponse;
}
export interface UpdateJourneyStateRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the journey.
*/
JourneyId: __string;
JourneyStateRequest: JourneyStateRequest;
}
export interface UpdateJourneyStateResponse {
JourneyResponse: JourneyResponse;
}
export interface UpdatePushTemplateRequest {
/**
* Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/
CreateNewVersion?: __boolean;
PushNotificationTemplateRequest: PushNotificationTemplateRequest;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface UpdatePushTemplateResponse {
MessageBody: MessageBody;
}
export interface UpdateRecommenderConfiguration {
/**
* A map of key-value pairs that defines 1-10 custom endpoint or user attributes, depending on the value for the RecommendationProviderIdType property. Each of these attributes temporarily stores a recommended item that's retrieved from the recommender model and sent to an AWS Lambda function for additional processing. Each attribute can be used as a message variable in a message template. In the map, the key is the name of a custom attribute and the value is a custom display name for that attribute. The display name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The following restrictions apply to these names: An attribute name must start with a letter or number and it can contain up to 50 characters. The characters can be letters, numbers, underscores (_), or hyphens (-). Attribute names are case sensitive and must be unique. An attribute display name must start with a letter or number and it can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). This object is required if the configuration invokes an AWS Lambda function (RecommendationTransformerUri) to process recommendation data. Otherwise, don't include this object in your request.
*/
Attributes?: MapOf__string;
/**
* A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
*/
Description?: __string;
/**
* A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
*/
Name?: __string;
/**
* The type of Amazon Pinpoint ID to associate with unique user IDs in the recommender model. This value enables the model to use attribute and event data that’s specific to a particular endpoint or user in an Amazon Pinpoint application. Valid values are: PINPOINT_ENDPOINT_ID - Associate each user in the model with a particular endpoint in Amazon Pinpoint. The data is correlated based on endpoint IDs in Amazon Pinpoint. This is the default value. PINPOINT_USER_ID - Associate each user in the model with a particular user and endpoint in Amazon Pinpoint. The data is correlated based on user IDs in Amazon Pinpoint. If you specify this value, an endpoint definition in Amazon Pinpoint has to specify both a user ID (UserId) and an endpoint ID. Otherwise, messages won’t be sent to the user's endpoint.
*/
RecommendationProviderIdType?: __string;
/**
* The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to retrieve recommendation data from the recommender model.
*/
RecommendationProviderRoleArn: __string;
/**
* The Amazon Resource Name (ARN) of the recommender model to retrieve recommendation data from. This value must match the ARN of an Amazon Personalize campaign.
*/
RecommendationProviderUri: __string;
/**
* The name or Amazon Resource Name (ARN) of the AWS Lambda function to invoke for additional processing of recommendation data that's retrieved from the recommender model.
*/
RecommendationTransformerUri?: __string;
/**
* A custom display name for the standard endpoint or user attribute (RecommendationItems) that temporarily stores recommended items for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This value is required if the configuration doesn't invoke an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data. This name appears in the Attribute finder of the template editor on the Amazon Pinpoint console. The name can contain up to 25 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-). These restrictions don't apply to attribute values.
*/
RecommendationsDisplayName?: __string;
/**
* The number of recommended items to retrieve from the model for each endpoint or user, depending on the value for the RecommendationProviderIdType property. This number determines how many recommended items are available for use in message variables. The minimum value is 1. The maximum value is 5. The default value is 5. To use multiple recommended items and custom attributes with message variables, you have to use an AWS Lambda function (RecommendationTransformerUri) to perform additional processing of recommendation data.
*/
RecommendationsPerMessage?: __integer;
}
export interface UpdateRecommenderConfigurationRequest {
/**
* The unique identifier for the recommender model configuration. This identifier is displayed as the Recommender ID on the Amazon Pinpoint console.
*/
RecommenderId: __string;
UpdateRecommenderConfiguration: UpdateRecommenderConfiguration;
}
export interface UpdateRecommenderConfigurationResponse {
RecommenderConfigurationResponse: RecommenderConfigurationResponse;
}
export interface UpdateSegmentRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
/**
* The unique identifier for the segment.
*/
SegmentId: __string;
WriteSegmentRequest: WriteSegmentRequest;
}
export interface UpdateSegmentResponse {
SegmentResponse: SegmentResponse;
}
export interface UpdateSmsChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
SMSChannelRequest: SMSChannelRequest;
}
export interface UpdateSmsChannelResponse {
SMSChannelResponse: SMSChannelResponse;
}
export interface UpdateSmsTemplateRequest {
/**
* Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/
CreateNewVersion?: __boolean;
SMSTemplateRequest: SMSTemplateRequest;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
}
export interface UpdateSmsTemplateResponse {
MessageBody: MessageBody;
}
export interface UpdateTemplateActiveVersionRequest {
TemplateActiveVersionRequest: TemplateActiveVersionRequest;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. Valid values are: EMAIL, PUSH, SMS, and VOICE.
*/
TemplateType: __string;
}
export interface UpdateTemplateActiveVersionResponse {
MessageBody: MessageBody;
}
export interface UpdateVoiceChannelRequest {
/**
* The unique identifier for the application. This identifier is displayed as the Project ID on the Amazon Pinpoint console.
*/
ApplicationId: __string;
VoiceChannelRequest: VoiceChannelRequest;
}
export interface UpdateVoiceChannelResponse {
VoiceChannelResponse: VoiceChannelResponse;
}
export interface UpdateVoiceTemplateRequest {
/**
* Specifies whether to save the updates as a new version of the message template. Valid values are: true, save the updates as a new version; and, false, save the updates to (overwrite) the latest existing version of the template. If you don't specify a value for this parameter, Amazon Pinpoint saves the updates to (overwrites) the latest existing version of the template. If you specify a value of true for this parameter, don't specify a value for the version parameter. Otherwise, an error will occur.
*/
CreateNewVersion?: __boolean;
/**
* The name of the message template. A template name must start with an alphanumeric character and can contain a maximum of 128 characters. The characters can be alphanumeric characters, underscores (_), or hyphens (-). Template names are case sensitive.
*/
TemplateName: __string;
/**
* The unique identifier for the version of the message template to update, retrieve information about, or delete. To retrieve identifiers and other information for all the versions of a template, use the Template Versions resource. If specified, this value must match the identifier for an existing template version. If specified for an update operation, this value must match the identifier for the latest existing version of the template. This restriction helps ensure that race conditions don't occur. If you don't specify a value for this parameter, Amazon Pinpoint does the following: For a get operation, retrieves information about the active version of the template. For an update operation, saves the updates to (overwrites) the latest existing version of the template, if the create-new-version parameter isn't used or is set to false. For a delete operation, deletes the template, including all versions of the template.
*/
Version?: __string;
VoiceTemplateRequest: VoiceTemplateRequest;
}
export interface UpdateVoiceTemplateResponse {
MessageBody: MessageBody;
}
export interface VoiceChannelRequest {
/**
* Specifies whether to enable the voice channel for the application.
*/
Enabled?: __boolean;
}
export interface VoiceChannelResponse {
/**
* The unique identifier for the application that the voice channel applies to.
*/
ApplicationId?: __string;
/**
* The date and time, in ISO 8601 format, when the voice channel was enabled.
*/
CreationDate?: __string;
/**
* Specifies whether the voice channel is enabled for the application.
*/
Enabled?: __boolean;
/**
* (Not used) This property is retained only for backward compatibility.
*/
HasCredential?: __boolean;
/**
* (Deprecated) An identifier for the voice channel. This property is retained only for backward compatibility.
*/
Id?: __string;
/**
* Specifies whether the voice channel is archived.
*/
IsArchived?: __boolean;
/**
* The user who last modified the voice channel.
*/
LastModifiedBy?: __string;
/**
* The date and time, in ISO 8601 format, when the voice channel was last modified.
*/
LastModifiedDate?: __string;
/**
* The type of messaging or notification platform for the channel. For the voice channel, this value is VOICE.
*/
Platform: __string;
/**
* The current version of the voice channel.
*/
Version?: __integer;
}
export interface VoiceMessage {
/**
* The text of the script to use for the voice message.
*/
Body?: __string;
/**
* The code for the language to use when synthesizing the text of the message script. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
*/
LanguageCode?: __string;
/**
* The long code to send the voice message from. This value should be one of the dedicated long codes that's assigned to your AWS account. Although it isn't required, we recommend that you specify the long code in E.164 format, for example +12065550100, to ensure prompt and accurate delivery of the message.
*/
OriginationNumber?: __string;
/**
* The default message variables to use in the voice message. You can override the default variables with individual address variables.
*/
Substitutions?: MapOfListOf__string;
/**
* The name of the voice to use when delivering the message. For a list of supported voices, see the Amazon Polly Developer Guide.
*/
VoiceId?: __string;
}
export interface VoiceTemplateRequest {
/**
* The text of the script to use in messages that are based on the message template, in plain text format.
*/
Body?: __string;
/**
* A JSON object that specifies the default values to use for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable. When you create a message that's based on the template, you can override these defaults with message-specific and address-specific variables and values.
*/
DefaultSubstitutions?: __string;
/**
* The code for the language to use when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
*/
LanguageCode?: __string;
/**
* A string-to-string map of key-value pairs that defines the tags to associate with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* A custom description of the message template.
*/
TemplateDescription?: __string;
/**
* The name of the voice to use when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
*/
VoiceId?: __string;
}
export interface VoiceTemplateResponse {
/**
* The Amazon Resource Name (ARN) of the message template.
*/
Arn?: __string;
/**
* The text of the script that's used in messages that are based on the message template, in plain text format.
*/
Body?: __string;
/**
* The date, in ISO 8601 format, when the message template was created.
*/
CreationDate: __string;
/**
* The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.
*/
DefaultSubstitutions?: __string;
/**
* The code for the language that's used when synthesizing the text of the script in messages that are based on the message template. For a list of supported languages and the code for each one, see the Amazon Polly Developer Guide.
*/
LanguageCode?: __string;
/**
* The date, in ISO 8601 format, when the message template was last modified.
*/
LastModifiedDate: __string;
/**
* A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* The custom description of the message template.
*/
TemplateDescription?: __string;
/**
* The name of the message template.
*/
TemplateName: __string;
/**
* The type of channel that the message template is designed for. For a voice template, this value is VOICE.
*/
TemplateType: TemplateType;
/**
* The unique identifier, as an integer, for the active version of the message template, or the version of the template that you specified by using the version parameter in your request.
*/
Version?: __string;
/**
* The name of the voice that's used when delivering messages that are based on the message template. For a list of supported voices, see the Amazon Polly Developer Guide.
*/
VoiceId?: __string;
}
export interface WaitActivity {
/**
* The unique identifier for the next activity to perform, after performing the wait activity.
*/
NextActivity?: __string;
/**
* The amount of time to wait or the date and time when the activity moves participants to the next activity in the journey.
*/
WaitTime?: WaitTime;
}
export interface WaitTime {
/**
* The amount of time to wait, as a duration in ISO 8601 format, before determining whether the activity's conditions have been met or moving participants to the next activity in the journey.
*/
WaitFor?: __string;
/**
* The date and time, in ISO 8601 format, when Amazon Pinpoint determines whether the activity's conditions have been met or the activity moves participants to the next activity in the journey.
*/
WaitUntil?: __string;
}
export interface WriteApplicationSettingsRequest {
/**
* The settings for the AWS Lambda function to invoke by default as a code hook for campaigns in the application. You can use this hook to customize segments that are used by campaigns in the application. To override these settings and define custom settings for a specific campaign, use the CampaignHook object of the Campaign resource.
*/
CampaignHook?: CampaignHook;
/**
* Specifies whether to enable application-related alarms in Amazon CloudWatch.
*/
CloudWatchMetricsEnabled?: __boolean;
EventTaggingEnabled?: __boolean;
/**
* The default sending limits for campaigns in the application. To override these limits and define custom limits for a specific campaign or journey, use the Campaign resource or the Journey resource, respectively.
*/
Limits?: CampaignLimits;
/**
* The default quiet time for campaigns in the application. Quiet time is a specific time range when messages aren't sent to endpoints, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint is set to a valid value. The current time in the endpoint's time zone is later than or equal to the time specified by the QuietTime.Start property for the application (or a campaign or journey that has custom quiet time settings). The current time in the endpoint's time zone is earlier than or equal to the time specified by the QuietTime.End property for the application (or a campaign or journey that has custom quiet time settings). If any of the preceding conditions isn't met, the endpoint will receive messages from a campaign or journey, even if quiet time is enabled. To override the default quiet time settings for a specific campaign or journey, use the Campaign resource or the Journey resource to define a custom quiet time for the campaign or journey.
*/
QuietTime?: QuietTime;
}
export interface WriteCampaignRequest {
/**
* An array of requests that defines additional treatments for the campaign, in addition to the default treatment for the campaign.
*/
AdditionalTreatments?: ListOfWriteTreatmentResource;
/**
* The delivery configuration settings for sending the campaign through a custom channel. This object is required if the MessageConfiguration object for the campaign specifies a CustomMessage object.
*/
CustomDeliveryConfiguration?: CustomDeliveryConfiguration;
/**
* A custom description of the campaign.
*/
Description?: __string;
/**
* The allocated percentage of users (segment members) who shouldn't receive messages from the campaign.
*/
HoldoutPercent?: __integer;
/**
* The settings for the AWS Lambda function to invoke as a code hook for the campaign. You can use this hook to customize the segment that's used by the campaign.
*/
Hook?: CampaignHook;
/**
* Specifies whether to pause the campaign. A paused campaign doesn't run unless you resume it by changing this value to false.
*/
IsPaused?: __boolean;
/**
* The messaging limits for the campaign.
*/
Limits?: CampaignLimits;
/**
* The message configuration settings for the campaign.
*/
MessageConfiguration?: MessageConfiguration;
/**
* A custom name for the campaign.
*/
Name?: __string;
/**
* The schedule settings for the campaign.
*/
Schedule?: Schedule;
/**
* The unique identifier for the segment to associate with the campaign.
*/
SegmentId?: __string;
/**
* The version of the segment to associate with the campaign.
*/
SegmentVersion?: __integer;
/**
* A string-to-string map of key-value pairs that defines the tags to associate with the campaign. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
/**
* The message template to use for the campaign.
*/
TemplateConfiguration?: TemplateConfiguration;
/**
* A custom description of the default treatment for the campaign.
*/
TreatmentDescription?: __string;
/**
* A custom name of the default treatment for the campaign, if the campaign has multiple treatments. A treatment is a variation of a campaign that's used for A/B testing.
*/
TreatmentName?: __string;
}
export interface WriteEventStream {
/**
* The Amazon Resource Name (ARN) of the Amazon Kinesis data stream or Amazon Kinesis Data Firehose delivery stream that you want to publish event data to. For a Kinesis data stream, the ARN format is: arn:aws:kinesis:region:account-id:stream/stream_name
For a Kinesis Data Firehose delivery stream, the ARN format is: arn:aws:firehose:region:account-id:deliverystream/stream_name
*/
DestinationStreamArn: __string;
/**
* The AWS Identity and Access Management (IAM) role that authorizes Amazon Pinpoint to publish event data to the stream in your AWS account.
*/
RoleArn: __string;
}
export interface WriteJourneyRequest {
/**
* A map that contains a set of Activity objects, one object for each activity in the journey. For each Activity object, the key is the unique identifier (string) for an activity and the value is the settings for the activity. An activity identifier can contain a maximum of 100 characters. The characters must be alphanumeric characters.
*/
Activities?: MapOfActivity;
/**
* The date, in ISO 8601 format, when the journey was created.
*/
CreationDate?: __string;
/**
* The date, in ISO 8601 format, when the journey was last modified.
*/
LastModifiedDate?: __string;
/**
* The messaging and entry limits for the journey.
*/
Limits?: JourneyLimits;
/**
* Specifies whether the journey's scheduled start and end times use each participant's local time. To base the schedule on each participant's local time, set this value to true.
*/
LocalTime?: __boolean;
/**
* The name of the journey. A journey name can contain a maximum of 150 characters. The characters can be alphanumeric characters or symbols, such as underscores (_) or hyphens (-). A journey name can't contain any spaces.
*/
Name: __string;
/**
* The quiet time settings for the journey. Quiet time is a specific time range when a journey doesn't send messages to participants, if all the following conditions are met: The EndpointDemographic.Timezone property of the endpoint for the participant is set to a valid value. The current time in the participant's time zone is later than or equal to the time specified by the QuietTime.Start property for the journey. The current time in the participant's time zone is earlier than or equal to the time specified by the QuietTime.End property for the journey. If any of the preceding conditions isn't met, the participant will receive messages from the journey, even if quiet time is enabled.
*/
QuietTime?: QuietTime;
/**
* The frequency with which Amazon Pinpoint evaluates segment and event data for the journey, as a duration in ISO 8601 format.
*/
RefreshFrequency?: __string;
/**
* The schedule settings for the journey.
*/
Schedule?: JourneySchedule;
/**
* The unique identifier for the first activity in the journey. The identifier for this activity can contain a maximum of 128 characters. The characters must be alphanumeric characters.
*/
StartActivity?: __string;
/**
* The segment that defines which users are participants in the journey.
*/
StartCondition?: StartCondition;
/**
* The status of the journey. Valid values are: DRAFT - Saves the journey and doesn't publish it. ACTIVE - Saves and publishes the journey. Depending on the journey's schedule, the journey starts running immediately or at the scheduled start time. If a journey's status is ACTIVE, you can't add, change, or remove activities from it. The CANCELLED, COMPLETED, and CLOSED values are not supported in requests to create or update a journey. To cancel a journey, use the Journey State resource.
*/
State?: State;
}
export interface WriteSegmentRequest {
/**
* The criteria that define the dimensions for the segment.
*/
Dimensions?: SegmentDimensions;
/**
* The name of the segment.
*/
Name?: __string;
/**
* The segment group to use and the dimensions to apply to the group's base segments in order to build the segment. A segment group can consist of zero or more base segments. Your request can include only one segment group.
*/
SegmentGroups?: SegmentGroupList;
/**
* A string-to-string map of key-value pairs that defines the tags to associate with the segment. Each tag consists of a required tag key and an associated tag value.
*/
tags?: MapOf__string;
}
export interface WriteTreatmentResource {
/**
* The delivery configuration settings for sending the treatment through a custom channel. This object is required if the MessageConfiguration object for the treatment specifies a CustomMessage object.
*/
CustomDeliveryConfiguration?: CustomDeliveryConfiguration;
/**
* The message configuration settings for the treatment.
*/
MessageConfiguration?: MessageConfiguration;
/**
* The schedule settings for the treatment.
*/
Schedule?: Schedule;
/**
* The allocated percentage of users (segment members) to send the treatment to.
*/
SizePercent: __integer;
/**
* The message template to use for the treatment.
*/
TemplateConfiguration?: TemplateConfiguration;
/**
* A custom description of the treatment.
*/
TreatmentDescription?: __string;
/**
* A custom name for the treatment.
*/
TreatmentName?: __string;
}
export type __EndpointTypesElement = "PUSH"|"GCM"|"APNS"|"APNS_SANDBOX"|"APNS_VOIP"|"APNS_VOIP_SANDBOX"|"ADM"|"SMS"|"VOICE"|"EMAIL"|"BAIDU"|"CUSTOM"|string;
export type __boolean = boolean;
export type __double = number;
export type __integer = number;
export type ListOfActivityResponse = ActivityResponse[];
export type ListOfApplicationResponse = ApplicationResponse[];
export type ListOfCampaignResponse = CampaignResponse[];
export type ListOfEndpointBatchItem = EndpointBatchItem[];
export type ListOfEndpointResponse = EndpointResponse[];
export type ListOfExportJobResponse = ExportJobResponse[];
export type ListOfImportJobResponse = ImportJobResponse[];
export type ListOfJourneyResponse = JourneyResponse[];
export type ListOfMultiConditionalBranch = MultiConditionalBranch[];
export type ListOfRandomSplitEntry = RandomSplitEntry[];
export type ListOfRecommenderConfigurationResponse = RecommenderConfigurationResponse[];
export type ListOfResultRow = ResultRow[];
export type ListOfResultRowValue = ResultRowValue[];
export type ListOfSegmentDimensions = SegmentDimensions[];
export type ListOfSegmentGroup = SegmentGroup[];
export type ListOfSegmentReference = SegmentReference[];
export type ListOfSegmentResponse = SegmentResponse[];
export type ListOfSimpleCondition = SimpleCondition[];
export type ListOfTemplateResponse = TemplateResponse[];
export type ListOfTemplateVersionResponse = TemplateVersionResponse[];
export type ListOfTreatmentResource = TreatmentResource[];
export type ListOfWriteTreatmentResource = WriteTreatmentResource[];
export type ListOf__EndpointTypesElement = __EndpointTypesElement[];
export type ListOf__string = __string[];
export type MapOfActivity = {[key: string]: Activity};
export type MapOfAddressConfiguration = {[key: string]: AddressConfiguration};
export type MapOfAttributeDimension = {[key: string]: AttributeDimension};
export type MapOfChannelResponse = {[key: string]: ChannelResponse};
export type MapOfEndpointMessageResult = {[key: string]: EndpointMessageResult};
export type MapOfEndpointSendConfiguration = {[key: string]: EndpointSendConfiguration};
export type MapOfEvent = {[key: string]: Event};
export type MapOfEventItemResponse = {[key: string]: EventItemResponse};
export type MapOfEventsBatch = {[key: string]: EventsBatch};
export type MapOfItemResponse = {[key: string]: ItemResponse};
export type MapOfMessageResult = {[key: string]: MessageResult};
export type MapOfMetricDimension = {[key: string]: MetricDimension};
export type MapOf__double = {[key: string]: __double};
export type MapOf__integer = {[key: string]: __integer};
export type MapOfListOf__string = {[key: string]: ListOf__string};
export type MapOfMapOfEndpointMessageResult = {[key: string]: MapOfEndpointMessageResult};
export type MapOf__string = {[key: string]: __string};
export type __string = string;
export type __timestampIso8601 = Date;
/**
* 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 = "2016-12-01"|"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 Pinpoint client.
*/
export import Types = Pinpoint;
}
export = Pinpoint;