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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// Information about an action.
type ActionSummary struct {
// The action type.
//
// This member is required.
ActionType ActionType
noSmithyDocumentSerde
}
// The distribution of agents between the instance and its replica(s).
type AgentConfig struct {
// Information about traffic distributions.
//
// This member is required.
Distributions []Distribution
noSmithyDocumentSerde
}
// Information about the contact (https://docs.aws.amazon.com/connect/latest/APIReference/API_Contact.html)
// associated to the user.
type AgentContactReference struct {
// The state of the contact (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html)
// .
AgentContactState ContactState
// The channel of the contact.
Channel Channel
// The time at which the contact was connected to an agent.
ConnectedToAgentTimestamp *time.Time
// The identifier of the contact in this instance of Amazon Connect.
ContactId *string
// How the contact was initiated.
InitiationMethod ContactInitiationMethod
// Contains information about a queue resource for which metrics are returned.
Queue *QueueReference
// The epoch timestamp when the contact state started.
StateStartTimestamp *time.Time
noSmithyDocumentSerde
}
// A structure that defines search criteria for contacts using agent hierarchy
// group levels. For more information about agent hierarchies, see Set Up Agent
// Hierarchies (https://docs.aws.amazon.com/connect/latest/adminguide/agent-hierarchy.html)
// in the Amazon Connect Administrator Guide.
type AgentHierarchyGroups struct {
// The identifiers for level 1 hierarchy groups.
L1Ids []string
// The identifiers for level 2 hierarchy groups.
L2Ids []string
// The identifiers for level 3 hierarchy groups.
L3Ids []string
// The identifiers for level 4 hierarchy groups.
L4Ids []string
// The identifiers for level 5 hierarchy groups.
L5Ids []string
noSmithyDocumentSerde
}
// Information about the agent who accepted the contact.
type AgentInfo struct {
// Agent pause duration for a contact in seconds.
AgentPauseDurationInSeconds *int32
// The timestamp when the contact was connected to the agent.
ConnectedToAgentTimestamp *time.Time
// The identifier of the agent who accepted the contact.
Id *string
noSmithyDocumentSerde
}
// Contains information about an agent status.
type AgentStatus struct {
// The Amazon Resource Name (ARN) of the agent status.
AgentStatusARN *string
// The identifier of the agent status.
AgentStatusId *string
// The description of the agent status.
Description *string
// The display order of the agent status.
DisplayOrder *int32
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the agent status.
Name *string
// The state of the agent status.
State AgentStatusState
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The type of agent status.
Type AgentStatusType
noSmithyDocumentSerde
}
// Information about the agent's status.
type AgentStatusReference struct {
// The Amazon Resource Name (ARN) of the agent's status.
StatusArn *string
// The name of the agent status.
StatusName *string
// The start timestamp of the agent's status.
StatusStartTimestamp *time.Time
noSmithyDocumentSerde
}
// Summary information for an agent status.
type AgentStatusSummary struct {
// The Amazon Resource Name (ARN) for the agent status.
Arn *string
// The identifier for an agent status.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the agent status.
Name *string
// The type of the agent status.
Type AgentStatusType
noSmithyDocumentSerde
}
// Information about the capabilities enabled for participants of the contact.
type AllowedCapabilities struct {
// Information about the agent's video sharing capabilities.
Agent *ParticipantCapabilities
// Information about the customer's video sharing capabilities.
Customer *ParticipantCapabilities
noSmithyDocumentSerde
}
// This API is in preview release for Amazon Connect and is subject to change.
// Information about associations that are successfully created: DataSetId ,
// TargetAccountId , ResourceShareId , ResourceShareArn .
type AnalyticsDataAssociationResult struct {
// The identifier of the dataset.
DataSetId *string
// The Amazon Resource Name (ARN) of the Resource Access Manager share.
ResourceShareArn *string
// The Resource Access Manager share ID.
ResourceShareId *string
// The identifier of the target account.
TargetAccountId *string
noSmithyDocumentSerde
}
// Configuration of the answering machine detection.
type AnswerMachineDetectionConfig struct {
// Wait for the answering machine prompt.
AwaitAnswerMachinePrompt bool
// The flag to indicate if answer machine detection analysis needs to be performed
// for a voice call. If set to true , TrafficType must be set as CAMPAIGN .
EnableAnswerMachineDetection bool
noSmithyDocumentSerde
}
// This API is in preview release for Amazon Connect and is subject to change. A
// third-party application's metadata.
type Application struct {
// The permissions that the agent is granted on the application. Only the ACCESS
// permission is supported.
ApplicationPermissions []string
// Namespace of the application that you want to give access to.
Namespace *string
noSmithyDocumentSerde
}
// This action must be set if TriggerEventSource is one of the following values:
// OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |
// OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable . Contact is
// categorized using the rule name. RuleName is used as ContactCategory .
type AssignContactCategoryActionDefinition struct {
noSmithyDocumentSerde
}
// Information about a reference when the referenceType is ATTACHMENT . Otherwise,
// null.
type AttachmentReference struct {
// Identifier of the attachment reference.
Name *string
// Status of the attachment reference type.
Status ReferenceStatus
// The location path of the attachment reference.
Value *string
noSmithyDocumentSerde
}
// The attendee information, including attendee ID and join token.
type Attendee struct {
// The Amazon Chime SDK attendee ID.
AttendeeId *string
// The join token used by the Amazon Chime SDK attendee.
JoinToken *string
noSmithyDocumentSerde
}
// A toggle for an individual feature at the instance level.
type Attribute struct {
// The type of attribute.
AttributeType InstanceAttributeType
// The value of the attribute.
Value *string
noSmithyDocumentSerde
}
// Has audio-specific configurations as the operating parameter for Echo Reduction.
type AudioFeatures struct {
// Makes echo reduction available to clients who connect to the meeting.
EchoReduction MeetingFeatureStatus
noSmithyDocumentSerde
}
// Information about available phone numbers.
type AvailableNumberSummary struct {
// The phone number. Phone numbers are formatted [+] [country code] [subscriber
// number including area code] .
PhoneNumber *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The type of phone number.
PhoneNumberType PhoneNumberType
noSmithyDocumentSerde
}
// Information associated with a campaign.
type Campaign struct {
// A unique identifier for a campaign.
CampaignId *string
noSmithyDocumentSerde
}
// Chat integration event containing payload to perform different chat actions
// such as:
// - Sending a chat message
// - Sending a chat event, such as typing
// - Disconnecting from a chat
type ChatEvent struct {
// Type of chat integration event.
//
// This member is required.
Type ChatEventType
// Content of the message or event. This is required when Type is MESSAGE and for
// certain ContentTypes when Type is EVENT .
// - For allowed message content, see the Content parameter in the SendMessage (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html)
// topic in the Amazon Connect Participant Service API Reference.
// - For allowed event content, see the Content parameter in the SendEvent (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html)
// topic in the Amazon Connect Participant Service API Reference.
Content *string
// Type of content. This is required when Type is MESSAGE or EVENT .
// - For allowed message content types, see the ContentType parameter in the
// SendMessage (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendMessage.html)
// topic in the Amazon Connect Participant Service API Reference.
// - For allowed event content types, see the ContentType parameter in the
// SendEvent (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_SendEvent.html)
// topic in the Amazon Connect Participant Service API Reference.
ContentType *string
noSmithyDocumentSerde
}
// A chat message.
type ChatMessage struct {
// The content of the chat message.
// - For text/plain and text/markdown , the Length Constraints are Minimum of 1,
// Maximum of 1024.
// - For application/json , the Length Constraints are Minimum of 1, Maximum of
// 12000.
// - For application/vnd.amazonaws.connect.message.interactive.response , the
// Length Constraints are Minimum of 1, Maximum of 12288.
//
// This member is required.
Content *string
// The type of the content. Supported types are text/plain , text/markdown ,
// application/json , and
// application/vnd.amazonaws.connect.message.interactive.response .
//
// This member is required.
ContentType *string
noSmithyDocumentSerde
}
// Configuration information for the chat participant role.
type ChatParticipantRoleConfig struct {
// A list of participant timers. You can specify any unique combination of role
// and timer type. Duplicate entries error out the request with a 400.
//
// This member is required.
ParticipantTimerConfigList []ParticipantTimerConfiguration
noSmithyDocumentSerde
}
// The streaming configuration, such as the Amazon SNS streaming endpoint.
type ChatStreamingConfiguration struct {
// The Amazon Resource Name (ARN) of the standard Amazon SNS topic. The Amazon
// Resource Name (ARN) of the streaming endpoint that is used to publish real-time
// message streaming for chat conversations.
//
// This member is required.
StreamingEndpointArn *string
noSmithyDocumentSerde
}
// Information about a phone number that has been claimed to your Amazon Connect
// instance or traffic distribution group.
type ClaimedPhoneNumberSummary struct {
// The identifier of the Amazon Connect instance that phone numbers are claimed
// to. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
InstanceId *string
// The phone number. Phone numbers are formatted [+] [country code] [subscriber
// number including area code] .
PhoneNumber *string
// The Amazon Resource Name (ARN) of the phone number.
PhoneNumberArn *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The description of the phone number.
PhoneNumberDescription *string
// A unique identifier for the phone number.
PhoneNumberId *string
// The status of the phone number.
// - CLAIMED means the previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html)
// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
// operation succeeded.
// - IN_PROGRESS means a ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html)
// , UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
// , or UpdatePhoneNumberMetadata (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html)
// operation is still in progress and has not yet completed. You can call
// DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html)
// at a later time to verify if the previous operation has completed.
// - FAILED indicates that the previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html)
// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
// operation has failed. It will include a message indicating the failure reason. A
// common reason for a failure may be that the TargetArn value you are claiming
// or updating a phone number to has reached its limit of total claimed numbers. If
// you received a FAILED status from a ClaimPhoneNumber API call, you have one
// day to retry claiming the phone number before the number is released back to the
// inventory for other customers to claim.
// You will not be billed for the phone number during the 1-day period if number
// claiming fails.
PhoneNumberStatus *PhoneNumberStatus
// The type of phone number.
PhoneNumberType PhoneNumberType
// The claimed phone number ARN that was previously imported from the external
// service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like
// the ARN of the phone number that was imported from Amazon Pinpoint.
SourcePhoneNumberArn *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
// distribution groups that phone number inbound traffic is routed through.
TargetArn *string
noSmithyDocumentSerde
}
// Information required to join the call.
type ConnectionData struct {
// The attendee information, including attendee ID and join token.
Attendee *Attendee
// A meeting created using the Amazon Chime SDK.
Meeting *Meeting
noSmithyDocumentSerde
}
// Contains information about a contact.
type Contact struct {
// Information about the agent who accepted the contact.
AgentInfo *AgentInfo
// The Amazon Resource Name (ARN) for the contact.
Arn *string
// How the contact reached your contact center.
Channel Channel
// The description of the contact.
Description *string
// The timestamp when the customer endpoint disconnected from Amazon Connect.
DisconnectTimestamp *time.Time
// The identifier for the contact.
Id *string
// If this contact is related to other contacts, this is the ID of the initial
// contact.
InitialContactId *string
// Indicates how the contact was initiated.
InitiationMethod ContactInitiationMethod
// The date and time this contact was initiated, in UTC time. For INBOUND , this is
// when the contact arrived. For OUTBOUND , this is when the agent began dialing.
// For CALLBACK , this is when the callback contact was created. For TRANSFER and
// QUEUE_TRANSFER , this is when the transfer was initiated. For API , this is when
// the request arrived. For EXTERNAL_OUTBOUND , this is when the agent started
// dialing the external participant. For MONITOR , this is when the supervisor
// started listening to a contact.
InitiationTimestamp *time.Time
// The timestamp when the contact was last paused.
LastPausedTimestamp *time.Time
// The timestamp when the contact was last resumed.
LastResumedTimestamp *time.Time
// The timestamp when contact was last updated.
LastUpdateTimestamp *time.Time
// The name of the contact.
Name *string
// If this contact is not the first contact, this is the ID of the previous
// contact.
PreviousContactId *string
// If this contact was queued, this contains information about the queue.
QueueInfo *QueueInfo
// An integer that represents the queue priority to be applied to the contact
// (lower priorities are routed preferentially). Cannot be specified if the
// QueueTimeAdjustmentSeconds is specified. Must be statically defined, must be
// larger than zero, and a valid integer value. Default Value is 5.
QueuePriority *int64
// An integer that represents the queue time adjust to be applied to the contact,
// in seconds (longer / larger queue time are routed preferentially). Cannot be
// specified if the QueuePriority is specified. Must be statically defined and a
// valid integer value.
QueueTimeAdjustmentSeconds *int32
// The contactId that is related (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html#relatedcontactid)
// to this contact.
RelatedContactId *string
// The timestamp, in Unix epoch time format, at which to start running the inbound
// flow.
ScheduledTimestamp *time.Time
// Tags associated with the contact. This contains both Amazon Web Services
// generated and user-defined tags.
Tags map[string]string
// Total pause count for a contact.
TotalPauseCount *int32
// Total pause duration for a contact in seconds.
TotalPauseDurationInSeconds *int32
// Information about Amazon Connect Wisdom.
WisdomInfo *WisdomInfo
noSmithyDocumentSerde
}
// A structure that defines search criteria for contacts using analysis outputs
// from Amazon Connect Contact Lens.
type ContactAnalysis struct {
// Search criteria based on transcript analyzed by Amazon Connect Contact Lens.
Transcript *Transcript
noSmithyDocumentSerde
}
// Request object with information to create a contact.
type ContactDataRequest struct {
// List of attributes to be stored in a contact.
Attributes map[string]string
// Structure to store information associated with a campaign.
Campaign *Campaign
// Endpoint of the customer for which contact will be initiated.
CustomerEndpoint *Endpoint
// The identifier of the queue associated with the Amazon Connect instance in
// which contacts that are created will be queued.
QueueId *string
// Identifier to uniquely identify individual requests in the batch.
RequestIdentifier *string
// Endpoint associated with the Amazon Connect instance from which outbound
// contact will be initiated for the campaign.
SystemEndpoint *Endpoint
noSmithyDocumentSerde
}
// Filters user data based on the contact information that is associated to the
// users. It contains a list of contact states (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html)
// .
type ContactFilter struct {
// A list of up to 9 contact states (https://docs.aws.amazon.com/connect/latest/adminguide/about-contact-states.html)
// .
ContactStates []ContactState
noSmithyDocumentSerde
}
// Contains information about a flow.
type ContactFlow struct {
// The Amazon Resource Name (ARN) of the flow.
Arn *string
// The JSON string that represents the content of the flow. For an example, see
// Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html)
// . Length Constraints: Minimum length of 1. Maximum length of 256000.
Content *string
// The description of the flow.
Description *string
// The identifier of the flow.
Id *string
// The name of the flow.
Name *string
// The type of flow.
State ContactFlowState
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The type of the flow. For descriptions of the available types, see Choose a
// flow type (https://docs.aws.amazon.com/connect/latest/adminguide/create-contact-flow.html#contact-flow-types)
// in the Amazon Connect Administrator Guide.
Type ContactFlowType
noSmithyDocumentSerde
}
// Contains information about a flow module.
type ContactFlowModule struct {
// The Amazon Resource Name (ARN).
Arn *string
// The JSON string that represents the content of the flow. For an example, see
// Example flow in Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language-example.html)
// .
Content *string
// The description of the flow module.
Description *string
// The identifier of the flow module.
Id *string
// The name of the flow module.
Name *string
// The type of flow module.
State ContactFlowModuleState
// The status of the flow module.
Status ContactFlowModuleStatus
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Contains summary information about a flow.
type ContactFlowModuleSummary struct {
// The Amazon Resource Name (ARN) of the flow module.
Arn *string
// The identifier of the flow module.
Id *string
// The name of the flow module.
Name *string
// The type of flow module.
State ContactFlowModuleState
noSmithyDocumentSerde
}
// Contains summary information about a flow. You can also create and update flows
// using the Amazon Connect Flow language (https://docs.aws.amazon.com/connect/latest/APIReference/flow-language.html)
// .
type ContactFlowSummary struct {
// The Amazon Resource Name (ARN) of the flow.
Arn *string
// The type of flow.
ContactFlowState ContactFlowState
// The type of flow.
ContactFlowType ContactFlowType
// The identifier of the flow.
Id *string
// The name of the flow.
Name *string
noSmithyDocumentSerde
}
// Information of returned contact.
type ContactSearchSummary struct {
// Information about the agent who accepted the contact.
AgentInfo *ContactSearchSummaryAgentInfo
// The Amazon Resource Name (ARN) of the contact.
Arn *string
// How the contact reached your contact center.
Channel Channel
// The timestamp when the customer endpoint disconnected from Amazon Connect.
DisconnectTimestamp *time.Time
// The identifier of the contact summary.
Id *string
// If this contact is related to other contacts, this is the ID of the initial
// contact.
InitialContactId *string
// Indicates how the contact was initiated.
InitiationMethod ContactInitiationMethod
// The date and time this contact was initiated, in UTC time. For INBOUND , this is
// when the contact arrived. For OUTBOUND , this is when the agent began dialing.
// For CALLBACK , this is when the callback contact was created. For TRANSFER and
// QUEUE_TRANSFER , this is when the transfer was initiated. For API, this is when
// the request arrived. For EXTERNAL_OUTBOUND , this is when the agent started
// dialing the external participant. For MONITOR , this is when the supervisor
// started listening to a contact.
InitiationTimestamp *time.Time
// If this contact is not the first contact, this is the ID of the previous
// contact.
PreviousContactId *string
// If this contact was queued, this contains information about the queue.
QueueInfo *ContactSearchSummaryQueueInfo
// The timestamp, in Unix epoch time format, at which to start running the inbound
// flow.
ScheduledTimestamp *time.Time
noSmithyDocumentSerde
}
// Information about the agent who accepted the contact.
type ContactSearchSummaryAgentInfo struct {
// The timestamp when the contact was connected to the agent.
ConnectedToAgentTimestamp *time.Time
// The identifier of the agent who accepted the contact.
Id *string
noSmithyDocumentSerde
}
// If this contact was queued, this contains information about the queue.
type ContactSearchSummaryQueueInfo struct {
// The timestamp when the contact was added to the queue.
EnqueueTimestamp *time.Time
// The unique identifier for the queue.
Id *string
noSmithyDocumentSerde
}
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
type ControlPlaneTagFilter struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []TagCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions [][]TagCondition
// A leaf node condition which can be used to specify a tag condition.
TagCondition *TagCondition
noSmithyDocumentSerde
}
// The CreateCase action definition.
type CreateCaseActionDefinition struct {
// An array of objects with Field ID and Value data.
//
// This member is required.
Fields []FieldValue
// A unique identifier of a template.
//
// This member is required.
TemplateId *string
noSmithyDocumentSerde
}
// Contains credentials to use for federation.
type Credentials struct {
// An access token generated for a federated user to access Amazon Connect.
AccessToken *string
// A token generated with an expiration time for the session a user is logged in
// to Amazon Connect.
AccessTokenExpiration *time.Time
// Renews a token generated for a user to access the Amazon Connect instance.
RefreshToken *string
// Renews the expiration timer for a generated token.
RefreshTokenExpiration *time.Time
noSmithyDocumentSerde
}
// Defines the cross-channel routing behavior that allows an agent working on a
// contact in one channel to be offered a contact from a different channel.
type CrossChannelBehavior struct {
// Specifies the other channels that can be routed to an agent handling their
// current channel.
//
// This member is required.
BehaviorType BehaviorType
noSmithyDocumentSerde
}
// Contains information about a real-time metric. For a description of each
// metric, see Real-time Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/real-time-metrics-definitions.html)
// in the Amazon Connect Administrator Guide.
type CurrentMetric struct {
// The name of the metric.
Name CurrentMetricName
// The unit for the metric.
Unit Unit
noSmithyDocumentSerde
}
// Contains the data for a real-time metric.
type CurrentMetricData struct {
// Information about the metric.
Metric *CurrentMetric
// The value of the metric.
Value *float64
noSmithyDocumentSerde
}
// Contains information about a set of real-time metrics.
type CurrentMetricResult struct {
// The set of metrics.
Collections []CurrentMetricData
// The dimensions for the metrics.
Dimensions *Dimensions
noSmithyDocumentSerde
}
// The way to sort the resulting response based on metrics. By default resources
// are sorted based on AGENTS_ONLINE , DESCENDING . The metric collection is sorted
// based on the input metrics.
type CurrentMetricSortCriteria struct {
// The current metric names.
SortByMetric CurrentMetricName
// The way to sort.
SortOrder SortOrder
noSmithyDocumentSerde
}
// Information about a reference when the referenceType is DATE . Otherwise, null.
type DateReference struct {
// Identifier of the date reference.
Name *string
// A valid date.
Value *string
noSmithyDocumentSerde
}
// Contains information about a default vocabulary.
type DefaultVocabulary struct {
// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
//
// This member is required.
InstanceId *string
// The language code of the vocabulary entries. For a list of languages and their
// corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)
//
// This member is required.
LanguageCode VocabularyLanguageCode
// The identifier of the custom vocabulary.
//
// This member is required.
VocabularyId *string
// A unique name of the custom vocabulary.
//
// This member is required.
VocabularyName *string
noSmithyDocumentSerde
}
// Contains information about the dimensions for a set of metrics.
type Dimensions struct {
// The channel used for grouping and filters.
Channel Channel
// Information about the queue for which metrics are returned.
Queue *QueueReference
// Information about the routing profile assigned to the user.
RoutingProfile *RoutingProfileReference
// The expression of a step in a routing criteria.
RoutingStepExpression *string
noSmithyDocumentSerde
}
// Contains details about why a contact was disconnected. Only Amazon Connect
// outbound campaigns can provide this field.
type DisconnectReason struct {
// A code that indicates how the contact was terminated.
Code *string
noSmithyDocumentSerde
}
// Information about a traffic distribution.
type Distribution struct {
// The percentage of the traffic that is distributed, in increments of 10.
//
// This member is required.
Percentage int32
// The Amazon Web Services Region where the traffic is distributed.
//
// This member is required.
Region *string
noSmithyDocumentSerde
}
// Information about a reference when the referenceType is EMAIL . Otherwise, null.
type EmailReference struct {
// Identifier of the email reference.
Name *string
// A valid email address.
Value *string
noSmithyDocumentSerde
}
// An empty value.
type EmptyFieldValue struct {
noSmithyDocumentSerde
}
// The encryption configuration.
type EncryptionConfig struct {
// The type of encryption.
//
// This member is required.
EncryptionType EncryptionType
// The full ARN of the encryption key. Be sure to provide the full ARN of the
// encryption key, not just the ID. Amazon Connect supports only KMS keys with the
// default key spec of SYMMETRIC_DEFAULT (https://docs.aws.amazon.com/kms/latest/developerguide/asymmetric-key-specs.html#key-spec-symmetric-default)
// .
//
// This member is required.
KeyId *string
noSmithyDocumentSerde
}
// End associated tasks related to a case.
type EndAssociatedTasksActionDefinition struct {
noSmithyDocumentSerde
}
// Information about the endpoint.
type Endpoint struct {
// Address of the endpoint.
Address *string
// Type of the endpoint.
Type EndpointType
noSmithyDocumentSerde
}
// This API is in preview release for Amazon Connect and is subject to change.
// List of errors for dataset association failures.
type ErrorResult struct {
// The error code.
ErrorCode *string
// The corresponding error message for the error code.
ErrorMessage *string
noSmithyDocumentSerde
}
// Information about a contact evaluation.
type Evaluation struct {
// A map of question identifiers to answer value.
//
// This member is required.
Answers map[string]EvaluationAnswerOutput
// The timestamp for when the evaluation was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the contact evaluation resource.
//
// This member is required.
EvaluationArn *string
// A unique identifier for the contact evaluation.
//
// This member is required.
EvaluationId *string
// The timestamp for when the evaluation was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// Metadata about the contact evaluation.
//
// This member is required.
Metadata *EvaluationMetadata
// A map of question identifiers to note value.
//
// This member is required.
Notes map[string]EvaluationNote
// The status of the contact evaluation.
//
// This member is required.
Status EvaluationStatus
// A map of item (section or question) identifiers to score value.
Scores map[string]EvaluationScore
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Information about answer data for a contact evaluation. Answer data must be
// either string, numeric, or not applicable.
//
// The following types satisfy this interface:
//
// EvaluationAnswerDataMemberNotApplicable
// EvaluationAnswerDataMemberNumericValue
// EvaluationAnswerDataMemberStringValue
type EvaluationAnswerData interface {
isEvaluationAnswerData()
}
// The flag to mark the question as not applicable.
type EvaluationAnswerDataMemberNotApplicable struct {
Value bool
noSmithyDocumentSerde
}
func (*EvaluationAnswerDataMemberNotApplicable) isEvaluationAnswerData() {}
// The numeric value for an answer in a contact evaluation.
type EvaluationAnswerDataMemberNumericValue struct {
Value float64
noSmithyDocumentSerde
}
func (*EvaluationAnswerDataMemberNumericValue) isEvaluationAnswerData() {}
// The string value for an answer in a contact evaluation.
type EvaluationAnswerDataMemberStringValue struct {
Value string
noSmithyDocumentSerde
}
func (*EvaluationAnswerDataMemberStringValue) isEvaluationAnswerData() {}
// Information about input answers for a contact evaluation.
type EvaluationAnswerInput struct {
// The value for an answer in a contact evaluation.
Value EvaluationAnswerData
noSmithyDocumentSerde
}
// Information about output answers for a contact evaluation.
type EvaluationAnswerOutput struct {
// The system suggested value for an answer in a contact evaluation.
SystemSuggestedValue EvaluationAnswerData
// The value for an answer in a contact evaluation.
Value EvaluationAnswerData
noSmithyDocumentSerde
}
// Information about the evaluation form.
type EvaluationForm struct {
// The Amazon Resource Name (ARN) of the user who created the evaluation form.
//
// This member is required.
CreatedBy *string
// The timestamp for when the evaluation form was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A version of the evaluation form.
//
// This member is required.
EvaluationFormVersion int32
// Items that are part of the evaluation form. The total number of sections and
// questions must not exceed 100 each. Questions must be contained in a section.
//
// This member is required.
Items []EvaluationFormItem
// The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
//
// This member is required.
LastModifiedBy *string
// The timestamp for when the evaluation form was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The flag indicating whether the evaluation form is locked for changes.
//
// This member is required.
Locked bool
// The status of the evaluation form.
//
// This member is required.
Status EvaluationFormVersionStatus
// A title of the evaluation form.
//
// This member is required.
Title *string
// The description of the evaluation form.
Description *string
// A scoring strategy of the evaluation form.
ScoringStrategy *EvaluationFormScoringStrategy
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Information about an evaluation form used in a contact evaluation.
type EvaluationFormContent struct {
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A version of the evaluation form.
//
// This member is required.
EvaluationFormVersion int32
// Items that are part of the evaluation form. The total number of sections and
// questions must not exceed 100 each. Questions must be contained in a section.
//
// This member is required.
Items []EvaluationFormItem
// A title of the evaluation form.
//
// This member is required.
Title *string
// The description of the evaluation form.
Description *string
// A scoring strategy of the evaluation form.
ScoringStrategy *EvaluationFormScoringStrategy
noSmithyDocumentSerde
}
// Information about an item from an evaluation form. The item must be either a
// section or a question.
//
// The following types satisfy this interface:
//
// EvaluationFormItemMemberQuestion
// EvaluationFormItemMemberSection
type EvaluationFormItem interface {
isEvaluationFormItem()
}
// The information of the question.
type EvaluationFormItemMemberQuestion struct {
Value EvaluationFormQuestion
noSmithyDocumentSerde
}
func (*EvaluationFormItemMemberQuestion) isEvaluationFormItem() {}
// The information of the section.
type EvaluationFormItemMemberSection struct {
Value EvaluationFormSection
noSmithyDocumentSerde
}
func (*EvaluationFormItemMemberSection) isEvaluationFormItem() {}
// Information about the automation configuration in numeric questions.
//
// The following types satisfy this interface:
//
// EvaluationFormNumericQuestionAutomationMemberPropertyValue
type EvaluationFormNumericQuestionAutomation interface {
isEvaluationFormNumericQuestionAutomation()
}
// The property value of the automation.
type EvaluationFormNumericQuestionAutomationMemberPropertyValue struct {
Value NumericQuestionPropertyValueAutomation
noSmithyDocumentSerde
}
func (*EvaluationFormNumericQuestionAutomationMemberPropertyValue) isEvaluationFormNumericQuestionAutomation() {
}
// Information about the option range used for scoring in numeric questions.
type EvaluationFormNumericQuestionOption struct {
// The maximum answer value of the range option.
//
// This member is required.
MaxValue int32
// The minimum answer value of the range option.
//
// This member is required.
MinValue int32
// The flag to mark the option as automatic fail. If an automatic fail answer is
// provided, the overall evaluation gets a score of 0.
AutomaticFail bool
// The score assigned to answer values within the range option.
Score int32
noSmithyDocumentSerde
}
// Information about properties for a numeric question in an evaluation form.
type EvaluationFormNumericQuestionProperties struct {
// The maximum answer value.
//
// This member is required.
MaxValue int32
// The minimum answer value.
//
// This member is required.
MinValue int32
// The automation properties of the numeric question.
Automation EvaluationFormNumericQuestionAutomation
// The scoring options of the numeric question.
Options []EvaluationFormNumericQuestionOption
noSmithyDocumentSerde
}
// Information about a question from an evaluation form.
type EvaluationFormQuestion struct {
// The type of the question.
//
// This member is required.
QuestionType EvaluationFormQuestionType
// The identifier of the question. An identifier must be unique within the
// evaluation form.
//
// This member is required.
RefId *string
// The title of the question.
//
// This member is required.
Title *string
// The instructions of the section.
Instructions *string
// The flag to enable not applicable answers to the question.
NotApplicableEnabled bool
// The properties of the type of question. Text questions do not have to define
// question type properties.
QuestionTypeProperties EvaluationFormQuestionTypeProperties
// The scoring weight of the section.
Weight float64
noSmithyDocumentSerde
}
// Information about properties for a question in an evaluation form. The question
// type properties must be either for a numeric question or a single select
// question.
//
// The following types satisfy this interface:
//
// EvaluationFormQuestionTypePropertiesMemberNumeric
// EvaluationFormQuestionTypePropertiesMemberSingleSelect
type EvaluationFormQuestionTypeProperties interface {
isEvaluationFormQuestionTypeProperties()
}
// The properties of the numeric question.
type EvaluationFormQuestionTypePropertiesMemberNumeric struct {
Value EvaluationFormNumericQuestionProperties
noSmithyDocumentSerde
}
func (*EvaluationFormQuestionTypePropertiesMemberNumeric) isEvaluationFormQuestionTypeProperties() {}
// The properties of the numeric question.
type EvaluationFormQuestionTypePropertiesMemberSingleSelect struct {
Value EvaluationFormSingleSelectQuestionProperties
noSmithyDocumentSerde
}
func (*EvaluationFormQuestionTypePropertiesMemberSingleSelect) isEvaluationFormQuestionTypeProperties() {
}
// Information about scoring strategy for an evaluation form.
type EvaluationFormScoringStrategy struct {
// The scoring mode of the evaluation form.
//
// This member is required.
Mode EvaluationFormScoringMode
// The scoring status of the evaluation form.
//
// This member is required.
Status EvaluationFormScoringStatus
noSmithyDocumentSerde
}
// Information about a section from an evaluation form. A section can contain
// sections and/or questions. Evaluation forms can only contain sections and
// subsections (two level nesting).
type EvaluationFormSection struct {
// The items of the section.
//
// This member is required.
Items []EvaluationFormItem
// The identifier of the section. An identifier must be unique within the
// evaluation form.
//
// This member is required.
RefId *string
// The title of the section.
//
// This member is required.
Title *string
// The instructions of the section.
Instructions *string
// The scoring weight of the section.
Weight float64
noSmithyDocumentSerde
}
// Information about the automation configuration in single select questions.
// Automation options are evaluated in order, and the first matched option is
// applied. If no automation option matches, and there is a default option, then
// the default option is applied.
type EvaluationFormSingleSelectQuestionAutomation struct {
// The automation options of the single select question.
//
// This member is required.
Options []EvaluationFormSingleSelectQuestionAutomationOption
// The identifier of the default answer option, when none of the automation
// options match the criteria.
DefaultOptionRefId *string
noSmithyDocumentSerde
}
// Information about the automation option of a single select question.
//
// The following types satisfy this interface:
//
// EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory
type EvaluationFormSingleSelectQuestionAutomationOption interface {
isEvaluationFormSingleSelectQuestionAutomationOption()
}
// The automation option based on a rule category for the single select question.
type EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory struct {
Value SingleSelectQuestionRuleCategoryAutomation
noSmithyDocumentSerde
}
func (*EvaluationFormSingleSelectQuestionAutomationOptionMemberRuleCategory) isEvaluationFormSingleSelectQuestionAutomationOption() {
}
// Information about the automation configuration in single select questions.
type EvaluationFormSingleSelectQuestionOption struct {
// The identifier of the answer option. An identifier must be unique within the
// question.
//
// This member is required.
RefId *string
// The title of the answer option.
//
// This member is required.
Text *string
// The flag to mark the option as automatic fail. If an automatic fail answer is
// provided, the overall evaluation gets a score of 0.
AutomaticFail bool
// The score assigned to the answer option.
Score int32
noSmithyDocumentSerde
}
// Information about the options in single select questions.
type EvaluationFormSingleSelectQuestionProperties struct {
// The answer options of the single select question.
//
// This member is required.
Options []EvaluationFormSingleSelectQuestionOption
// The display mode of the single select question.
Automation *EvaluationFormSingleSelectQuestionAutomation
// The display mode of the single select question.
DisplayAs EvaluationFormSingleSelectQuestionDisplayMode
noSmithyDocumentSerde
}
// Summary information about an evaluation form.
type EvaluationFormSummary struct {
// The Amazon Resource Name (ARN) of the user who created the evaluation form.
//
// This member is required.
CreatedBy *string
// The timestamp for when the evaluation form was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
//
// This member is required.
LastModifiedBy *string
// The timestamp for when the evaluation form was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The version number of the latest evaluation form version.
//
// This member is required.
LatestVersion int32
// A title of the evaluation form.
//
// This member is required.
Title *string
// The version of the active evaluation form version.
ActiveVersion *int32
// The Amazon Resource Name (ARN) of the user who last activated the evaluation
// form.
LastActivatedBy *string
// The timestamp for when the evaluation form was last activated.
LastActivatedTime *time.Time
noSmithyDocumentSerde
}
// Summary information about an evaluation form.
type EvaluationFormVersionSummary struct {
// The Amazon Resource Name (ARN) of the user who created the evaluation form.
//
// This member is required.
CreatedBy *string
// The timestamp for when the evaluation form was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the evaluation form resource.
//
// This member is required.
EvaluationFormArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A version of the evaluation form.
//
// This member is required.
EvaluationFormVersion int32
// The Amazon Resource Name (ARN) of the user who last updated the evaluation form.
//
// This member is required.
LastModifiedBy *string
// The timestamp for when the evaluation form was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The flag indicating whether the evaluation form is locked for changes.
//
// This member is required.
Locked bool
// The status of the evaluation form.
//
// This member is required.
Status EvaluationFormVersionStatus
noSmithyDocumentSerde
}
// Metadata information about a contact evaluation.
type EvaluationMetadata struct {
// The identifier of the contact in this instance of Amazon Connect.
//
// This member is required.
ContactId *string
// The Amazon Resource Name (ARN) of the user who last updated the evaluation.
//
// This member is required.
EvaluatorArn *string
// The identifier of the agent who performed the contact.
ContactAgentId *string
// The overall score of the contact evaluation.
Score *EvaluationScore
noSmithyDocumentSerde
}
// Information about notes for a contact evaluation.
type EvaluationNote struct {
// The note for an item (section or question) in a contact evaluation.
Value *string
noSmithyDocumentSerde
}
// Information about scores of a contact evaluation item (section or question).
type EvaluationScore struct {
// The flag that marks the item as automatic fail. If the item or a child item
// gets an automatic fail answer, this flag will be true.
AutomaticFail bool
// The flag to mark the item as not applicable for scoring.
NotApplicable bool
// The score percentage for an item in a contact evaluation.
Percentage float64
noSmithyDocumentSerde
}
// Summary information about a contact evaluation.
type EvaluationSummary struct {
// The timestamp for when the evaluation was created.
//
// This member is required.
CreatedTime *time.Time
// The Amazon Resource Name (ARN) for the contact evaluation resource.
//
// This member is required.
EvaluationArn *string
// The unique identifier for the evaluation form.
//
// This member is required.
EvaluationFormId *string
// A title of the evaluation form.
//
// This member is required.
EvaluationFormTitle *string
// A unique identifier for the contact evaluation.
//
// This member is required.
EvaluationId *string
// The Amazon Resource Name (ARN) of the user who last updated the evaluation.
//
// This member is required.
EvaluatorArn *string
// The timestamp for when the evaluation was last updated.
//
// This member is required.
LastModifiedTime *time.Time
// The status of the contact evaluation.
//
// This member is required.
Status EvaluationStatus
// The overall score of the contact evaluation.
Score *EvaluationScore
noSmithyDocumentSerde
}
// The EventBridge action definition.
type EventBridgeActionDefinition struct {
// The name.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// Request for which contact failed to be generated.
type FailedRequest struct {
// Reason code for the failure.
FailureReasonCode FailureReasonCode
// Why the request to create a contact failed.
FailureReasonMessage *string
// Request identifier provided in the API call in the ContactDataRequest to create
// a contact.
RequestIdentifier *string
noSmithyDocumentSerde
}
// Object for case field values.
type FieldValue struct {
// Unique identifier of a field.
//
// This member is required.
Id *string
// Union of potential field value types.
//
// This member is required.
Value *FieldValueUnion
noSmithyDocumentSerde
}
// Object to store union of Field values.
type FieldValueUnion struct {
// A Boolean number value type.
BooleanValue bool
// a Double number value type.
DoubleValue *float64
// An empty value.
EmptyValue *EmptyFieldValue
// String value type.
StringValue *string
noSmithyDocumentSerde
}
// Contains the filter to apply when retrieving metrics.
type Filters struct {
// The channel to use to filter the metrics.
Channels []Channel
// The queues to use to filter the metrics. You should specify at least one queue,
// and can specify up to 100 queues per request. The GetCurrentMetricsData API in
// particular requires a queue when you include a Filter in your request.
Queues []string
// A list of up to 100 routing profile IDs or ARNs.
RoutingProfiles []string
// A list of expressions as a filter, in which an expression is an object of a
// step in a routing criteria.
RoutingStepExpressions []string
noSmithyDocumentSerde
}
// Contains the filter to apply when retrieving metrics with the GetMetricDataV2 (https://docs.aws.amazon.com/connect/latest/APIReference/API_GetMetricDataV2.html)
// API.
type FilterV2 struct {
// The key to use for filtering data. For example, QUEUE , ROUTING_PROFILE, AGENT ,
// CHANNEL , AGENT_HIERARCHY_LEVEL_ONE , AGENT_HIERARCHY_LEVEL_TWO ,
// AGENT_HIERARCHY_LEVEL_THREE , AGENT_HIERARCHY_LEVEL_FOUR ,
// AGENT_HIERARCHY_LEVEL_FIVE . There must be at least 1 key and a maximum 5 keys.
FilterKey *string
// The identifiers to use for filtering data. For example, if you have a filter
// key of QUEUE , you would add queue IDs or ARNs in FilterValues .
FilterValues []string
noSmithyDocumentSerde
}
// Information about flow associations.
type FlowAssociationSummary struct {
// The identifier of the flow.
FlowId *string
// The identifier of the resource.
ResourceId *string
// The type of resource association.
ResourceType ListFlowAssociationResourceType
noSmithyDocumentSerde
}
// Contains information about a hierarchy group.
type HierarchyGroup struct {
// The Amazon Resource Name (ARN) of the hierarchy group.
Arn *string
// Information about the levels in the hierarchy group.
HierarchyPath *HierarchyPath
// The identifier of the hierarchy group.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The identifier of the level in the hierarchy group.
LevelId *string
// The name of the hierarchy group.
Name *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// A leaf node condition which can be used to specify a hierarchy group condition.
type HierarchyGroupCondition struct {
// The type of hierarchy group match.
HierarchyGroupMatchType HierarchyGroupMatchType
// The value in the hierarchy group condition.
Value *string
noSmithyDocumentSerde
}
// Contains summary information about a hierarchy group.
type HierarchyGroupSummary struct {
// The Amazon Resource Name (ARN) of the hierarchy group.
Arn *string
// The identifier of the hierarchy group.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the hierarchy group.
Name *string
noSmithyDocumentSerde
}
// Information about the hierarchy group.
type HierarchyGroupSummaryReference struct {
// The Amazon Resource Name (ARN) for the hierarchy group.
Arn *string
// The unique identifier for the hierarchy group.
Id *string
noSmithyDocumentSerde
}
// Contains information about a hierarchy level.
type HierarchyLevel struct {
// The Amazon Resource Name (ARN) of the hierarchy level.
Arn *string
// The identifier of the hierarchy level.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the hierarchy level.
Name *string
noSmithyDocumentSerde
}
// Contains information about the hierarchy level to update.
type HierarchyLevelUpdate struct {
// The name of the user hierarchy level. Must not be more than 50 characters.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// Contains information about the levels of a hierarchy group.
type HierarchyPath struct {
// Information about level five.
LevelFive *HierarchyGroupSummary
// Information about level four.
LevelFour *HierarchyGroupSummary
// Information about level one.
LevelOne *HierarchyGroupSummary
// Information about level three.
LevelThree *HierarchyGroupSummary
// Information about level two.
LevelTwo *HierarchyGroupSummary
noSmithyDocumentSerde
}
// Information about the levels in the hierarchy group.
type HierarchyPathReference struct {
// Information about level five.
LevelFive *HierarchyGroupSummaryReference
// Information about level four.
LevelFour *HierarchyGroupSummaryReference
// Information about level one.
LevelOne *HierarchyGroupSummaryReference
// Information about level three.
LevelThree *HierarchyGroupSummaryReference
// Information about level two.
LevelTwo *HierarchyGroupSummaryReference
noSmithyDocumentSerde
}
// Contains information about a hierarchy structure.
type HierarchyStructure struct {
// Information about level five.
LevelFive *HierarchyLevel
// Information about level four.
LevelFour *HierarchyLevel
// Information about level one.
LevelOne *HierarchyLevel
// Information about level three.
LevelThree *HierarchyLevel
// Information about level two.
LevelTwo *HierarchyLevel
noSmithyDocumentSerde
}
// Contains information about the level hierarchy to update.
type HierarchyStructureUpdate struct {
// The update for level five.
LevelFive *HierarchyLevelUpdate
// The update for level four.
LevelFour *HierarchyLevelUpdate
// The update for level one.
LevelOne *HierarchyLevelUpdate
// The update for level three.
LevelThree *HierarchyLevelUpdate
// The update for level two.
LevelTwo *HierarchyLevelUpdate
noSmithyDocumentSerde
}
// Contains information about a historical metric. For a description of each
// metric, see Historical Metrics Definitions (https://docs.aws.amazon.com/connect/latest/adminguide/historical-metrics-definitions.html)
// in the Amazon Connect Administrator Guide.
type HistoricalMetric struct {
// The name of the metric.
Name HistoricalMetricName
// The statistic for the metric.
Statistic Statistic
// The threshold for the metric, used with service level metrics.
Threshold *Threshold
// The unit for the metric.
Unit Unit
noSmithyDocumentSerde
}
// Contains the data for a historical metric.
type HistoricalMetricData struct {
// Information about the metric.
Metric *HistoricalMetric
// The value of the metric.
Value *float64
noSmithyDocumentSerde
}
// Contains information about the historical metrics retrieved.
type HistoricalMetricResult struct {
// The set of metrics.
Collections []HistoricalMetricData
// The dimension for the metrics.
Dimensions *Dimensions
noSmithyDocumentSerde
}
// Information about of the hours of operation.
type HoursOfOperation struct {
// Configuration information for the hours of operation.
Config []HoursOfOperationConfig
// The description for the hours of operation.
Description *string
// The Amazon Resource Name (ARN) for the hours of operation.
HoursOfOperationArn *string
// The identifier for the hours of operation.
HoursOfOperationId *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name for the hours of operation.
Name *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The time zone for the hours of operation.
TimeZone *string
noSmithyDocumentSerde
}
// Contains information about the hours of operation.
type HoursOfOperationConfig struct {
// The day that the hours of operation applies to.
//
// This member is required.
Day HoursOfOperationDays
// The end time that your contact center closes.
//
// This member is required.
EndTime *HoursOfOperationTimeSlice
// The start time that your contact center opens.
//
// This member is required.
StartTime *HoursOfOperationTimeSlice
noSmithyDocumentSerde
}
// The search criteria to be used to return hours of operations.
type HoursOfOperationSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []HoursOfOperationSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []HoursOfOperationSearchCriteria
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name , description , timezone , and
// resourceID .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Filters to be applied to search results.
type HoursOfOperationSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
noSmithyDocumentSerde
}
// Contains summary information about hours of operation for a contact center.
type HoursOfOperationSummary struct {
// The Amazon Resource Name (ARN) of the hours of operation.
Arn *string
// The identifier of the hours of operation.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the hours of operation.
Name *string
noSmithyDocumentSerde
}
// The start time or end time for an hours of operation.
type HoursOfOperationTimeSlice struct {
// The hours.
//
// This member is required.
Hours *int32
// The minutes.
//
// This member is required.
Minutes *int32
noSmithyDocumentSerde
}
// The Amazon Connect instance.
type Instance struct {
// The Amazon Resource Name (ARN) of the instance.
Arn *string
// When the instance was created.
CreatedTime *time.Time
// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
Id *string
// The identity management type.
IdentityManagementType DirectoryType
// Whether inbound calls are enabled.
InboundCallsEnabled *bool
// This URL allows contact center users to access the Amazon Connect admin website.
InstanceAccessUrl *string
// The alias of instance.
InstanceAlias *string
// The state of the instance.
InstanceStatus InstanceStatus
// Whether outbound calls are enabled.
OutboundCallsEnabled *bool
// The service role of the instance.
ServiceRole *string
// Relevant details why the instance was not successfully created.
StatusReason *InstanceStatusReason
// The tags of an instance.
Tags map[string]string
noSmithyDocumentSerde
}
// Relevant details why the instance was not successfully created.
type InstanceStatusReason struct {
// The message.
Message *string
noSmithyDocumentSerde
}
// The storage configuration for the instance.
type InstanceStorageConfig struct {
// A valid storage type.
//
// This member is required.
StorageType StorageType
// The existing association identifier that uniquely identifies the resource type
// and storage config for the given instance ID.
AssociationId *string
// The configuration of the Kinesis Firehose delivery stream.
KinesisFirehoseConfig *KinesisFirehoseConfig
// The configuration of the Kinesis data stream.
KinesisStreamConfig *KinesisStreamConfig
// The configuration of the Kinesis video stream.
KinesisVideoStreamConfig *KinesisVideoStreamConfig
// The S3 bucket configuration.
S3Config *S3Config
noSmithyDocumentSerde
}
// Information about the instance.
type InstanceSummary struct {
// The Amazon Resource Name (ARN) of the instance.
Arn *string
// When the instance was created.
CreatedTime *time.Time
// The identifier of the instance.
Id *string
// The identity management type of the instance.
IdentityManagementType DirectoryType
// Whether inbound calls are enabled.
InboundCallsEnabled *bool
// This URL allows contact center users to access the Amazon Connect admin website.
InstanceAccessUrl *string
// The alias of the instance.
InstanceAlias *string
// The state of the instance.
InstanceStatus InstanceStatus
// Whether outbound calls are enabled.
OutboundCallsEnabled *bool
// The service role of the instance.
ServiceRole *string
noSmithyDocumentSerde
}
// Contains summary information about the associated AppIntegrations.
type IntegrationAssociationSummary struct {
// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
InstanceId *string
// The Amazon Resource Name (ARN) for the AppIntegration.
IntegrationArn *string
// The Amazon Resource Name (ARN) for the AppIntegration association.
IntegrationAssociationArn *string
// The identifier for the AppIntegration association.
IntegrationAssociationId *string
// The integration type.
IntegrationType IntegrationType
// The user-provided, friendly name for the external application.
SourceApplicationName *string
// The URL for the external application.
SourceApplicationUrl *string
// The name of the source.
SourceType SourceType
noSmithyDocumentSerde
}
// Information about the interval period to use for returning results.
type IntervalDetails struct {
// IntervalPeriod : An aggregated grouping applied to request metrics. Valid
// IntervalPeriod values are: FIFTEEN_MIN | THIRTY_MIN | HOUR | DAY | WEEK | TOTAL
// . For example, if IntervalPeriod is selected THIRTY_MIN , StartTime and EndTime
// differs by 1 day, then Amazon Connect returns 48 results in the response. Each
// result is aggregated by the THIRTY_MIN period. By default Amazon Connect
// aggregates results based on the TOTAL interval period. The following list
// describes restrictions on StartTime and EndTime based on what IntervalPeriod is
// requested.
// - FIFTEEN_MIN : The difference between StartTime and EndTime must be less than
// 3 days.
// - THIRTY_MIN : The difference between StartTime and EndTime must be less than
// 3 days.
// - HOUR : The difference between StartTime and EndTime must be less than 3
// days.
// - DAY : The difference between StartTime and EndTime must be less than 35
// days.
// - WEEK : The difference between StartTime and EndTime must be less than 35
// days.
// - TOTAL : The difference between StartTime and EndTime must be less than 35
// days.
IntervalPeriod IntervalPeriod
// The timezone applied to requested metrics.
TimeZone *string
noSmithyDocumentSerde
}
// A field that is invisible to an agent.
type InvisibleFieldInfo struct {
// Identifier of the invisible field.
Id *TaskTemplateFieldIdentifier
noSmithyDocumentSerde
}
// Configuration information of a Kinesis Data Firehose delivery stream.
type KinesisFirehoseConfig struct {
// The Amazon Resource Name (ARN) of the delivery stream.
//
// This member is required.
FirehoseArn *string
noSmithyDocumentSerde
}
// Configuration information of a Kinesis data stream.
type KinesisStreamConfig struct {
// The Amazon Resource Name (ARN) of the data stream.
//
// This member is required.
StreamArn *string
noSmithyDocumentSerde
}
// Configuration information of a Kinesis video stream.
type KinesisVideoStreamConfig struct {
// The encryption configuration.
//
// This member is required.
EncryptionConfig *EncryptionConfig
// The prefix of the video stream.
//
// This member is required.
Prefix *string
// The number of hours data is retained in the stream. Kinesis Video Streams
// retains the data in a data store that is associated with the stream. The default
// value is 0, indicating that the stream does not persist data.
//
// This member is required.
RetentionPeriodHours int32
noSmithyDocumentSerde
}
// Configuration information of an Amazon Lex bot.
type LexBot struct {
// The Amazon Web Services Region where the Amazon Lex bot was created.
//
// This member is required.
LexRegion *string
// The name of the Amazon Lex bot.
//
// This member is required.
Name *string
noSmithyDocumentSerde
}
// Configuration information of an Amazon Lex or Amazon Lex V2 bot.
type LexBotConfig struct {
// Configuration information of an Amazon Lex bot.
LexBot *LexBot
// Configuration information of an Amazon Lex V2 bot.
LexV2Bot *LexV2Bot
noSmithyDocumentSerde
}
// Configuration information of an Amazon Lex V2 bot.
type LexV2Bot struct {
// The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
AliasArn *string
noSmithyDocumentSerde
}
// Information about phone numbers that have been claimed to your Amazon Connect
// instance or traffic distribution group.
type ListPhoneNumbersSummary struct {
// The identifier of the Amazon Connect instance that phone numbers are claimed
// to. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
InstanceId *string
// The phone number. Phone numbers are formatted [+] [country code] [subscriber
// number including area code] .
PhoneNumber *string
// The Amazon Resource Name (ARN) of the phone number.
PhoneNumberArn *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The description of the phone number.
PhoneNumberDescription *string
// A unique identifier for the phone number.
PhoneNumberId *string
// The type of phone number.
PhoneNumberType PhoneNumberType
// The claimed phone number ARN that was previously imported from the external
// service, such as Amazon Pinpoint. If it is from Amazon Pinpoint, it looks like
// the ARN of the phone number that was imported from Amazon Pinpoint.
SourcePhoneNumberArn *string
// The Amazon Resource Name (ARN) for Amazon Connect instances or traffic
// distribution groups that phone number inbound traffic is routed through.
TargetArn *string
noSmithyDocumentSerde
}
// Contains information about which channels are supported, and how many contacts
// an agent can have on a channel simultaneously.
type MediaConcurrency struct {
// The channels that agents can handle in the Contact Control Panel (CCP).
//
// This member is required.
Channel Channel
// The number of contacts an agent can have on a channel simultaneously. Valid
// Range for VOICE : Minimum value of 1. Maximum value of 1. Valid Range for CHAT :
// Minimum value of 1. Maximum value of 10. Valid Range for TASK : Minimum value of
// 1. Maximum value of 10.
//
// This member is required.
Concurrency *int32
// Defines the cross-channel routing behavior for each channel that is enabled for
// this Routing Profile. For example, this allows you to offer an agent a different
// contact from another channel when they are currently working with a contact from
// a Voice channel.
CrossChannelBehavior *CrossChannelBehavior
noSmithyDocumentSerde
}
// A set of endpoints used by clients to connect to the media service group for an
// Amazon Chime SDK meeting.
type MediaPlacement struct {
// The audio fallback URL.
AudioFallbackUrl *string
// The audio host URL.
AudioHostUrl *string
// The event ingestion URL to which you send client meeting events.
EventIngestionUrl *string
// The signaling URL.
SignalingUrl *string
// The turn control URL.
TurnControlUrl *string
noSmithyDocumentSerde
}
// A meeting created using the Amazon Chime SDK.
type Meeting struct {
// The media placement for the meeting.
MediaPlacement *MediaPlacement
// The Amazon Web Services Region in which you create the meeting.
MediaRegion *string
// The configuration settings of the features available to a meeting.
MeetingFeatures *MeetingFeaturesConfiguration
// The Amazon Chime SDK meeting ID.
MeetingId *string
noSmithyDocumentSerde
}
// The configuration settings of the features available to a meeting.
type MeetingFeaturesConfiguration struct {
// The configuration settings for the audio features available to a meeting.
Audio *AudioFeatures
noSmithyDocumentSerde
}
// Contains the name, thresholds, and metric filters.
type MetricDataV2 struct {
// The metric name, thresholds, and metric filters of the returned metric.
Metric *MetricV2
// The corresponding value of the metric returned in the response.
Value *float64
noSmithyDocumentSerde
}
// Contains information about the filter used when retrieving metrics.
// MetricFiltersV2 can be used on the following metrics: AVG_AGENT_CONNECTING_TIME
// , CONTACTS_CREATED , CONTACTS_HANDLED , SUM_CONTACTS_DISCONNECTED .
type MetricFilterV2 struct {
// The key to use for filtering data. Valid metric filter keys: INITIATION_METHOD ,
// DISCONNECT_REASON . These are the same values as the InitiationMethod and
// DisconnectReason in the contact record. For more information, see
// ContactTraceRecord (https://docs.aws.amazon.com/connect/latest/adminguide/ctr-data-model.html#ctr-ContactTraceRecord)
// in the Amazon Connect Administrator's Guide.
MetricFilterKey *string
// The values to use for filtering data. Valid metric filter values for
// INITIATION_METHOD : INBOUND | OUTBOUND | TRANSFER | QUEUE_TRANSFER | CALLBACK |
// API Valid metric filter values for DISCONNECT_REASON : CUSTOMER_DISCONNECT |
// AGENT_DISCONNECT | THIRD_PARTY_DISCONNECT | TELECOM_PROBLEM | BARGED |
// CONTACT_FLOW_DISCONNECT | OTHER | EXPIRED | API
MetricFilterValues []string
// The flag to use to filter on requested metric filter values or to not filter on
// requested metric filter values. By default the negate is false , which indicates
// to filter on the requested metric filter.
Negate bool
noSmithyDocumentSerde
}
// The interval period with the start and end time for the metrics.
type MetricInterval struct {
// The timestamp, in UNIX Epoch time format. End time is based on the interval
// period selected. For example, If IntervalPeriod is selected THIRTY_MIN ,
// StartTime and EndTime in the API request differs by 1 day, then 48 results are
// returned in the response. Each result is aggregated by the 30 minutes period,
// with each StartTime and EndTime differing by 30 minutes.
EndTime *time.Time
// The interval period provided in the API request.
Interval IntervalPeriod
// The timestamp, in UNIX Epoch time format. Start time is based on the interval
// period selected.
StartTime *time.Time
noSmithyDocumentSerde
}
// Contains information about the metric results.
type MetricResultV2 struct {
// The set of metrics.
Collections []MetricDataV2
// The dimension for the metrics.
Dimensions map[string]string
// The interval period with the start and end time for the metrics.
MetricInterval *MetricInterval
noSmithyDocumentSerde
}
// Contains information about the metric.
type MetricV2 struct {
// Contains the filters to be used when returning data.
MetricFilters []MetricFilterV2
// The name of the metric. This parameter is required. The following Required = No
// is incorrect.
Name *string
// Contains information about the threshold for service level metrics.
Threshold []ThresholdV2
noSmithyDocumentSerde
}
// Payload of chat properties to apply when starting a new contact.
type NewSessionDetails struct {
// A custom key-value pair using an attribute map. The attributes are standard
// Amazon Connect attributes. They can be accessed in flows just like any other
// contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value
// pairs per contact. Attribute keys can include only alphanumeric, dash, and
// underscore characters.
Attributes map[string]string
// The customer's details.
ParticipantDetails *ParticipantDetails
// The streaming configuration, such as the Amazon SNS streaming endpoint.
StreamingConfiguration *ChatStreamingConfiguration
// The supported chat message content types. Supported types are text/plain ,
// text/markdown , application/json ,
// application/vnd.amazonaws.connect.message.interactive , and
// application/vnd.amazonaws.connect.message.interactive.response . Content types
// must always contain text/plain . You can then put any other supported type in
// the list. For example, all the following lists are valid because they contain
// text/plain : [text/plain, text/markdown, application/json] , [text/markdown,
// text/plain] , [text/plain, application/json,
// application/vnd.amazonaws.connect.message.interactive.response] .
SupportedMessagingContentTypes []string
noSmithyDocumentSerde
}
// The type of notification recipient.
type NotificationRecipientType struct {
// A list of user IDs.
UserIds []string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }. Amazon Connect users
// with the specified tags will be notified.
UserTags map[string]string
noSmithyDocumentSerde
}
// Information about a reference when the referenceType is NUMBER . Otherwise, null.
type NumberReference struct {
// Identifier of the number reference.
Name *string
// A valid number.
Value *string
noSmithyDocumentSerde
}
// Information about the property value used in automation of a numeric questions.
// Label values are associated with minimum and maximum values for the numeric
// question.
// - Sentiment scores have a minimum value of -5 and maximum value of 5.
// - Duration labels, such as NON_TALK_TIME , CONTACT_DURATION ,
// AGENT_INTERACTION_DURATION , CUSTOMER_HOLD_TIME have a minimum value of 0 and
// maximum value of 28800.
// - Percentages have a minimum value of 0 and maximum value of 100.
// - NUMBER_OF_INTERRUPTIONS has a minimum value of 0 and maximum value of 1000.
type NumericQuestionPropertyValueAutomation struct {
// The property label of the automation.
//
// This member is required.
Label NumericQuestionPropertyAutomationLabel
noSmithyDocumentSerde
}
// The outbound caller ID name, number, and outbound whisper flow.
type OutboundCallerConfig struct {
// The caller ID name.
OutboundCallerIdName *string
// The caller ID number.
OutboundCallerIdNumberId *string
// The outbound whisper flow to be used during an outbound call.
OutboundFlowId *string
noSmithyDocumentSerde
}
// The configuration for the allowed capabilities for participants present over
// the call.
type ParticipantCapabilities struct {
// The configuration having the video sharing capabilities for participants over
// the call.
Video VideoCapability
noSmithyDocumentSerde
}
// The customer's details.
type ParticipantDetails struct {
// Display name of the participant.
//
// This member is required.
DisplayName *string
noSmithyDocumentSerde
}
// The details to add for the participant.
type ParticipantDetailsToAdd struct {
// The display name of the participant.
DisplayName *string
// The role of the participant being added.
ParticipantRole ParticipantRole
noSmithyDocumentSerde
}
// Configuration information for the timer. After the timer configuration is set,
// it persists for the duration of the chat. It persists across new contacts in the
// chain, for example, transfer contacts. For more information about how chat
// timeouts work, see Set up chat timeouts for human participants (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html)
// .
type ParticipantTimerConfiguration struct {
// The role of the participant in the chat conversation.
//
// This member is required.
ParticipantRole TimerEligibleParticipantRoles
// The type of timer. IDLE indicates the timer applies for considering a human
// chat participant as idle. DISCONNECT_NONCUSTOMER indicates the timer applies to
// automatically disconnecting a chat participant due to idleness.
//
// This member is required.
TimerType ParticipantTimerType
// The value of the timer. Either the timer action (Unset to delete the timer), or
// the duration of the timer in minutes. Only one value can be set.
//
// This member is required.
TimerValue ParticipantTimerValue
noSmithyDocumentSerde
}
// The value of the timer. Either the timer action ( Unset to delete the timer),
// or the duration of the timer in minutes. Only one value can be set. For more
// information about how chat timeouts work, see Set up chat timeouts for human
// participants (https://docs.aws.amazon.com/connect/latest/adminguide/setup-chat-timeouts.html)
// .
//
// The following types satisfy this interface:
//
// ParticipantTimerValueMemberParticipantTimerAction
// ParticipantTimerValueMemberParticipantTimerDurationInMinutes
type ParticipantTimerValue interface {
isParticipantTimerValue()
}
// The timer action. Currently only one value is allowed: Unset . It deletes a
// timer.
type ParticipantTimerValueMemberParticipantTimerAction struct {
Value ParticipantTimerAction
noSmithyDocumentSerde
}
func (*ParticipantTimerValueMemberParticipantTimerAction) isParticipantTimerValue() {}
// The duration of a timer, in minutes.
type ParticipantTimerValueMemberParticipantTimerDurationInMinutes struct {
Value int32
noSmithyDocumentSerde
}
func (*ParticipantTimerValueMemberParticipantTimerDurationInMinutes) isParticipantTimerValue() {}
// The credentials used by the participant.
type ParticipantTokenCredentials struct {
// The expiration of the token. It's specified in ISO 8601 format:
// yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
Expiry *string
// The token used by the chat participant to call CreateParticipantConnection (https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html)
// . The participant token is valid for the lifetime of a chat participant.
ParticipantToken *string
noSmithyDocumentSerde
}
// Enable persistent chats. For more information about enabling persistent chat,
// and for example use cases and how to configure for them, see Enable persistent
// chat (https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html)
// .
type PersistentChat struct {
// The contactId that is used for rehydration depends on the rehydration type.
// RehydrationType is required for persistent chat.
// - ENTIRE_PAST_SESSION : Rehydrates a chat from the most recently terminated
// past chat contact of the specified past ended chat session. To use this type,
// provide the initialContactId of the past ended chat session in the
// sourceContactId field. In this type, Amazon Connect determines the most recent
// chat contact on the specified chat session that has ended, and uses it to start
// a persistent chat.
// - FROM_SEGMENT : Rehydrates a chat from the past chat contact that is
// specified in the sourceContactId field.
// The actual contactId used for rehydration is provided in the response of this
// API.
RehydrationType RehydrationType
// The contactId from which a persistent chat session must be started.
SourceContactId *string
noSmithyDocumentSerde
}
// Contains information about a phone number for a quick connect.
type PhoneNumberQuickConnectConfig struct {
// The phone number in E.164 format.
//
// This member is required.
PhoneNumber *string
noSmithyDocumentSerde
}
// The status of the phone number.
// - CLAIMED means the previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html)
// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
// operation succeeded.
// - IN_PROGRESS means a ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html)
// , UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
// , or UpdatePhoneNumberMetadata (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumberMetadata.html)
// operation is still in progress and has not yet completed. You can call
// DescribePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_DescribePhoneNumber.html)
// at a later time to verify if the previous operation has completed.
// - FAILED indicates that the previous ClaimPhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_ClaimPhoneNumber.html)
// or UpdatePhoneNumber (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdatePhoneNumber.html)
// operation has failed. It will include a message indicating the failure reason. A
// common reason for a failure may be that the TargetArn value you are claiming
// or updating a phone number to has reached its limit of total claimed numbers. If
// you received a FAILED status from a ClaimPhoneNumber API call, you have one
// day to retry claiming the phone number before the number is released back to the
// inventory for other customers to claim.
type PhoneNumberStatus struct {
// The status message.
Message *string
// The status.
Status PhoneNumberWorkflowStatus
noSmithyDocumentSerde
}
// Contains summary information about a phone number for a contact center.
type PhoneNumberSummary struct {
// The Amazon Resource Name (ARN) of the phone number.
Arn *string
// The identifier of the phone number.
Id *string
// The phone number.
PhoneNumber *string
// The ISO country code.
PhoneNumberCountryCode PhoneNumberCountryCode
// The type of phone number.
PhoneNumberType PhoneNumberType
noSmithyDocumentSerde
}
// Information about a predefined attribute.
type PredefinedAttribute struct {
// Last modified region.
LastModifiedRegion *string
// Last modified time.
LastModifiedTime *time.Time
// The name of the predefined attribute.
Name *string
// The values of the predefined attribute.
Values PredefinedAttributeValues
noSmithyDocumentSerde
}
// The search criteria to be used to return predefined attributes.
type PredefinedAttributeSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []PredefinedAttributeSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []PredefinedAttributeSearchCriteria
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name and description .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Summary of a predefined attribute.
type PredefinedAttributeSummary struct {
// Last modified region.
LastModifiedRegion *string
// Last modified time.
LastModifiedTime *time.Time
// The name of the predefined attribute.
Name *string
noSmithyDocumentSerde
}
// Information about values of a predefined attribute.
//
// The following types satisfy this interface:
//
// PredefinedAttributeValuesMemberStringList
type PredefinedAttributeValues interface {
isPredefinedAttributeValues()
}
// Predefined attribute values of type string list.
type PredefinedAttributeValuesMemberStringList struct {
Value []string
noSmithyDocumentSerde
}
func (*PredefinedAttributeValuesMemberStringList) isPredefinedAttributeValues() {}
// Information about a problem detail.
type ProblemDetail struct {
// The problem detail's message.
Message *string
noSmithyDocumentSerde
}
// Information about a prompt.
type Prompt struct {
// The description of the prompt.
Description *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the prompt.
Name *string
// The Amazon Resource Name (ARN) of the prompt.
PromptARN *string
// A unique identifier for the prompt.
PromptId *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// The search criteria to be used to return prompts.
type PromptSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []PromptSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []PromptSearchCriteria
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name , description , and resourceID
// .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Filters to be applied to search results.
type PromptSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
noSmithyDocumentSerde
}
// Contains information about the prompt.
type PromptSummary struct {
// The Amazon Resource Name (ARN) of the prompt.
Arn *string
// The identifier of the prompt.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the prompt.
Name *string
noSmithyDocumentSerde
}
// Contains information about why a property is not valid.
type PropertyValidationExceptionProperty struct {
// A message describing why the property is not valid.
//
// This member is required.
Message *string
// The full property path.
//
// This member is required.
PropertyPath *string
// Why the property is not valid.
//
// This member is required.
Reason PropertyValidationExceptionReason
noSmithyDocumentSerde
}
// Contains information about a queue.
type Queue struct {
// The description of the queue.
Description *string
// The identifier for the hours of operation.
HoursOfOperationId *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The maximum number of contacts that can be in the queue before it is considered
// full.
MaxContacts *int32
// The name of the queue.
Name *string
// The outbound caller ID name, number, and outbound whisper flow.
OutboundCallerConfig *OutboundCallerConfig
// The Amazon Resource Name (ARN) for the queue.
QueueArn *string
// The identifier for the queue.
QueueId *string
// The status of the queue.
Status QueueStatus
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// If this contact was queued, this contains information about the queue.
type QueueInfo struct {
// The timestamp when the contact was added to the queue.
EnqueueTimestamp *time.Time
// The unique identifier for the queue.
Id *string
noSmithyDocumentSerde
}
// Contains information about a queue for a quick connect. The flow must be of
// type Transfer to Queue.
type QueueQuickConnectConfig struct {
// The identifier of the flow.
//
// This member is required.
ContactFlowId *string
// The identifier for the queue.
//
// This member is required.
QueueId *string
noSmithyDocumentSerde
}
// Contains information about a queue resource for which metrics are returned.
type QueueReference struct {
// The Amazon Resource Name (ARN) of the queue.
Arn *string
// The identifier of the queue.
Id *string
noSmithyDocumentSerde
}
// The search criteria to be used to return queues. The name and description
// fields support "contains" queries with a minimum of 2 characters and a maximum
// of 25 characters. Any queries with character lengths outside of this range will
// throw invalid results.
type QueueSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []QueueSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []QueueSearchCriteria
// The type of queue.
QueueTypeCondition SearchableQueueType
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name , description , and resourceID
// .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Filters to be applied to search results.
type QueueSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
noSmithyDocumentSerde
}
// Contains summary information about a queue.
type QueueSummary struct {
// The Amazon Resource Name (ARN) of the queue.
Arn *string
// The identifier of the queue.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the queue.
Name *string
// The type of queue.
QueueType QueueType
noSmithyDocumentSerde
}
// Contains information about a quick connect.
type QuickConnect struct {
// The description.
Description *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the quick connect.
Name *string
// The Amazon Resource Name (ARN) of the quick connect.
QuickConnectARN *string
// Contains information about the quick connect.
QuickConnectConfig *QuickConnectConfig
// The identifier for the quick connect.
QuickConnectId *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Contains configuration settings for a quick connect.
type QuickConnectConfig struct {
// The type of quick connect. In the Amazon Connect admin website, when you create
// a quick connect, you are prompted to assign one of the following types: Agent
// (USER), External (PHONE_NUMBER), or Queue (QUEUE).
//
// This member is required.
QuickConnectType QuickConnectType
// The phone configuration. This is required only if QuickConnectType is
// PHONE_NUMBER.
PhoneConfig *PhoneNumberQuickConnectConfig
// The queue configuration. This is required only if QuickConnectType is QUEUE.
QueueConfig *QueueQuickConnectConfig
// The user configuration. This is required only if QuickConnectType is USER.
UserConfig *UserQuickConnectConfig
noSmithyDocumentSerde
}
// The search criteria to be used to return quick connects.
type QuickConnectSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []QuickConnectSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []QuickConnectSearchCriteria
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name , description , and resourceID
// .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Filters to be applied to search results.
type QuickConnectSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
noSmithyDocumentSerde
}
// Contains summary information about a quick connect.
type QuickConnectSummary struct {
// The Amazon Resource Name (ARN) of the quick connect.
Arn *string
// The identifier for the quick connect.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the quick connect.
Name *string
// The type of quick connect. In the Amazon Connect admin website, when you create
// a quick connect, you are prompted to assign one of the following types: Agent
// (USER), External (PHONE_NUMBER), or Queue (QUEUE).
QuickConnectType QuickConnectType
noSmithyDocumentSerde
}
// Indicates a field that is read-only to an agent.
type ReadOnlyFieldInfo struct {
// Identifier of the read-only field.
Id *TaskTemplateFieldIdentifier
noSmithyDocumentSerde
}
// Object that describes attached file.
type RealTimeContactAnalysisAttachment struct {
// A unique identifier for the attachment.
//
// This member is required.
AttachmentId *string
// A case-sensitive name of the attachment being uploaded. Can be redacted.
//
// This member is required.
AttachmentName *string
// Describes the MIME file type of the attachment. For a list of supported file
// types, see Feature specifications (https://docs.aws.amazon.com/connect/latest/adminguide/feature-limits.html)
// in the Amazon Connect Administrator Guide.
ContentType *string
// Status of the attachment.
Status ArtifactStatus
noSmithyDocumentSerde
}
// Provides information about the category rule that was matched.
type RealTimeContactAnalysisCategoryDetails struct {
// List of PointOfInterest - objects describing a single match of a rule.
//
// This member is required.
PointsOfInterest []RealTimeContactAnalysisPointOfInterest
noSmithyDocumentSerde
}
// Begin and end offsets for a part of text.
type RealTimeContactAnalysisCharacterInterval struct {
// The beginning of the character interval.
//
// This member is required.
BeginOffsetChar int32
// The end of the character interval.
//
// This member is required.
EndOffsetChar int32
noSmithyDocumentSerde
}
// Potential issues that are detected based on an artificial intelligence analysis
// of each turn in the conversation.
type RealTimeContactAnalysisIssueDetected struct {
// List of the transcript items (segments) that are associated with a given issue.
//
// This member is required.
TranscriptItems []RealTimeContactAnalysisTranscriptItemWithContent
noSmithyDocumentSerde
}
// The section of the contact transcript segment that category rule was detected.
type RealTimeContactAnalysisPointOfInterest struct {
// List of the transcript items (segments) that are associated with a given point
// of interest.
TranscriptItems []RealTimeContactAnalysisTranscriptItemWithCharacterOffsets
noSmithyDocumentSerde
}
// An analyzed segment for a real-time analysis session.
//
// The following types satisfy this interface:
//
// RealtimeContactAnalysisSegmentMemberAttachments
// RealtimeContactAnalysisSegmentMemberCategories
// RealtimeContactAnalysisSegmentMemberEvent
// RealtimeContactAnalysisSegmentMemberIssues
// RealtimeContactAnalysisSegmentMemberTranscript
type RealtimeContactAnalysisSegment interface {
isRealtimeContactAnalysisSegment()
}
// The analyzed attachments.
type RealtimeContactAnalysisSegmentMemberAttachments struct {
Value RealTimeContactAnalysisSegmentAttachments
noSmithyDocumentSerde
}
func (*RealtimeContactAnalysisSegmentMemberAttachments) isRealtimeContactAnalysisSegment() {}
// The matched category rules.
type RealtimeContactAnalysisSegmentMemberCategories struct {
Value RealTimeContactAnalysisSegmentCategories
noSmithyDocumentSerde
}
func (*RealtimeContactAnalysisSegmentMemberCategories) isRealtimeContactAnalysisSegment() {}
// Segment type describing a contact event.
type RealtimeContactAnalysisSegmentMemberEvent struct {
Value RealTimeContactAnalysisSegmentEvent
noSmithyDocumentSerde
}
func (*RealtimeContactAnalysisSegmentMemberEvent) isRealtimeContactAnalysisSegment() {}
// Segment type containing a list of detected issues.
type RealtimeContactAnalysisSegmentMemberIssues struct {
Value RealTimeContactAnalysisSegmentIssues
noSmithyDocumentSerde
}
func (*RealtimeContactAnalysisSegmentMemberIssues) isRealtimeContactAnalysisSegment() {}
// The analyzed transcript segment.
type RealtimeContactAnalysisSegmentMemberTranscript struct {
Value RealTimeContactAnalysisSegmentTranscript
noSmithyDocumentSerde
}
func (*RealtimeContactAnalysisSegmentMemberTranscript) isRealtimeContactAnalysisSegment() {}
// Segment containing list of attachments.
type RealTimeContactAnalysisSegmentAttachments struct {
// List of objects describing an individual attachment.
//
// This member is required.
Attachments []RealTimeContactAnalysisAttachment
// The identifier of the segment.
//
// This member is required.
Id *string
// The identifier of the participant.
//
// This member is required.
ParticipantId *string
// The role of the participant. For example, is it a customer, agent, or system.
//
// This member is required.
ParticipantRole ParticipantRole
// Field describing the time of the event. It can have different representations
// of time.
//
// This member is required.
Time RealTimeContactAnalysisTimeData
// The display name of the participant. Can be redacted.
DisplayName *string
noSmithyDocumentSerde
}
// The matched category rules.
type RealTimeContactAnalysisSegmentCategories struct {
// Map between the name of the matched rule and
// RealTimeContactAnalysisCategoryDetails.
//
// This member is required.
MatchedDetails map[string]RealTimeContactAnalysisCategoryDetails
noSmithyDocumentSerde
}
// Segment type describing a contact event.
type RealTimeContactAnalysisSegmentEvent struct {
// Type of the event. For example,
// application/vnd.amazonaws.connect.event.participant.left .
//
// This member is required.
EventType *string
// The identifier of the contact event.
//
// This member is required.
Id *string
// Field describing the time of the event. It can have different representations
// of time.
//
// This member is required.
Time RealTimeContactAnalysisTimeData
// The display name of the participant. Can be redacted.
DisplayName *string
// The identifier of the participant.
ParticipantId *string
// The role of the participant. For example, is it a customer, agent, or system.
ParticipantRole ParticipantRole
noSmithyDocumentSerde
}
// Segment type containing a list of detected issues.
type RealTimeContactAnalysisSegmentIssues struct {
// List of the issues detected.
//
// This member is required.
IssuesDetected []RealTimeContactAnalysisIssueDetected
noSmithyDocumentSerde
}
// The analyzed transcript segment.
type RealTimeContactAnalysisSegmentTranscript struct {
// The content of the transcript. Can be redacted.
//
// This member is required.
Content *string
// The identifier of the transcript.
//
// This member is required.
Id *string
// The identifier of the participant.
//
// This member is required.
ParticipantId *string
// The role of the participant. For example, is it a customer, agent, or system.
//
// This member is required.
ParticipantRole ParticipantRole
// Field describing the time of the event. It can have different representations
// of time.
//
// This member is required.
Time RealTimeContactAnalysisTimeData
// The type of content of the item. For example, text/plain .
ContentType *string
// The display name of the participant.
DisplayName *string
// Object describing redaction that was applied to the transcript. If transcript
// has the field it means part of the transcript was redacted.
Redaction *RealTimeContactAnalysisTranscriptItemRedaction
// The sentiment detected for this piece of transcript.
Sentiment RealTimeContactAnalysisSentimentLabel
noSmithyDocumentSerde
}
// Object describing time with which the segment is associated. It can have
// different representations of time. Currently supported: absoluteTime
//
// The following types satisfy this interface:
//
// RealTimeContactAnalysisTimeDataMemberAbsoluteTime
type RealTimeContactAnalysisTimeData interface {
isRealTimeContactAnalysisTimeData()
}
// Time represented in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example,
// 2019-11-08T02:41:28.172Z.
type RealTimeContactAnalysisTimeDataMemberAbsoluteTime struct {
Value time.Time
noSmithyDocumentSerde
}
func (*RealTimeContactAnalysisTimeDataMemberAbsoluteTime) isRealTimeContactAnalysisTimeData() {}
// Object describing redaction applied to the segment.
type RealTimeContactAnalysisTranscriptItemRedaction struct {
// List of character intervals each describing a part of the text that was
// redacted. For OutputType.Raw , part of the original text that contains data that
// can be redacted. For OutputType.Redacted , part of the string with redaction tag.
CharacterOffsets []RealTimeContactAnalysisCharacterInterval
noSmithyDocumentSerde
}
// Transcript representation containing Id and list of character intervals that
// are associated with analysis data. For example, this object within a
// RealTimeContactAnalysisPointOfInterest in Category.MatchedDetails would have
// character interval describing part of the text that matched category.
type RealTimeContactAnalysisTranscriptItemWithCharacterOffsets struct {
// Transcript identifier. Matches the identifier from one of the
// TranscriptSegments.
//
// This member is required.
Id *string
// List of character intervals within transcript content/text.
CharacterOffsets *RealTimeContactAnalysisCharacterInterval
noSmithyDocumentSerde
}
// Transcript representation containing Id, Content and list of character
// intervals that are associated with analysis data. For example, this object
// within an issue detected would describe both content that contains identified
// issue and intervals where that content is taken from.
type RealTimeContactAnalysisTranscriptItemWithContent struct {
// Transcript identifier. Matches the identifier from one of the
// TranscriptSegments.
//
// This member is required.
Id *string
// Begin and end offsets for a part of text.
CharacterOffsets *RealTimeContactAnalysisCharacterInterval
// Part of the transcript content that contains identified issue. Can be redacted
Content *string
noSmithyDocumentSerde
}
// Well-formed data on a contact, used by agents to complete a contact request.
// You can have up to 4,096 UTF-8 bytes across all references for a contact.
type Reference struct {
// The type of the reference. DATE must be of type Epoch timestamp.
//
// This member is required.
Type ReferenceType
// A valid value for the reference. For example, for a URL reference, a formatted
// URL that is displayed to an agent in the Contact Control Panel (CCP).
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Contains summary information about a reference. ReferenceSummary contains only
// one non null field between the URL and attachment based on the reference type.
//
// The following types satisfy this interface:
//
// ReferenceSummaryMemberAttachment
// ReferenceSummaryMemberDate
// ReferenceSummaryMemberEmail
// ReferenceSummaryMemberNumber
// ReferenceSummaryMemberString
// ReferenceSummaryMemberUrl
type ReferenceSummary interface {
isReferenceSummary()
}
// Information about the reference when the referenceType is ATTACHMENT .
// Otherwise, null.
type ReferenceSummaryMemberAttachment struct {
Value AttachmentReference
noSmithyDocumentSerde
}
func (*ReferenceSummaryMemberAttachment) isReferenceSummary() {}
// Information about a reference when the referenceType is DATE . Otherwise, null.
type ReferenceSummaryMemberDate struct {
Value DateReference
noSmithyDocumentSerde
}
func (*ReferenceSummaryMemberDate) isReferenceSummary() {}
// Information about a reference when the referenceType is EMAIL . Otherwise, null.
type ReferenceSummaryMemberEmail struct {
Value EmailReference
noSmithyDocumentSerde
}
func (*ReferenceSummaryMemberEmail) isReferenceSummary() {}
// Information about a reference when the referenceType is NUMBER . Otherwise, null.
type ReferenceSummaryMemberNumber struct {
Value NumberReference
noSmithyDocumentSerde
}
func (*ReferenceSummaryMemberNumber) isReferenceSummary() {}
// Information about a reference when the referenceType is STRING . Otherwise, null.
type ReferenceSummaryMemberString struct {
Value StringReference
noSmithyDocumentSerde
}
func (*ReferenceSummaryMemberString) isReferenceSummary() {}
// Information about the reference when the referenceType is URL . Otherwise, null.
type ReferenceSummaryMemberUrl struct {
Value UrlReference
noSmithyDocumentSerde
}
func (*ReferenceSummaryMemberUrl) isReferenceSummary() {}
// Information about a required field.
type RequiredFieldInfo struct {
// The unique identifier for the field.
Id *TaskTemplateFieldIdentifier
noSmithyDocumentSerde
}
// The search criteria to be used to search tags.
type ResourceTagsSearchCriteria struct {
// The search criteria to be used to return tags.
TagSearchCondition *TagSearchCondition
noSmithyDocumentSerde
}
// Contains information about a routing profile.
type RoutingProfile struct {
// Whether agents with this routing profile will have their routing order
// calculated based on time since their last inbound contact or longest idle time.
AgentAvailabilityTimer AgentAvailabilityTimer
// The identifier of the default outbound queue for this routing profile.
DefaultOutboundQueueId *string
// The description of the routing profile.
Description *string
// The identifier of the Amazon Connect instance. You can find the instance ID (https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html)
// in the Amazon Resource Name (ARN) of the instance.
InstanceId *string
// Whether this a default routing profile.
IsDefault bool
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The channels agents can handle in the Contact Control Panel (CCP) for this
// routing profile.
MediaConcurrencies []MediaConcurrency
// The name of the routing profile.
Name *string
// The number of associated queues in routing profile.
NumberOfAssociatedQueues *int64
// The number of associated users in routing profile.
NumberOfAssociatedUsers *int64
// The Amazon Resource Name (ARN) of the routing profile.
RoutingProfileArn *string
// The identifier of the routing profile.
RoutingProfileId *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Contains information about the queue and channel for which priority and delay
// can be set.
type RoutingProfileQueueConfig struct {
// The delay, in seconds, a contact should be in the queue before they are routed
// to an available agent. For more information, see Queues: priority and delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html)
// in the Amazon Connect Administrator Guide.
//
// This member is required.
Delay *int32
// The order in which contacts are to be handled for the queue. For more
// information, see Queues: priority and delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html)
// .
//
// This member is required.
Priority *int32
// Contains information about a queue resource.
//
// This member is required.
QueueReference *RoutingProfileQueueReference
noSmithyDocumentSerde
}
// Contains summary information about a routing profile queue.
type RoutingProfileQueueConfigSummary struct {
// The channels this queue supports.
//
// This member is required.
Channel Channel
// The delay, in seconds, that a contact should be in the queue before they are
// routed to an available agent. For more information, see Queues: priority and
// delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html)
// in the Amazon Connect Administrator Guide.
//
// This member is required.
Delay int32
// The order in which contacts are to be handled for the queue. For more
// information, see Queues: priority and delay (https://docs.aws.amazon.com/connect/latest/adminguide/concepts-routing-profiles-priority.html)
// .
//
// This member is required.
Priority *int32
// The Amazon Resource Name (ARN) of the queue.
//
// This member is required.
QueueArn *string
// The identifier for the queue.
//
// This member is required.
QueueId *string
// The name of the queue.
//
// This member is required.
QueueName *string
noSmithyDocumentSerde
}
// Contains the channel and queue identifier for a routing profile.
type RoutingProfileQueueReference struct {
// The channels agents can handle in the Contact Control Panel (CCP) for this
// routing profile.
//
// This member is required.
Channel Channel
// The identifier for the queue.
//
// This member is required.
QueueId *string
noSmithyDocumentSerde
}
// Information about the routing profile assigned to the user.
type RoutingProfileReference struct {
// The Amazon Resource Name (ARN) of the routing profile.
Arn *string
// The identifier of the routing profile.
Id *string
noSmithyDocumentSerde
}
// The search criteria to be used to return routing profiles. The name and
// description fields support "contains" queries with a minimum of 2 characters and
// a maximum of 25 characters. Any queries with character lengths outside of this
// range will throw invalid results.
type RoutingProfileSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []RoutingProfileSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []RoutingProfileSearchCriteria
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name , description , and resourceID
// .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Filters to be applied to search results.
type RoutingProfileSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
noSmithyDocumentSerde
}
// Contains summary information about a routing profile.
type RoutingProfileSummary struct {
// The Amazon Resource Name (ARN) of the routing profile.
Arn *string
// The identifier of the routing profile.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the routing profile.
Name *string
noSmithyDocumentSerde
}
// Information about a rule.
type Rule struct {
// A list of actions to be run when the rule is triggered.
//
// This member is required.
Actions []RuleAction
// The timestamp for when the rule was created.
//
// This member is required.
CreatedTime *time.Time
// The conditions of the rule.
//
// This member is required.
Function *string
// The Amazon Resource Name (ARN) of the user who last updated the rule.
//
// This member is required.
LastUpdatedBy *string
// The timestamp for the when the rule was last updated.
//
// This member is required.
LastUpdatedTime *time.Time
// The name of the rule.
//
// This member is required.
Name *string
// The publish status of the rule.
//
// This member is required.
PublishStatus RulePublishStatus
// The Amazon Resource Name (ARN) of the rule.
//
// This member is required.
RuleArn *string
// A unique identifier for the rule.
//
// This member is required.
RuleId *string
// The event source to trigger the rule.
//
// This member is required.
TriggerEventSource *RuleTriggerEventSource
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Information about the action to be performed when a rule is triggered.
type RuleAction struct {
// The type of action that creates a rule.
//
// This member is required.
ActionType ActionType
// Information about the contact category action. Supported only for
// TriggerEventSource values: OnPostCallAnalysisAvailable |
// OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
// OnPostChatAnalysisAvailable | OnZendeskTicketCreate |
// OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
AssignContactCategoryAction *AssignContactCategoryActionDefinition
// Information about the create case action. Supported only for TriggerEventSource
// values: OnPostCallAnalysisAvailable | OnPostChatAnalysisAvailable .
CreateCaseAction *CreateCaseActionDefinition
// Information about the end associated tasks action. Supported only for
// TriggerEventSource values: OnCaseUpdate .
EndAssociatedTasksAction *EndAssociatedTasksActionDefinition
// Information about the EventBridge action. Supported only for TriggerEventSource
// values: OnPostCallAnalysisAvailable | OnRealTimeCallAnalysisAvailable |
// OnRealTimeChatAnalysisAvailable | OnPostChatAnalysisAvailable |
// OnContactEvaluationSubmit | OnMetricDataUpdate
EventBridgeAction *EventBridgeActionDefinition
// Information about the send notification action. Supported only for
// TriggerEventSource values: OnPostCallAnalysisAvailable |
// OnRealTimeCallAnalysisAvailable | OnRealTimeChatAnalysisAvailable |
// OnPostChatAnalysisAvailable | OnContactEvaluationSubmit | OnMetricDataUpdate
SendNotificationAction *SendNotificationActionDefinition
// Information about the task action. This field is required if TriggerEventSource
// is one of the following values: OnZendeskTicketCreate |
// OnZendeskTicketStatusUpdate | OnSalesforceCaseCreate
TaskAction *TaskActionDefinition
// Information about the update case action. Supported only for TriggerEventSource
// values: OnCaseCreate | OnCaseUpdate .
UpdateCaseAction *UpdateCaseActionDefinition
noSmithyDocumentSerde
}
// A list of ActionTypes associated with a rule.
type RuleSummary struct {
// A list of ActionTypes associated with a rule.
//
// This member is required.
ActionSummaries []ActionSummary
// The timestamp for when the rule was created.
//
// This member is required.
CreatedTime *time.Time
// The name of the event source.
//
// This member is required.
EventSourceName EventSourceName
// The timestamp for when the rule was last updated.
//
// This member is required.
LastUpdatedTime *time.Time
// The name of the rule.
//
// This member is required.
Name *string
// The publish status of the rule.
//
// This member is required.
PublishStatus RulePublishStatus
// The Amazon Resource Name (ARN) of the rule.
//
// This member is required.
RuleArn *string
// A unique identifier for the rule.
//
// This member is required.
RuleId *string
noSmithyDocumentSerde
}
// The name of the event source. This field is required if TriggerEventSource is
// one of the following values: OnZendeskTicketCreate | OnZendeskTicketStatusUpdate
// | OnSalesforceCaseCreate | OnContactEvaluationSubmit | OnMetricDataUpdate .
type RuleTriggerEventSource struct {
// The name of the event source.
//
// This member is required.
EventSourceName EventSourceName
// The identifier for the integration association.
IntegrationAssociationId *string
noSmithyDocumentSerde
}
// Information about the Amazon Simple Storage Service (Amazon S3) storage type.
type S3Config struct {
// The S3 bucket name.
//
// This member is required.
BucketName *string
// The S3 bucket prefix.
//
// This member is required.
BucketPrefix *string
// The Amazon S3 encryption configuration.
EncryptionConfig *EncryptionConfig
noSmithyDocumentSerde
}
// A structure that defines search criteria based on user-defined contact
// attributes that are configured for contact search.
type SearchableContactAttributes struct {
// The list of criteria based on user-defined contact attributes that are
// configured for contact search.
//
// This member is required.
Criteria []SearchableContactAttributesCriteria
// The match type combining search criteria using multiple searchable contact
// attributes.
MatchType SearchContactsMatchType
noSmithyDocumentSerde
}
// The search criteria based on user-defned contact attribute key and values to
// search on.
type SearchableContactAttributesCriteria struct {
// The key containing a searchable user-defined contact attribute.
//
// This member is required.
Key *string
// The list of values to search for within a user-defined contact attribute.
//
// This member is required.
Values []string
noSmithyDocumentSerde
}
// A structure of time range that you want to search results.
type SearchContactsTimeRange struct {
// The end time of the time range.
//
// This member is required.
EndTime *time.Time
// The start time of the time range.
//
// This member is required.
StartTime *time.Time
// The type of timestamp to search.
//
// This member is required.
Type SearchContactsTimeRangeType
noSmithyDocumentSerde
}
// A structure of search criteria to be used to return contacts.
type SearchCriteria struct {
// The agent hierarchy groups of the agent at the time of handling the contact.
AgentHierarchyGroups *AgentHierarchyGroups
// The identifiers of agents who handled the contacts.
AgentIds []string
// The list of channels associated with contacts.
Channels []Channel
// Search criteria based on analysis outputs from Amazon Connect Contact Lens.
ContactAnalysis *ContactAnalysis
// The list of initiation methods associated with contacts.
InitiationMethods []ContactInitiationMethod
// The list of queue IDs associated with contacts.
QueueIds []string
// The search criteria based on user-defined contact attributes that have been
// configured for contact search. For more information, see Search by customer
// contact attributes (https://docs.aws.amazon.com/connect/latest/adminguide/search-custom-attributes.html)
// in the Amazon Connect Administrator Guide. To use SearchableContactAttributes
// in a search request, the GetContactAttributes action is required to perform an
// API request. For more information, see
// https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions (https://docs.aws.amazon.com/service-authorization/latest/reference/list_amazonconnect.html#amazonconnect-actions-as-permissions)
// Actions defined by Amazon Connect.
SearchableContactAttributes *SearchableContactAttributes
noSmithyDocumentSerde
}
// Configuration information of the security key.
type SecurityKey struct {
// The existing association identifier that uniquely identifies the resource type
// and storage config for the given instance ID.
AssociationId *string
// When the security key was created.
CreationTime *time.Time
// The key of the security key.
Key *string
noSmithyDocumentSerde
}
// Contains information about a security profile.
type SecurityProfile struct {
// The list of tags that a security profile uses to restrict access to resources
// in Amazon Connect.
AllowedAccessControlTags map[string]string
// The Amazon Resource Name (ARN) for the secruity profile.
Arn *string
// The description of the security profile.
Description *string
// The identifier for the security profile.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The organization resource identifier for the security profile.
OrganizationResourceId *string
// The name for the security profile.
SecurityProfileName *string
// The list of resources that a security profile applies tag restrictions to in
// Amazon Connect.
TagRestrictedResources []string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// The search criteria to be used to return security profiles. The name field
// support "contains" queries with a minimum of 2 characters and maximum of 25
// characters. Any queries with character lengths outside of this range will throw
// invalid results.
type SecurityProfileSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []SecurityProfileSearchCriteria
// A list of conditions which would be applied together with an OR condition.
OrConditions []SecurityProfileSearchCriteria
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name and description .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Information about the returned security profiles.
type SecurityProfileSearchSummary struct {
// The Amazon Resource Name (ARN) of the security profile.
Arn *string
// The description of the security profile.
Description *string
// The identifier of the security profile.
Id *string
// The organization resource identifier.
OrganizationResourceId *string
// The name of the security profile.
SecurityProfileName *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Filters to be applied to search results.
type SecurityProfilesSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
noSmithyDocumentSerde
}
// Contains information about a security profile.
type SecurityProfileSummary struct {
// The Amazon Resource Name (ARN) of the security profile.
Arn *string
// The identifier of the security profile.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The name of the security profile.
Name *string
noSmithyDocumentSerde
}
// A value for a segment attribute. This is structured as a map where the key is
// valueString and the value is a string.
type SegmentAttributeValue struct {
// The value of a segment attribute.
ValueString *string
noSmithyDocumentSerde
}
// Information about the send notification action.
type SendNotificationActionDefinition struct {
// Notification content. Supports variable injection. For more information, see
// JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
// in the Amazon Connect Administrators Guide.
//
// This member is required.
Content *string
// Content type format.
//
// This member is required.
ContentType NotificationContentType
// Notification delivery method.
//
// This member is required.
DeliveryMethod NotificationDeliveryType
// Notification recipient.
//
// This member is required.
Recipient *NotificationRecipientType
// The subject of the email if the delivery method is EMAIL . Supports variable
// injection. For more information, see JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
// in the Amazon Connect Administrators Guide.
Subject *string
noSmithyDocumentSerde
}
// The distribution that determines which Amazon Web Services Regions should be
// used to sign in agents in to both the instance and its replica(s).
type SignInConfig struct {
// Information about traffic distributions.
//
// This member is required.
Distributions []SignInDistribution
noSmithyDocumentSerde
}
// The distribution of sign in traffic between the instance and its replica(s).
type SignInDistribution struct {
// Whether sign in distribution is enabled.
//
// This member is required.
Enabled bool
// The Amazon Web Services Region of the sign in distribution.
//
// This member is required.
Region *string
noSmithyDocumentSerde
}
// Information about the automation option based on a rule category for a single
// select question.
type SingleSelectQuestionRuleCategoryAutomation struct {
// The category name, as defined in Rules.
//
// This member is required.
Category *string
// The condition to apply for the automation option. If the condition is PRESENT ,
// then the option is applied when the contact data includes the category.
// Similarly, if the condition is NOT_PRESENT , then the option is applied when the
// contact data does not include the category.
//
// This member is required.
Condition SingleSelectQuestionRuleCategoryAutomationCondition
// The identifier of the answer option.
//
// This member is required.
OptionRefId *string
noSmithyDocumentSerde
}
// A structure that defineds the field name to sort by and a sort order.
type Sort struct {
// The name of the field on which to sort.
//
// This member is required.
FieldName SortableFieldName
// An ascending or descending sort.
//
// This member is required.
Order SortOrder
noSmithyDocumentSerde
}
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are name and description .
type StringCondition struct {
// The type of comparison to be made when evaluating the string condition.
ComparisonType StringComparisonType
// The name of the field in the string condition.
FieldName *string
// The value of the string.
Value *string
noSmithyDocumentSerde
}
// Information about a reference when the referenceType is STRING . Otherwise, null.
type StringReference struct {
// Identifier of the string reference.
Name *string
// A valid string.
Value *string
noSmithyDocumentSerde
}
// Request for which contact was successfully created.
type SuccessfulRequest struct {
// The contactId of the contact that was created successfully.
ContactId *string
// Request identifier provided in the API call in the ContactDataRequest to create
// a contact.
RequestIdentifier *string
noSmithyDocumentSerde
}
// A leaf node condition which can be used to specify a tag condition, for
// example, HAVE BPO = 123 .
type TagCondition struct {
// The tag key in the tag condition.
TagKey *string
// The tag value in the tag condition.
TagValue *string
noSmithyDocumentSerde
}
// The search criteria to be used to return tags.
type TagSearchCondition struct {
// The tag key used in the tag search condition.
TagKey *string
// The type of comparison to be made when evaluating the tag key in tag search
// condition.
TagKeyComparisonType StringComparisonType
// The tag value used in the tag search condition.
TagValue *string
// The type of comparison to be made when evaluating the tag value in tag search
// condition.
TagValueComparisonType StringComparisonType
noSmithyDocumentSerde
}
// A tag set contains tag key and tag value.
type TagSet struct {
// The tag key in the tagSet.
Key *string
// The tag value in the tagSet.
Value *string
noSmithyDocumentSerde
}
// Information about the task action.
type TaskActionDefinition struct {
// The identifier of the flow.
//
// This member is required.
ContactFlowId *string
// The name. Supports variable injection. For more information, see JSONPath
// reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
// in the Amazon Connect Administrators Guide.
//
// This member is required.
Name *string
// The description. Supports variable injection. For more information, see
// JSONPath reference (https://docs.aws.amazon.com/connect/latest/adminguide/contact-lens-variable-injection.html)
// in the Amazon Connect Administrators Guide.
Description *string
// Information about the reference when the referenceType is URL . Otherwise, null.
// (Supports variable injection in the Value field.)
References map[string]Reference
noSmithyDocumentSerde
}
// Describes constraints that apply to the template fields.
type TaskTemplateConstraints struct {
// Lists the fields that are invisible to agents.
InvisibleFields []InvisibleFieldInfo
// Lists the fields that are read-only to agents, and cannot be edited.
ReadOnlyFields []ReadOnlyFieldInfo
// Lists the fields that are required to be filled by agents.
RequiredFields []RequiredFieldInfo
noSmithyDocumentSerde
}
// Describes a default field and its corresponding value.
type TaskTemplateDefaultFieldValue struct {
// Default value for the field.
DefaultValue *string
// Identifier of a field.
Id *TaskTemplateFieldIdentifier
noSmithyDocumentSerde
}
// Describes default values for fields on a template.
type TaskTemplateDefaults struct {
// Default value for the field.
DefaultFieldValues []TaskTemplateDefaultFieldValue
noSmithyDocumentSerde
}
// Describes a single task template field.
type TaskTemplateField struct {
// The unique identifier for the field.
//
// This member is required.
Id *TaskTemplateFieldIdentifier
// The description of the field.
Description *string
// A list of options for a single select field.
SingleSelectOptions []string
// Indicates the type of field.
Type TaskTemplateFieldType
noSmithyDocumentSerde
}
// The identifier of the task template field.
type TaskTemplateFieldIdentifier struct {
// The name of the task template field.
Name *string
noSmithyDocumentSerde
}
// Contains summary information about the task template.
type TaskTemplateMetadata struct {
// The Amazon Resource Name (ARN) of the task template.
Arn *string
// The timestamp when the task template was created.
CreatedTime *time.Time
// The description of the task template.
Description *string
// A unique identifier for the task template.
Id *string
// The timestamp when the task template was last modified.
LastModifiedTime *time.Time
// The name of the task template.
Name *string
// Marks a template as ACTIVE or INACTIVE for a task to refer to it. Tasks can
// only be created from ACTIVE templates. If a template is marked as INACTIVE ,
// then a task that refers to this template cannot be created.
Status TaskTemplateStatus
noSmithyDocumentSerde
}
// The distribution of traffic between the instance and its replicas.
type TelephonyConfig struct {
// Information about traffic distributions.
//
// This member is required.
Distributions []Distribution
noSmithyDocumentSerde
}
// Contains information about the threshold for service level metrics.
type Threshold struct {
// The type of comparison. Only "less than" (LT) comparisons are supported.
Comparison Comparison
// The threshold value to compare.
ThresholdValue *float64
noSmithyDocumentSerde
}
// Contains information about the threshold for service level metrics.
type ThresholdV2 struct {
// The type of comparison. Only "less than" (LT) comparisons are supported.
Comparison *string
// The threshold value to compare.
ThresholdValue *float64
noSmithyDocumentSerde
}
// Information about a traffic distribution group.
type TrafficDistributionGroup struct {
// The Amazon Resource Name (ARN) of the traffic distribution group.
Arn *string
// The description of the traffic distribution group.
Description *string
// The identifier of the traffic distribution group. This can be the ID or the ARN
// if the API is being called in the Region where the traffic distribution group
// was created. The ARN must be provided if the call is from the replicated Region.
Id *string
// The Amazon Resource Name (ARN).
InstanceArn *string
// Whether this is the default traffic distribution group created during instance
// replication. The default traffic distribution group cannot be deleted by the
// DeleteTrafficDistributionGroup API. The default traffic distribution group is
// deleted as part of the process for deleting a replica. The SignInConfig
// distribution is available only on a default TrafficDistributionGroup (see the
// IsDefault parameter in the TrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_TrafficDistributionGroup.html)
// data type). If you call UpdateTrafficDistribution with a modified SignInConfig
// and a non-default TrafficDistributionGroup , an InvalidRequestException is
// returned.
IsDefault bool
// The name of the traffic distribution group.
Name *string
// The status of the traffic distribution group.
// - CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
// operation is still in progress and has not yet completed.
// - ACTIVE means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
// operation has succeeded.
// - CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
// operation has failed.
// - PENDING_DELETION means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
// operation is still in progress and has not yet completed.
// - DELETION_FAILED means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
// operation has failed.
// - UPDATE_IN_PROGRESS means the previous UpdateTrafficDistribution (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistribution.html)
// operation is still in progress and has not yet completed.
Status TrafficDistributionGroupStatus
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Information about traffic distribution groups.
type TrafficDistributionGroupSummary struct {
// The Amazon Resource Name (ARN) of the traffic distribution group.
Arn *string
// The identifier of the traffic distribution group. This can be the ID or the ARN
// if the API is being called in the Region where the traffic distribution group
// was created. The ARN must be provided if the call is from the replicated Region.
Id *string
// The Amazon Resource Name (ARN) of the traffic distribution group.
InstanceArn *string
// Whether this is the default traffic distribution group created during instance
// replication. The default traffic distribution group cannot be deleted by the
// DeleteTrafficDistributionGroup API. The default traffic distribution group is
// deleted as part of the process for deleting a replica.
IsDefault bool
// The name of the traffic distribution group.
Name *string
// The status of the traffic distribution group.
// - CREATION_IN_PROGRESS means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
// operation is still in progress and has not yet completed.
// - ACTIVE means the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
// operation has succeeded.
// - CREATION_FAILED indicates that the previous CreateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_CreateTrafficDistributionGroup.html)
// operation has failed.
// - PENDING_DELETION means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
// operation is still in progress and has not yet completed.
// - DELETION_FAILED means the previous DeleteTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_DeleteTrafficDistributionGroup.html)
// operation has failed.
// - UPDATE_IN_PROGRESS means the previous UpdateTrafficDistributionGroup (https://docs.aws.amazon.com/connect/latest/APIReference/API_UpdateTrafficDistributionGroup.html)
// operation is still in progress and has not yet completed.
Status TrafficDistributionGroupStatus
noSmithyDocumentSerde
}
// Summary information about a traffic distribution group user.
type TrafficDistributionGroupUserSummary struct {
// The identifier for the user. This can be the ID or the ARN of the user.
UserId *string
noSmithyDocumentSerde
}
// A structure that defines search criteria and matching logic to search for
// contacts by matching text with transcripts analyzed by Amazon Connect Contact
// Lens.
type Transcript struct {
// The list of search criteria based on Contact Lens conversational analytics
// transcript.
//
// This member is required.
Criteria []TranscriptCriteria
// The match type combining search criteria using multiple transcript criteria.
MatchType SearchContactsMatchType
noSmithyDocumentSerde
}
// A structure that defines search criteria base on words or phrases, participants
// in the Contact Lens conversational analytics transcript.
type TranscriptCriteria struct {
// The match type combining search criteria using multiple search texts in a
// transcript criteria.
//
// This member is required.
MatchType SearchContactsMatchType
// The participant role in a transcript
//
// This member is required.
ParticipantRole ParticipantRole
// The words or phrases used to search within a transcript.
//
// This member is required.
SearchText []string
noSmithyDocumentSerde
}
// The UpdateCase action definition.
type UpdateCaseActionDefinition struct {
// An array of objects with Field ID and Value data.
//
// This member is required.
Fields []FieldValue
noSmithyDocumentSerde
}
// Configuration information for the chat participant role.
//
// The following types satisfy this interface:
//
// UpdateParticipantRoleConfigChannelInfoMemberChat
type UpdateParticipantRoleConfigChannelInfo interface {
isUpdateParticipantRoleConfigChannelInfo()
}
// Configuration information for the chat participant role.
type UpdateParticipantRoleConfigChannelInfoMemberChat struct {
Value ChatParticipantRoleConfig
noSmithyDocumentSerde
}
func (*UpdateParticipantRoleConfigChannelInfoMemberChat) isUpdateParticipantRoleConfigChannelInfo() {}
// The URL reference.
type UrlReference struct {
// Identifier of the URL reference.
Name *string
// A valid URL.
Value *string
noSmithyDocumentSerde
}
// Contains the use case.
type UseCase struct {
// The Amazon Resource Name (ARN) for the use case.
UseCaseArn *string
// The identifier for the use case.
UseCaseId *string
// The type of use case to associate to the integration association. Each
// integration association can have only one of each use case type.
UseCaseType UseCaseType
noSmithyDocumentSerde
}
// Contains information about a user account for an Amazon Connect instance.
type User struct {
// The Amazon Resource Name (ARN) of the user account.
Arn *string
// The identifier of the user account in the directory used for identity
// management.
DirectoryUserId *string
// The identifier of the hierarchy group for the user.
HierarchyGroupId *string
// The identifier of the user account.
Id *string
// Information about the user identity.
IdentityInfo *UserIdentityInfo
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// Information about the phone configuration for the user.
PhoneConfig *UserPhoneConfig
// The identifier of the routing profile for the user.
RoutingProfileId *string
// The identifiers of the security profiles for the user.
SecurityProfileIds []string
// The tags.
Tags map[string]string
// The user name assigned to the user account.
Username *string
noSmithyDocumentSerde
}
// Data for a user.
type UserData struct {
// A map of active slots by channel. The key is a channel name. The value is an
// integer: the number of active slots.
ActiveSlotsByChannel map[string]int32
// A map of available slots by channel. The key is a channel name. The value is an
// integer: the available number of slots.
AvailableSlotsByChannel map[string]int32
// A list of contact reference information.
Contacts []AgentContactReference
// Contains information about the levels of a hierarchy group assigned to a user.
HierarchyPath *HierarchyPathReference
// A map of maximum slots by channel. The key is a channel name. The value is an
// integer: the maximum number of slots. This is calculated from MediaConcurrency (https://docs.aws.amazon.com/connect/latest/APIReference/API_MediaConcurrency.html)
// of the RoutingProfile assigned to the agent.
MaxSlotsByChannel map[string]int32
// The Next status of the agent.
NextStatus *string
// Information about the routing profile that is assigned to the user.
RoutingProfile *RoutingProfileReference
// The status of the agent that they manually set in their Contact Control Panel
// (CCP), or that the supervisor manually changes in the real-time metrics report.
Status *AgentStatusReference
// Information about the user for the data that is returned. It contains the
// resourceId and ARN of the user.
User *UserReference
noSmithyDocumentSerde
}
// A filter for the user data.
type UserDataFilters struct {
// A list of up to 100 agent IDs or ARNs.
Agents []string
// A filter for the user data based on the contact information that is associated
// to the user. It contains a list of contact states.
ContactFilter *ContactFilter
// A list of up to 100 queues or ARNs.
Queues []string
// A list of up to 100 routing profile IDs or ARNs.
RoutingProfiles []string
// A UserHierarchyGroup ID or ARN.
UserHierarchyGroups []string
noSmithyDocumentSerde
}
// Contains information about the identity of a user.
type UserIdentityInfo struct {
// The email address. If you are using SAML for identity management and include
// this parameter, an error is returned.
Email *string
// The first name. This is required if you are using Amazon Connect or SAML for
// identity management.
FirstName *string
// The last name. This is required if you are using Amazon Connect or SAML for
// identity management.
LastName *string
// The user's mobile number.
Mobile *string
// The user's secondary email address. If you provide a secondary email, the user
// receives email notifications - other than password reset notifications - to this
// email address instead of to their primary email address. Pattern:
// (?=^.{0,265}$)[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,63}
SecondaryEmail *string
noSmithyDocumentSerde
}
// The user's first name and last name.
type UserIdentityInfoLite struct {
// The user's first name.
FirstName *string
// The user's last name.
LastName *string
noSmithyDocumentSerde
}
// Contains information about the phone configuration settings for a user.
type UserPhoneConfig struct {
// The phone type.
//
// This member is required.
PhoneType PhoneType
// The After Call Work (ACW) timeout setting, in seconds. When returned by a
// SearchUsers call, AfterContactWorkTimeLimit is returned in milliseconds.
AfterContactWorkTimeLimit int32
// The Auto accept setting.
AutoAccept bool
// The phone number for the user's desk phone.
DeskPhoneNumber *string
noSmithyDocumentSerde
}
// Information about proficiency of a user.
type UserProficiency struct {
// The name of user's proficiency. You must use name of predefined attribute
// present in the Amazon Connect instance.
//
// This member is required.
AttributeName *string
// The value of user's proficiency. You must use value of predefined attribute
// present in the Amazon Connect instance.
//
// This member is required.
AttributeValue *string
// The level of the proficiency. The valid values are 1, 2, 3, 4 and 5.
//
// This member is required.
Level *float32
noSmithyDocumentSerde
}
// Information about proficiency to be disassociated from the user.
type UserProficiencyDisassociate struct {
// The name of user's proficiency.
//
// This member is required.
AttributeName *string
// The value of user's proficiency.
//
// This member is required.
AttributeValue *string
noSmithyDocumentSerde
}
// Contains information about the quick connect configuration settings for a user.
// The contact flow must be of type Transfer to Agent.
type UserQuickConnectConfig struct {
// The identifier of the flow.
//
// This member is required.
ContactFlowId *string
// The identifier of the user.
//
// This member is required.
UserId *string
noSmithyDocumentSerde
}
// Information about the user.
type UserReference struct {
// The Amazon Resource Name (ARN) for the user.
Arn *string
// The unique identifier for the user.
Id *string
noSmithyDocumentSerde
}
// The search criteria to be used to return users. The name and description fields
// support "contains" queries with a minimum of 2 characters and a maximum of 25
// characters. Any queries with character lengths outside of this range will throw
// invalid results.
type UserSearchCriteria struct {
// A list of conditions which would be applied together with an AND condition.
AndConditions []UserSearchCriteria
// A leaf node condition which can be used to specify a hierarchy group condition.
HierarchyGroupCondition *HierarchyGroupCondition
// A list of conditions which would be applied together with an OR condition.
OrConditions []UserSearchCriteria
// A leaf node condition which can be used to specify a string condition. The
// currently supported values for FieldName are username , firstname , lastname ,
// resourceId , routingProfileId , securityProfileId , agentGroupId , and
// agentGroupPathIds .
StringCondition *StringCondition
noSmithyDocumentSerde
}
// Filters to be applied to search results.
type UserSearchFilter struct {
// An object that can be used to specify Tag conditions inside the SearchFilter .
// This accepts an OR of AND (List of List) input where:
// - Top level list specifies conditions that need to be applied with OR operator
// - Inner list specifies conditions that need to be applied with AND operator.
TagFilter *ControlPlaneTagFilter
noSmithyDocumentSerde
}
// Information about the returned users.
type UserSearchSummary struct {
// The Amazon Resource Name (ARN) of the user.
Arn *string
// The directory identifier of the user.
DirectoryUserId *string
// The identifier of the user's hierarchy group.
HierarchyGroupId *string
// The identifier of the user's summary.
Id *string
// The user's first name and last name.
IdentityInfo *UserIdentityInfoLite
// Contains information about the phone configuration settings for a user.
PhoneConfig *UserPhoneConfig
// The identifier of the user's routing profile.
RoutingProfileId *string
// The identifiers of the user's security profiles.
SecurityProfileIds []string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
// The name of the user.
Username *string
noSmithyDocumentSerde
}
// Contains summary information about a user.
type UserSummary struct {
// The Amazon Resource Name (ARN) of the user account.
Arn *string
// The identifier of the user account.
Id *string
// The Amazon Web Services Region where this resource was last modified.
LastModifiedRegion *string
// The timestamp when this resource was last modified.
LastModifiedTime *time.Time
// The Amazon Connect user name of the user account.
Username *string
noSmithyDocumentSerde
}
// A view resource object. Contains metadata and content necessary to render the
// view.
type View struct {
// The Amazon Resource Name (ARN) of the view.
Arn *string
// View content containing all content necessary to render a view except for
// runtime input data.
Content *ViewContent
// The timestamp of when the view was created.
CreatedTime *time.Time
// The description of the view.
Description *string
// The identifier of the view.
Id *string
// Latest timestamp of the UpdateViewContent or CreateViewVersion operations.
LastModifiedTime *time.Time
// The name of the view.
Name *string
// Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status
// will initiate validation on the content.
Status ViewStatus
// The tags associated with the view resource (not specific to view version).
Tags map[string]string
// The type of the view - CUSTOMER_MANAGED .
Type ViewType
// Current version of the view.
Version int32
// The description of the version.
VersionDescription *string
// Indicates the checksum value of the latest published view content.
ViewContentSha256 *string
noSmithyDocumentSerde
}
// View content containing all content necessary to render a view except for
// runtime input data.
type ViewContent struct {
// A list of possible actions from the view.
Actions []string
// The data schema matching data that the view template must be provided to render.
InputSchema *string
// The view template representing the structure of the view.
Template *string
noSmithyDocumentSerde
}
// View content containing all content necessary to render a view except for
// runtime input data and the runtime input schema, which is auto-generated by this
// operation.
type ViewInputContent struct {
// A list of possible actions from the view.
Actions []string
// The view template representing the structure of the view.
Template *string
noSmithyDocumentSerde
}
// A summary of a view's metadata.
type ViewSummary struct {
// The Amazon Resource Name (ARN) of the view.
Arn *string
// The description of the view.
Description *string
// The identifier of the view.
Id *string
// The name of the view.
Name *string
// Indicates the view status as either SAVED or PUBLISHED . The PUBLISHED status
// will initiate validation on the content.
Status ViewStatus
// The type of the view.
Type ViewType
noSmithyDocumentSerde
}
// A summary of a view version's metadata.
type ViewVersionSummary struct {
// The Amazon Resource Name (ARN) of the view version.
Arn *string
// The description of the view version.
Description *string
// The identifier of the view version.
Id *string
// The name of the view version.
Name *string
// The type of the view version.
Type ViewType
// The sequentially incremented version of the view version.
Version int32
// The description of the view version.
VersionDescription *string
noSmithyDocumentSerde
}
// Contains information about a custom vocabulary.
type Vocabulary struct {
// The Amazon Resource Name (ARN) of the custom vocabulary.
//
// This member is required.
Arn *string
// The identifier of the custom vocabulary.
//
// This member is required.
Id *string
// The language code of the vocabulary entries. For a list of languages and their
// corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)
//
// This member is required.
LanguageCode VocabularyLanguageCode
// The timestamp when the custom vocabulary was last modified.
//
// This member is required.
LastModifiedTime *time.Time
// A unique name of the custom vocabulary.
//
// This member is required.
Name *string
// The current state of the custom vocabulary.
//
// This member is required.
State VocabularyState
// The content of the custom vocabulary in plain-text format with a table of
// values. Each row in the table represents a word or a phrase, described with
// Phrase , IPA , SoundsLike , and DisplayAs fields. Separate the fields with TAB
// characters. For more information, see Create a custom vocabulary using a table (https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html#create-vocabulary-table)
// .
Content *string
// The reason why the custom vocabulary was not created.
FailureReason *string
// The tags used to organize, track, or control access for this resource. For
// example, { "Tags": {"key1":"value1", "key2":"value2"} }.
Tags map[string]string
noSmithyDocumentSerde
}
// Contains summary information about the custom vocabulary.
type VocabularySummary struct {
// The Amazon Resource Name (ARN) of the custom vocabulary.
//
// This member is required.
Arn *string
// The identifier of the custom vocabulary.
//
// This member is required.
Id *string
// The language code of the vocabulary entries. For a list of languages and their
// corresponding language codes, see What is Amazon Transcribe? (https://docs.aws.amazon.com/transcribe/latest/dg/transcribe-whatis.html)
//
// This member is required.
LanguageCode VocabularyLanguageCode
// The timestamp when the custom vocabulary was last modified.
//
// This member is required.
LastModifiedTime *time.Time
// A unique name of the custom vocabulary.
//
// This member is required.
Name *string
// The current state of the custom vocabulary.
//
// This member is required.
State VocabularyState
// The reason why the custom vocabulary was not created.
FailureReason *string
noSmithyDocumentSerde
}
// Contains information about the recording configuration settings.
type VoiceRecordingConfiguration struct {
// Identifies which track is being recorded.
VoiceRecordingTrack VoiceRecordingTrack
noSmithyDocumentSerde
}
// Information about Amazon Connect Wisdom.
type WisdomInfo struct {
// The Amazon Resource Name (ARN) of the Wisdom session.
SessionArn *string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
// UnknownUnionMember is returned when a union member is returned over the wire,
// but has an unknown tag.
type UnknownUnionMember struct {
Tag string
Value []byte
noSmithyDocumentSerde
}
func (*UnknownUnionMember) isEvaluationAnswerData() {}
func (*UnknownUnionMember) isEvaluationFormItem() {}
func (*UnknownUnionMember) isEvaluationFormNumericQuestionAutomation() {}
func (*UnknownUnionMember) isEvaluationFormQuestionTypeProperties() {}
func (*UnknownUnionMember) isEvaluationFormSingleSelectQuestionAutomationOption() {}
func (*UnknownUnionMember) isParticipantTimerValue() {}
func (*UnknownUnionMember) isPredefinedAttributeValues() {}
func (*UnknownUnionMember) isRealtimeContactAnalysisSegment() {}
func (*UnknownUnionMember) isRealTimeContactAnalysisTimeData() {}
func (*UnknownUnionMember) isReferenceSummary() {}
func (*UnknownUnionMember) isUpdateParticipantRoleConfigChannelInfo() {}
|