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
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package types
import (
smithydocument "github.com/aws/smithy-go/document"
"time"
)
// The Amazon Chime account details. An AWS account can have multiple Amazon Chime
// accounts.
type Account struct {
// The Amazon Chime account ID.
//
// This member is required.
AccountId *string
// The AWS account ID.
//
// This member is required.
AwsAccountId *string
// The Amazon Chime account name.
//
// This member is required.
Name *string
// The status of the account.
AccountStatus AccountStatus
// The Amazon Chime account type. For more information about different account
// types, see Managing Your Amazon Chime Accounts (https://docs.aws.amazon.com/chime/latest/ag/manage-chime-account.html)
// in the Amazon Chime Administration Guide.
AccountType AccountType
// The Amazon Chime account creation timestamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// The default license for the Amazon Chime account.
DefaultLicense License
// The sign-in delegate groups associated with the account.
SigninDelegateGroups []SigninDelegateGroup
// Supported licenses for the Amazon Chime account.
SupportedLicenses []License
noSmithyDocumentSerde
}
// Settings related to the Amazon Chime account. This includes settings that start
// or stop remote control of shared screens, or start or stop the dial-out option
// in the Amazon Chime web application. For more information about these settings,
// see Use the Policies Page (https://docs.aws.amazon.com/chime/latest/ag/policies.html)
// in the Amazon Chime Administration Guide.
type AccountSettings struct {
// Setting that stops or starts remote control of shared screens during meetings.
DisableRemoteControl *bool
// Setting that allows meeting participants to choose the Call me at a phone
// number option. For more information, see Join a Meeting without the Amazon
// Chime App (https://docs.aws.amazon.com/chime/latest/ug/chime-join-meeting.html) .
EnableDialOut *bool
noSmithyDocumentSerde
}
// A validated address.
type Address struct {
// The city of an address.
City *string
// The country of an address.
Country *string
// An address suffix location, such as the S. Unit A in Central Park S. Unit A .
PostDirectional *string
// The postal code of an address.
PostalCode *string
// The Zip + 4 or postal code + 4 of an address.
PostalCodePlus4 *string
// An address prefix location, such as the N in N. Third St. .
PreDirectional *string
// The state of an address.
State *string
// The address street, such as 8th Avenue .
StreetName *string
// The numeric portion of an address.
StreetNumber *string
// The address suffix, such as the N in 8th Avenue N .
StreetSuffix *string
noSmithyDocumentSerde
}
// The Alexa for Business metadata associated with an Amazon Chime user, used to
// integrate Alexa for Business with a device.
type AlexaForBusinessMetadata struct {
// The ARN of the room resource.
AlexaForBusinessRoomArn *string
// Starts or stops Alexa for Business.
IsAlexaForBusinessEnabled *bool
noSmithyDocumentSerde
}
// The details of an AppInstance , an instance of an Amazon Chime SDK messaging
// application.
type AppInstance struct {
// The ARN of the messaging instance.
AppInstanceArn *string
// The time at which an AppInstance was created. In epoch milliseconds.
CreatedTimestamp *time.Time
// The time an AppInstance was last updated. In epoch milliseconds.
LastUpdatedTimestamp *time.Time
// The metadata of an AppInstance .
Metadata *string
// The name of an AppInstance .
Name *string
noSmithyDocumentSerde
}
// The details of an AppInstanceAdmin .
type AppInstanceAdmin struct {
// The AppInstanceAdmin data.
Admin *Identity
// The ARN of the AppInstance for which the user is an administrator.
AppInstanceArn *string
// The time at which an administrator was created.
CreatedTimestamp *time.Time
noSmithyDocumentSerde
}
// Summary of the details of an AppInstanceAdmin .
type AppInstanceAdminSummary struct {
// The details of the AppInstanceAdmin .
Admin *Identity
noSmithyDocumentSerde
}
// The details of the data-retention settings for an AppInstance .
type AppInstanceRetentionSettings struct {
// The length of time in days to retain the messages in a channel.
ChannelRetentionSettings *ChannelRetentionSettings
noSmithyDocumentSerde
}
// The details of the streaming configuration of an AppInstance .
type AppInstanceStreamingConfiguration struct {
// The type of data to be streamed.
//
// This member is required.
AppInstanceDataType AppInstanceDataType
// The resource ARN.
//
// This member is required.
ResourceArn *string
noSmithyDocumentSerde
}
// Summary of the data for an AppInstance .
type AppInstanceSummary struct {
// The AppInstance ARN.
AppInstanceArn *string
// The metadata of the AppInstance .
Metadata *string
// The name of the AppInstance .
Name *string
noSmithyDocumentSerde
}
// The details of an AppInstanceUser .
type AppInstanceUser struct {
// The ARN of the AppInstanceUser .
AppInstanceUserArn *string
// The time at which the AppInstanceUser was created.
CreatedTimestamp *time.Time
// The time at which the AppInstanceUser was last updated.
LastUpdatedTimestamp *time.Time
// The metadata of the AppInstanceUser .
Metadata *string
// The name of the AppInstanceUser .
Name *string
noSmithyDocumentSerde
}
// Summary of the membership details of an AppInstanceUser .
type AppInstanceUserMembershipSummary struct {
// The time at which a message was last read.
ReadMarkerTimestamp *time.Time
// The type of ChannelMembership .
Type ChannelMembershipType
noSmithyDocumentSerde
}
// Summary of the details of an AppInstanceUser .
type AppInstanceUserSummary struct {
// The ARN of the AppInstanceUser .
AppInstanceUserArn *string
// The metadata of the AppInstanceUser .
Metadata *string
// The name of an AppInstanceUser .
Name *string
noSmithyDocumentSerde
}
// The configuration for the artifacts.
type ArtifactsConfiguration struct {
// The configuration for the audio artifacts.
//
// This member is required.
Audio *AudioArtifactsConfiguration
// The configuration for the content artifacts.
//
// This member is required.
Content *ContentArtifactsConfiguration
// The configuration for the video artifacts.
//
// This member is required.
Video *VideoArtifactsConfiguration
noSmithyDocumentSerde
}
// An Amazon Chime SDK meeting attendee. Includes a unique AttendeeId and JoinToken
// . The JoinToken allows a client to authenticate and join as the specified
// attendee. The JoinToken expires when the meeting ends or when DeleteAttendee is
// called. After that, the attendee is unable to join the meeting. We recommend
// securely transferring each JoinToken from your server application to the client
// so that no other client has access to the token except for the one authorized to
// represent the attendee.
type Attendee struct {
// The Amazon Chime SDK attendee ID.
AttendeeId *string
// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
// to an identity managed by a builder application.
ExternalUserId *string
// The join token used by the Amazon Chime SDK attendee.
JoinToken *string
noSmithyDocumentSerde
}
// The audio artifact configuration object.
type AudioArtifactsConfiguration struct {
// The MUX type of the audio artifact configuration object.
//
// This member is required.
MuxType AudioMuxType
noSmithyDocumentSerde
}
// The membership information, including member ARNs, the channel ARN, and
// membership types.
type BatchChannelMemberships struct {
// The ARN of the channel to which you're adding users.
ChannelArn *string
// The identifier of the member who invited another member.
InvitedBy *Identity
// The users successfully added to the request.
Members []Identity
// The membership types set for the channel users.
Type ChannelMembershipType
noSmithyDocumentSerde
}
// A list of failed member ARNs, error codes, and error messages.
type BatchCreateChannelMembershipError struct {
// The error code.
ErrorCode ErrorCode
// The error message.
ErrorMessage *string
// The ARN of the member that the service couldn't add.
MemberArn *string
noSmithyDocumentSerde
}
// A resource that allows Enterprise account administrators to configure an
// interface to receive events from Amazon Chime.
type Bot struct {
// The bot email address.
BotEmail *string
// The bot ID.
BotId *string
// The bot type.
BotType BotType
// The bot creation timestamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// When true, the bot is stopped from running in your account.
Disabled *bool
// The bot display name.
DisplayName *string
// The security token used to authenticate Amazon Chime with the outgoing event
// endpoint.
SecurityToken *string
// The updated bot timestamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
// The unique ID for the bot user.
UserId *string
noSmithyDocumentSerde
}
// The Amazon Chime Business Calling settings for the administrator's AWS account.
// Includes any Amazon S3 buckets designated for storing call detail records.
type BusinessCallingSettings struct {
// The Amazon S3 bucket designated for call detail record storage.
CdrBucket *string
noSmithyDocumentSerde
}
// A suggested address.
type CandidateAddress struct {
// The city of a candidate address.
City *string
// The country of a candidate address.
Country *string
// The postal code of a candidate address.
PostalCode *string
// The Zip + 4 or postal code + 4 of a candidate address.
PostalCodePlus4 *string
// The state of a candidate address.
State *string
// The street information of a candidate address
StreetInfo *string
// The numeric portion of a candidate address.
StreetNumber *string
noSmithyDocumentSerde
}
// The details of a channel.
type Channel struct {
// The ARN of the channel.
ChannelArn *string
// The AppInstanceUser who created the channel.
CreatedBy *Identity
// The time at which the AppInstanceUser created the channel.
CreatedTimestamp *time.Time
// The time at which a member sent the last message in the channel.
LastMessageTimestamp *time.Time
// The time at which a channel was last updated.
LastUpdatedTimestamp *time.Time
// The channel's metadata.
Metadata *string
// The mode of the channel.
Mode ChannelMode
// The name of the channel.
Name *string
// The channel's privacy setting.
Privacy ChannelPrivacy
noSmithyDocumentSerde
}
// The details of a channel ban.
type ChannelBan struct {
// The ARN of the channel from which a member is being banned.
ChannelArn *string
// The AppInstanceUser who created the ban.
CreatedBy *Identity
// The time at which the ban was created.
CreatedTimestamp *time.Time
// The member being banned from the channel.
Member *Identity
noSmithyDocumentSerde
}
// Summary of the details of a ChannelBan .
type ChannelBanSummary struct {
// The member being banned from a channel.
Member *Identity
noSmithyDocumentSerde
}
// The details of a channel member.
type ChannelMembership struct {
// The ARN of the member's channel.
ChannelArn *string
// The time at which the channel membership was created.
CreatedTimestamp *time.Time
// The identifier of the member who invited another member.
InvitedBy *Identity
// The time at which a channel membership was last updated.
LastUpdatedTimestamp *time.Time
// The data of the channel member.
Member *Identity
// The membership type set for the channel member.
Type ChannelMembershipType
noSmithyDocumentSerde
}
// Summary of the channel membership details of an AppInstanceUser .
type ChannelMembershipForAppInstanceUserSummary struct {
// Summary of the membership details of an AppInstanceUser .
AppInstanceUserMembershipSummary *AppInstanceUserMembershipSummary
// Summary of the details of a Channel .
ChannelSummary *ChannelSummary
noSmithyDocumentSerde
}
// Summary of the details of a ChannelMembership .
type ChannelMembershipSummary struct {
// A member's summary data.
Member *Identity
noSmithyDocumentSerde
}
// The details of a message in a channel.
type ChannelMessage struct {
// The ARN of the channel.
ChannelArn *string
// The message content.
Content *string
// The time at which the message was created.
CreatedTimestamp *time.Time
// The time at which a message was edited.
LastEditedTimestamp *time.Time
// The time at which a message was updated.
LastUpdatedTimestamp *time.Time
// The ID of a message.
MessageId *string
// The message metadata.
Metadata *string
// The persistence setting for a channel message.
Persistence ChannelMessagePersistenceType
// Hides the content of a message.
Redacted bool
// The message sender.
Sender *Identity
// The message type.
Type ChannelMessageType
noSmithyDocumentSerde
}
// Summary of the messages in a Channel .
type ChannelMessageSummary struct {
// The content of the message.
Content *string
// The time at which the message summary was created.
CreatedTimestamp *time.Time
// The time at which a message was last edited.
LastEditedTimestamp *time.Time
// The time at which a message was last updated.
LastUpdatedTimestamp *time.Time
// The ID of the message.
MessageId *string
// The metadata of the message.
Metadata *string
// Indicates whether a message was redacted.
Redacted bool
// The message sender.
Sender *Identity
// The type of message.
Type ChannelMessageType
noSmithyDocumentSerde
}
// Summary of the details of a moderated channel.
type ChannelModeratedByAppInstanceUserSummary struct {
// Summary of the details of a Channel .
ChannelSummary *ChannelSummary
noSmithyDocumentSerde
}
// The details of a channel moderator.
type ChannelModerator struct {
// The ARN of the moderator's channel.
ChannelArn *string
// The AppInstanceUser who created the moderator.
CreatedBy *Identity
// The time at which the moderator was created.
CreatedTimestamp *time.Time
// The moderator's data.
Moderator *Identity
noSmithyDocumentSerde
}
// Summary of the details of a ChannelModerator .
type ChannelModeratorSummary struct {
// The data for a moderator.
Moderator *Identity
noSmithyDocumentSerde
}
// The details of the retention settings for a channel.
type ChannelRetentionSettings struct {
// The time in days to retain the messages in a channel.
RetentionDays *int32
noSmithyDocumentSerde
}
// Summary of the details of a Channel .
type ChannelSummary struct {
// The ARN of the channel.
ChannelArn *string
// The time at which the last message in a channel was sent.
LastMessageTimestamp *time.Time
// The metadata of the channel.
Metadata *string
// The mode of the channel.
Mode ChannelMode
// The name of the channel.
Name *string
// The privacy setting of the channel.
Privacy ChannelPrivacy
noSmithyDocumentSerde
}
// The configuration object of the Amazon Chime SDK meeting for a specified media
// capture pipeline. SourceType must be ChimeSdkMeeting .
type ChimeSdkMeetingConfiguration struct {
// The configuration for the artifacts in an Amazon Chime SDK meeting.
ArtifactsConfiguration *ArtifactsConfiguration
// The source configuration for a specified media capture pipeline.
SourceConfiguration *SourceConfiguration
noSmithyDocumentSerde
}
// The content artifact object.
type ContentArtifactsConfiguration struct {
// Indicates whether the content artifact is enabled or disabled.
//
// This member is required.
State ArtifactsState
// The MUX type of the artifact configuration.
MuxType ContentMuxType
noSmithyDocumentSerde
}
// The retention settings that determine how long to retain conversation messages
// for an Amazon Chime Enterprise account.
type ConversationRetentionSettings struct {
// The number of days for which to retain conversation messages.
RetentionDays *int32
noSmithyDocumentSerde
}
// The list of errors returned when errors are encountered during the
// BatchCreateAttendee and CreateAttendee actions. This includes external user IDs,
// error codes, and error messages.
type CreateAttendeeError struct {
// The error code.
ErrorCode *string
// The error message.
ErrorMessage *string
// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
// to an identity managed by a builder application.
ExternalUserId *string
noSmithyDocumentSerde
}
// The Amazon Chime SDK attendee fields to create, used with the
// BatchCreateAttendee action.
type CreateAttendeeRequestItem struct {
// The Amazon Chime SDK external user ID. An idempotency token. Links the attendee
// to an identity managed by a builder application.
//
// This member is required.
ExternalUserId *string
// The tag key-value pairs.
Tags []Tag
noSmithyDocumentSerde
}
// The SIP credentials used to authenticate requests to your Amazon Chime Voice
// Connector.
type Credential struct {
// The RFC2617 compliant password associated with the SIP credentials, in US-ASCII
// format.
Password *string
// The RFC2617 compliant user name associated with the SIP credentials, in
// US-ASCII format.
Username *string
noSmithyDocumentSerde
}
// The Dialed Number Identification Service (DNIS) emergency calling configuration
// details associated with an Amazon Chime Voice Connector's emergency calling
// configuration.
type DNISEmergencyCallingConfiguration struct {
// The country from which emergency calls are allowed, in ISO 3166-1 alpha-2
// format.
//
// This member is required.
CallingCountry *string
// The DNIS phone number to route emergency calls to, in E.164 format.
//
// This member is required.
EmergencyPhoneNumber *string
// The DNIS phone number to route test emergency calls to, in E.164 format.
TestPhoneNumber *string
noSmithyDocumentSerde
}
// The emergency calling configuration details associated with an Amazon Chime
// Voice Connector.
type EmergencyCallingConfiguration struct {
// The Dialed Number Identification Service (DNIS) emergency calling configuration
// details.
DNIS []DNISEmergencyCallingConfiguration
noSmithyDocumentSerde
}
// Settings specific to the Amazon Transcribe Medical engine.
type EngineTranscribeMedicalSettings struct {
// The language code specified for the Amazon Transcribe Medical engine.
//
// This member is required.
LanguageCode TranscribeMedicalLanguageCode
// The specialty specified for the Amazon Transcribe Medical engine.
//
// This member is required.
Specialty TranscribeMedicalSpecialty
// The type of transcription.
//
// This member is required.
Type TranscribeMedicalType
// Labels all personally identifiable information (PII) identified in your
// transcript. If you don't include PiiEntityTypes , all PII is identified. You
// can’t set ContentIdentificationType and ContentRedactionType .
ContentIdentificationType TranscribeMedicalContentIdentificationType
// The AWS Region passed to Amazon Transcribe Medical. If you don't specify a
// Region, Amazon Chime uses the meeting's Region.
Region TranscribeMedicalRegion
// The name of the vocabulary passed to Amazon Transcribe Medical.
VocabularyName *string
noSmithyDocumentSerde
}
// Settings specific for Amazon Transcribe as the live transcription engine. If
// you specify an invalid combination of parameters, a TranscriptFailed event will
// be sent with the contents of the BadRequestException generated by Amazon
// Transcribe. For more information on each parameter and which combinations are
// valid, refer to the StartStreamTranscription (https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_StartStreamTranscription.html)
// API in the Amazon Transcribe Developer Guide.
type EngineTranscribeSettings struct {
// Labels all personally identifiable information (PII) identified in your
// transcript. If you don't include PiiEntityTypes , all PII is identified. You
// can’t set ContentIdentificationType and ContentRedactionType .
ContentIdentificationType TranscribeContentIdentificationType
// Content redaction is performed at the segment level. If you don't include
// PiiEntityTypes , all PII is redacted. You can’t set ContentIdentificationType
// and ContentRedactionType .
ContentRedactionType TranscribeContentRedactionType
// Enables partial result stabilization for your transcription. Partial result
// stabilization can reduce latency in your output, but may impact accuracy.
EnablePartialResultsStabilization *bool
// Enables automatic language identification for your transcription. If you
// include IdentifyLanguage , you can optionally use LanguageOptions to include a
// list of language codes that you think may be present in your audio stream.
// Including language options can improve transcription accuracy. You can also use
// PreferredLanguage to include a preferred language. Doing so can help Amazon
// Transcribe identify the language faster. You must include either LanguageCode
// or IdentifyLanguage . Language identification can't be combined with custom
// language models or redaction.
IdentifyLanguage *bool
// Specify the language code that represents the language spoken. If you're unsure
// of the language spoken in your audio, consider using IdentifyLanguage to enable
// automatic language identification.
LanguageCode TranscribeLanguageCode
// Specify the name of the custom language model that you want to use when
// processing your transcription. Note that language model names are case
// sensitive. The language of the specified language model must match the language
// code. If the languages don't match, the custom language model isn't applied.
// There are no errors or warnings associated with a language mismatch. If you use
// Amazon Transcribe in multiple Regions, the custom language model must be
// available in Amazon Transcribe in each Region.
LanguageModelName *string
// Specify two or more language codes that represent the languages you think may
// be present in your media; including more than five is not recommended. If you're
// unsure what languages are present, do not include this parameter. Including
// language options can improve the accuracy of language identification. If you
// include LanguageOptions , you must also include IdentifyLanguage . You can only
// include one language dialect per language. For example, you cannot include en-US
// and en-AU .
LanguageOptions *string
// Specify the level of stability to use when you enable partial results
// stabilization ( EnablePartialResultsStabilization ). Low stability provides the
// highest accuracy. High stability transcribes faster, but with slightly lower
// accuracy.
PartialResultsStability TranscribePartialResultsStability
// Specify which types of personally identifiable information (PII) you want to
// redact in your transcript. You can include as many types as you'd like, or you
// can select ALL . Values must be comma-separated and can include: ADDRESS ,
// BANK_ACCOUNT_NUMBER , BANK_ROUTING , CREDIT_DEBIT_CVV , CREDIT_DEBIT_EXPIRY
// CREDIT_DEBIT_NUMBER , EMAIL , NAME , PHONE , PIN , SSN , or ALL . Note that if
// you include PiiEntityTypes , you must also include ContentIdentificationType or
// ContentRedactionType . If you include ContentRedactionType or
// ContentIdentificationType , but do not include PiiEntityTypes , all PII is
// redacted or identified.
PiiEntityTypes *string
// Specify a preferred language from the subset of languages codes you specified
// in LanguageOptions . You can only use this parameter if you include
// IdentifyLanguage and LanguageOptions .
PreferredLanguage TranscribeLanguageCode
// The AWS Region in which to use Amazon Transcribe. If you don't specify a
// Region, then the MediaRegion parameter of the CreateMeeting.html (https://docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html)
// API will be used. However, if Amazon Transcribe is not available in the
// MediaRegion , then a TranscriptFailed event is sent. Use auto to use Amazon
// Transcribe in a Region near the meeting’s MediaRegion . For more information,
// refer to Choosing a transcription Region (https://docs.aws.amazon.com/chime-sdk/latest/dg/transcription-options.html#choose-region)
// in the Amazon Chime SDK Developer Guide.
Region TranscribeRegion
// Specify how you want your vocabulary filter applied to your transcript. To
// replace words with *** , choose mask . To delete words, choose remove . To flag
// words without changing them, choose tag .
VocabularyFilterMethod TranscribeVocabularyFilterMethod
// Specify the name of the custom vocabulary filter that you want to use when
// processing your transcription. Note that vocabulary filter names are case
// sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary
// filter must be available in Amazon Transcribe in each Region. If you include
// IdentifyLanguage and want to use one or more vocabulary filters with your
// transcription, use the VocabularyFilterNames parameter instead.
VocabularyFilterName *string
// Specify the names of the custom vocabulary filters that you want to use when
// processing your transcription. Note that vocabulary filter names are case
// sensitive. If you use Amazon Transcribe in multiple Regions, the vocabulary
// filter must be available in Amazon Transcribe in each Region. If you're not
// including IdentifyLanguage and want to use a custom vocabulary filter with your
// transcription, use the VocabularyFilterName parameter instead.
VocabularyFilterNames *string
// Specify the name of the custom vocabulary that you want to use when processing
// your transcription. Note that vocabulary names are case sensitive. If you use
// Amazon Transcribe multiple Regions, the vocabulary must be available in Amazon
// Transcribe in each Region. If you include IdentifyLanguage and want to use one
// or more custom vocabularies with your transcription, use the VocabularyNames
// parameter instead.
VocabularyName *string
// Specify the names of the custom vocabularies that you want to use when
// processing your transcription. Note that vocabulary names are case sensitive. If
// you use Amazon Transcribe in multiple Regions, the vocabulary must be available
// in Amazon Transcribe in each Region. If you don't include IdentifyLanguage and
// want to use a custom vocabulary with your transcription, use the VocabularyName
// parameter instead.
VocabularyNames *string
noSmithyDocumentSerde
}
// The configuration that allows a bot to receive outgoing events. Can be either
// an HTTPS endpoint or a Lambda function ARN.
type EventsConfiguration struct {
// The bot ID.
BotId *string
// Lambda function ARN that allows a bot to receive outgoing events.
LambdaFunctionArn *string
// HTTPS endpoint that allows a bot to receive outgoing events.
OutboundEventsHTTPSEndpoint *string
noSmithyDocumentSerde
}
// The country and area code for a proxy phone number in a proxy phone session.
type GeoMatchParams struct {
// The area code.
//
// This member is required.
AreaCode *string
// The country.
//
// This member is required.
Country *string
noSmithyDocumentSerde
}
// The details of a user.
type Identity struct {
// The ARN in an Identity.
Arn *string
// The name in an Identity.
Name *string
noSmithyDocumentSerde
}
// Invitation object returned after emailing users to invite them to join the
// Amazon Chime Team account.
type Invite struct {
// The email address to which the invite is sent.
EmailAddress *string
// The status of the invite email.
EmailStatus EmailStatus
// The invite ID.
InviteId *string
// The status of the invite.
Status InviteStatus
noSmithyDocumentSerde
}
// The logging configuration associated with an Amazon Chime Voice Connector.
// Specifies whether SIP message logs are enabled for sending to Amazon CloudWatch
// Logs.
type LoggingConfiguration struct {
// Boolean that enables logging of detailed media metrics for Voice Connectors to
// Amazon CloudWatch logs.
EnableMediaMetricLogs *bool
// Boolean that enables SIP message logs to Amazon CloudWatch logs.
EnableSIPLogs *bool
noSmithyDocumentSerde
}
// A media capture pipeline object consisting of an ID, source type, source ARN, a
// sink type, a sink ARN, and a configuration object.
type MediaCapturePipeline struct {
// The configuration for a specified media capture pipeline. SourceType must be
// ChimeSdkMeeting .
ChimeSdkMeetingConfiguration *ChimeSdkMeetingConfiguration
// The time at which the capture pipeline was created, in ISO 8601 format.
CreatedTimestamp *time.Time
// The ID of a media capture pipeline.
MediaPipelineId *string
// ARN of the destination to which the media artifacts are saved.
SinkArn *string
// Destination type to which the media artifacts are saved. You must use an S3
// Bucket.
SinkType MediaPipelineSinkType
// ARN of the source from which the media artifacts will be saved.
SourceArn *string
// Source type from which media artifacts are saved. You must use ChimeMeeting .
SourceType MediaPipelineSourceType
// The status of the media capture pipeline.
Status MediaPipelineStatus
// The time at which the capture pipeline was updated, in ISO 8601 format.
UpdatedTimestamp *time.Time
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 screen data URL. This parameter is is no longer supported and no longer
// used by the Amazon Chime SDK.
ScreenDataUrl *string
// The screen sharing URL. This parameter is is no longer supported and no longer
// used by the Amazon Chime SDK..
ScreenSharingUrl *string
// The screen viewing URL. This parameter is is no longer supported and no longer
// used by the Amazon Chime SDK.
ScreenViewingUrl *string
// The signaling URL.
SignalingUrl *string
// The turn control URL. This parameter is is no longer supported and no longer
// used by the Amazon Chime SDK.
TurnControlUrl *string
noSmithyDocumentSerde
}
// A meeting created using the Amazon Chime SDK.
type Meeting struct {
// The external meeting ID.
ExternalMeetingId *string
// The media placement for the meeting.
MediaPlacement *MediaPlacement
// The Region in which you create the meeting. Available values: af-south-1 ,
// ap-northeast-1 , ap-northeast-2 , ap-south-1 , ap-southeast-1 , ap-southeast-2 ,
// ca-central-1 , eu-central-1 , eu-north-1 , eu-south-1 , eu-west-1 , eu-west-2 ,
// eu-west-3 , sa-east-1 , us-east-1 , us-east-2 , us-west-1 , us-west-2 .
MediaRegion *string
// The Amazon Chime SDK meeting ID.
MeetingId *string
noSmithyDocumentSerde
}
// The resource target configurations for receiving Amazon Chime SDK meeting and
// attendee event notifications. The Amazon Chime SDK supports resource targets
// located in the US East (N. Virginia) AWS Region ( us-east-1 ).
type MeetingNotificationConfiguration struct {
// The SNS topic ARN.
SnsTopicArn *string
// The SQS queue ARN.
SqsQueueArn *string
noSmithyDocumentSerde
}
// The member details, such as email address, name, member ID, and member type.
type Member struct {
// The Amazon Chime account ID.
AccountId *string
// The member email address.
Email *string
// The member name.
FullName *string
// The member ID (user ID or bot ID).
MemberId *string
// The member type.
MemberType MemberType
noSmithyDocumentSerde
}
// The list of errors returned when a member action results in an error.
type MemberError struct {
// The error code.
ErrorCode ErrorCode
// The error message.
ErrorMessage *string
// The member ID.
MemberId *string
noSmithyDocumentSerde
}
// Membership details, such as member ID and member role.
type MembershipItem struct {
// The member ID.
MemberId *string
// The member role.
Role RoomMembershipRole
noSmithyDocumentSerde
}
// The websocket endpoint used to connect to Amazon Chime SDK messaging.
type MessagingSessionEndpoint struct {
// The endpoint to which you establish a websocket connection.
Url *string
noSmithyDocumentSerde
}
// A phone number for which an order has been placed.
type OrderedPhoneNumber struct {
// The phone number, in E.164 format.
E164PhoneNumber *string
// The phone number status.
Status OrderedPhoneNumberStatus
noSmithyDocumentSerde
}
// Origination settings enable your SIP hosts to receive inbound calls using your
// Amazon Chime Voice Connector. The parameters listed below are not required, but
// you must use at least one.
type Origination struct {
// When origination settings are disabled, inbound calls are not enabled for your
// Amazon Chime Voice Connector. This parameter is not required, but you must
// specify this parameter or Routes .
Disabled *bool
// The call distribution properties defined for your SIP hosts. Valid range:
// Minimum value of 1. Maximum value of 20. This parameter is not required, but you
// must specify this parameter or Disabled .
Routes []OriginationRoute
noSmithyDocumentSerde
}
// Origination routes define call distribution properties for your SIP hosts to
// receive inbound calls using your Amazon Chime Voice Connector. Limit: Ten
// origination routes for each Amazon Chime Voice Connector. The parameters listed
// below are not required, but you must use at least one.
type OriginationRoute struct {
// The FQDN or IP address to contact for origination traffic.
Host *string
// The designated origination route port. Defaults to 5060.
Port *int32
// The priority associated with the host, with 1 being the highest priority.
// Higher priority hosts are attempted first.
Priority *int32
// The protocol to use for the origination route. Encryption-enabled Amazon Chime
// Voice Connectors use TCP protocol by default.
Protocol OriginationRouteProtocol
// The weight associated with the host. If hosts are equal in priority, calls are
// redistributed among them based on their relative weight.
Weight *int32
noSmithyDocumentSerde
}
// The phone number and proxy phone number for a participant in an Amazon Chime
// Voice Connector proxy session.
type Participant struct {
// The participant's phone number.
PhoneNumber *string
// The participant's proxy phone number.
ProxyPhoneNumber *string
noSmithyDocumentSerde
}
// A phone number used for Amazon Chime Business Calling or an Amazon Chime Voice
// Connector.
type PhoneNumber struct {
// The phone number associations.
Associations []PhoneNumberAssociation
// The outbound calling name associated with the phone number.
CallingName *string
// The outbound calling name status.
CallingNameStatus CallingNameStatus
// The phone number capabilities.
Capabilities *PhoneNumberCapabilities
// The phone number country. Format: ISO 3166-1 alpha-2.
Country *string
// The phone number creation timestamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// The deleted phone number timestamp, in ISO 8601 format.
DeletionTimestamp *time.Time
// The phone number, in E.164 format.
E164PhoneNumber *string
// The phone number ID.
PhoneNumberId *string
// The phone number product type.
ProductType PhoneNumberProductType
// The phone number status.
Status PhoneNumberStatus
// The phone number type.
Type PhoneNumberType
// The updated phone number timestamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
noSmithyDocumentSerde
}
// The phone number associations, such as Amazon Chime account ID, Amazon Chime
// user ID, Amazon Chime Voice Connector ID, or Amazon Chime Voice Connector group
// ID.
type PhoneNumberAssociation struct {
// The timestamp of the phone number association, in ISO 8601 format.
AssociatedTimestamp *time.Time
// Defines the association with an Amazon Chime account ID, user ID, Amazon Chime
// Voice Connector ID, or Amazon Chime Voice Connector group ID.
Name PhoneNumberAssociationName
// Contains the ID for the entity specified in Name.
Value *string
noSmithyDocumentSerde
}
// The phone number capabilities for Amazon Chime Business Calling phone numbers,
// such as enabled inbound and outbound calling and text messaging.
type PhoneNumberCapabilities struct {
// Allows or denies inbound calling for the specified phone number.
InboundCall *bool
// Allows or denies inbound MMS messaging for the specified phone number.
InboundMMS *bool
// Allows or denies inbound SMS messaging for the specified phone number.
InboundSMS *bool
// Allows or denies outbound calling for the specified phone number.
OutboundCall *bool
// Allows or denies outbound MMS messaging for the specified phone number.
OutboundMMS *bool
// Allows or denies outbound SMS messaging for the specified phone number.
OutboundSMS *bool
noSmithyDocumentSerde
}
// The phone number country.
type PhoneNumberCountry struct {
// The phone number country code. Format: ISO 3166-1 alpha-2.
CountryCode *string
// The supported phone number types.
SupportedPhoneNumberTypes []PhoneNumberType
noSmithyDocumentSerde
}
// If the phone number action fails for one or more of the phone numbers in the
// request, a list of the phone numbers is returned, along with error codes and
// error messages.
type PhoneNumberError struct {
// The error code.
ErrorCode ErrorCode
// The error message.
ErrorMessage *string
// The phone number ID for which the action failed.
PhoneNumberId *string
noSmithyDocumentSerde
}
// The details of a phone number order created for Amazon Chime.
type PhoneNumberOrder struct {
// The phone number order creation time stamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// The ordered phone number details, such as the phone number in E.164 format and
// the phone number status.
OrderedPhoneNumbers []OrderedPhoneNumber
// The phone number order ID.
PhoneNumberOrderId *string
// The phone number order product type.
ProductType PhoneNumberProductType
// The status of the phone number order.
Status PhoneNumberOrderStatus
// The updated phone number order time stamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
noSmithyDocumentSerde
}
// The proxy configuration for an Amazon Chime Voice Connector.
type Proxy struct {
// The default number of minutes allowed for proxy sessions.
DefaultSessionExpiryMinutes *int32
// When true, stops proxy sessions from being created on the specified Amazon
// Chime Voice Connector.
Disabled *bool
// The phone number to route calls to after a proxy session expires.
FallBackPhoneNumber *string
// The countries for proxy phone numbers to be selected from.
PhoneNumberCountries []string
noSmithyDocumentSerde
}
// The proxy session for an Amazon Chime Voice Connector.
type ProxySession struct {
// The proxy session capabilities.
Capabilities []Capability
// The created time stamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// The ended time stamp, in ISO 8601 format.
EndedTimestamp *time.Time
// The number of minutes allowed for the proxy session.
ExpiryMinutes *int32
// The preference for matching the country or area code of the proxy phone number
// with that of the first participant.
GeoMatchLevel GeoMatchLevel
// The country and area code for the proxy phone number.
GeoMatchParams *GeoMatchParams
// The name of the proxy session.
Name *string
// The preference for proxy phone number reuse, or stickiness, between the same
// participants across sessions.
NumberSelectionBehavior NumberSelectionBehavior
// The proxy session participants.
Participants []Participant
// The proxy session ID.
ProxySessionId *string
// The status of the proxy session.
Status ProxySessionStatus
// The updated time stamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
// The Amazon Chime voice connector ID.
VoiceConnectorId *string
noSmithyDocumentSerde
}
// The retention settings for an Amazon Chime Enterprise account that determine
// how long to retain items such as chat-room messages and chat-conversation
// messages.
type RetentionSettings struct {
// The chat conversation retention settings.
ConversationRetentionSettings *ConversationRetentionSettings
// The chat room retention settings.
RoomRetentionSettings *RoomRetentionSettings
noSmithyDocumentSerde
}
// The Amazon Chime chat room details.
type Room struct {
// The Amazon Chime account ID.
AccountId *string
// The identifier of the room creator.
CreatedBy *string
// The room creation timestamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// The room name.
Name *string
// The room ID.
RoomId *string
// The room update timestamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
noSmithyDocumentSerde
}
// The room membership details.
type RoomMembership struct {
// The identifier of the user that invited the room member.
InvitedBy *string
// The member details, such as email address, name, member ID, and member type.
Member *Member
// The membership role.
Role RoomMembershipRole
// The room ID.
RoomId *string
// The room membership update timestamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
noSmithyDocumentSerde
}
// The retention settings that determine how long to retain chat-room messages for
// an Amazon Chime Enterprise account.
type RoomRetentionSettings struct {
// The number of days for which to retain chat-room messages.
RetentionDays *int32
noSmithyDocumentSerde
}
// The video streams to capture for a specified media capture pipeline. The total
// number of video streams can't exceed 25.
type SelectedVideoStreams struct {
// The attendee IDs of the streams selected for a media capture pipeline.
AttendeeIds []string
// The external user IDs of the streams selected for a media capture pipeline.
ExternalUserIds []string
noSmithyDocumentSerde
}
// An Active Directory (AD) group whose members are granted permission to act as
// delegates.
type SigninDelegateGroup struct {
// The group name.
GroupName *string
noSmithyDocumentSerde
}
// The details of the SIP media application, including name and endpoints. An AWS
// account can have multiple SIP media applications.
type SipMediaApplication struct {
// The AWS Region in which the SIP media application is created.
AwsRegion *string
// The SIP media application creation timestamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// List of endpoints for SIP media application. Currently, only one endpoint per
// SIP media application is permitted.
Endpoints []SipMediaApplicationEndpoint
// The name of the SIP media application.
Name *string
// The SIP media application ID.
SipMediaApplicationId *string
// The SIP media application updated timestamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
noSmithyDocumentSerde
}
// A Call instance for a SIP media application.
type SipMediaApplicationCall struct {
// The transaction ID of a call.
TransactionId *string
noSmithyDocumentSerde
}
// The endpoint assigned to the SIP media application.
type SipMediaApplicationEndpoint struct {
// Valid Amazon Resource Name (ARN) of the Lambda function, version, or alias. The
// function must be created in the same AWS Region as the SIP media application.
LambdaArn *string
noSmithyDocumentSerde
}
// Logging configuration of the SIP media application.
type SipMediaApplicationLoggingConfiguration struct {
// Enables application message logs for the SIP media application.
EnableSipMediaApplicationMessageLogs *bool
noSmithyDocumentSerde
}
// The SIP rule details, including name, triggers, and target applications. An AWS
// account can have multiple SIP rules.
type SipRule struct {
// The time at which the SIP rule was created, in ISO 8601 format.
CreatedTimestamp *time.Time
// Indicates whether the SIP rule is enabled or disabled. You must disable a rule
// before you can delete it.
Disabled *bool
// The name of the SIP rule.
Name *string
// The SIP rule ID.
SipRuleId *string
// Target SIP media application and other details, such as priority and AWS
// Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be
// provided.
TargetApplications []SipRuleTargetApplication
// The type of trigger assigned to the SIP rule in TriggerValue , currently
// RequestUriHostname or ToPhoneNumber .
TriggerType SipRuleTriggerType
// If TriggerType is RequestUriHostname , then the value can be the outbound host
// name of the Amazon Chime Voice Connector. If TriggerType is ToPhoneNumber , then
// the value can be a customer-owned phone number in E164 format. SipRule is
// triggered when a SIP rule requests host name or ToPhoneNumber matches in the
// incoming SIP request.
TriggerValue *string
// The time at which the SIP rule was last updated, in ISO 8601 format.
UpdatedTimestamp *time.Time
noSmithyDocumentSerde
}
// Target SIP media application and other details, such as priority and AWS
// Region, to be specified in the SIP rule. Only one SIP rule per AWS Region can be
// provided.
type SipRuleTargetApplication struct {
// The AWS Region of the target application.
AwsRegion *string
// Priority of the SIP media application in the target list.
Priority *int32
// The SIP media application ID.
SipMediaApplicationId *string
noSmithyDocumentSerde
}
// Source configuration for a specified media capture pipeline.
type SourceConfiguration struct {
// The selected video streams to capture for a specified media capture pipeline.
// The number of video streams can't exceed 25.
SelectedVideoStreams *SelectedVideoStreams
noSmithyDocumentSerde
}
// The streaming configuration associated with an Amazon Chime Voice Connector.
// Specifies whether media streaming is enabled for sending to Amazon Kinesis, and
// shows the retention period for the Amazon Kinesis data, in hours.
type StreamingConfiguration struct {
// The retention period, in hours, for the Amazon Kinesis data.
//
// This member is required.
DataRetentionInHours *int32
// When true, media streaming to Amazon Kinesis is turned off.
Disabled *bool
// The streaming notification targets.
StreamingNotificationTargets []StreamingNotificationTarget
noSmithyDocumentSerde
}
// The targeted recipient for a streaming configuration notification.
type StreamingNotificationTarget struct {
// The streaming notification target.
//
// This member is required.
NotificationTarget NotificationTarget
noSmithyDocumentSerde
}
// Describes a tag applied to a resource.
type Tag struct {
// The key of the tag.
//
// This member is required.
Key *string
// The value of the tag.
//
// This member is required.
Value *string
noSmithyDocumentSerde
}
// Settings that allow management of telephony permissions for an Amazon Chime
// user, such as inbound and outbound calling and text messaging.
type TelephonySettings struct {
// Allows or denies inbound calling.
//
// This member is required.
InboundCalling *bool
// Allows or denies outbound calling.
//
// This member is required.
OutboundCalling *bool
// Allows or denies SMS messaging.
//
// This member is required.
SMS *bool
noSmithyDocumentSerde
}
// Termination settings enable your SIP hosts to make outbound calls using your
// Amazon Chime Voice Connector.
type Termination struct {
// The countries to which calls are allowed, in ISO 3166-1 alpha-2 format.
// Required.
CallingRegions []string
// The IP addresses allowed to make calls, in CIDR format. Required.
CidrAllowedList []string
// The limit on calls per second. Max value based on account service quota.
// Default value of 1.
CpsLimit *int32
// The default caller ID phone number.
DefaultPhoneNumber *string
// When termination settings are disabled, outbound calls can not be made.
Disabled *bool
noSmithyDocumentSerde
}
// The termination health details, including the source IP address and timestamp
// of the last successful SIP OPTIONS message from your SIP infrastructure.
type TerminationHealth struct {
// The source IP address.
Source *string
// The timestamp, in ISO 8601 format.
Timestamp *time.Time
noSmithyDocumentSerde
}
// The configuration for the current transcription operation. Must contain
// EngineTranscribeSettings or EngineTranscribeMedicalSettings .
type TranscriptionConfiguration struct {
// The transcription configuration settings passed to Amazon Transcribe Medical.
EngineTranscribeMedicalSettings *EngineTranscribeMedicalSettings
// The transcription configuration settings passed to Amazon Transcribe.
EngineTranscribeSettings *EngineTranscribeSettings
noSmithyDocumentSerde
}
// The phone number ID, product type, or calling name fields to update, used with
// the BatchUpdatePhoneNumber and UpdatePhoneNumber actions.
type UpdatePhoneNumberRequestItem struct {
// The phone number ID to update.
//
// This member is required.
PhoneNumberId *string
// The outbound calling name to update.
CallingName *string
// The product type to update.
ProductType PhoneNumberProductType
noSmithyDocumentSerde
}
// The user ID and user fields to update, used with the BatchUpdateUser action.
type UpdateUserRequestItem struct {
// The user ID.
//
// This member is required.
UserId *string
// The Alexa for Business metadata.
AlexaForBusinessMetadata *AlexaForBusinessMetadata
// The user license type.
LicenseType License
// The user type.
UserType UserType
noSmithyDocumentSerde
}
// The user on the Amazon Chime account.
type User struct {
// The user ID.
//
// This member is required.
UserId *string
// The Amazon Chime account ID.
AccountId *string
// The Alexa for Business metadata.
AlexaForBusinessMetadata *AlexaForBusinessMetadata
// The display name of the user.
DisplayName *string
// Date and time when the user is invited to the Amazon Chime account, in ISO 8601
// format.
InvitedOn *time.Time
// The license type for the user.
LicenseType License
// The user's personal meeting PIN.
PersonalPIN *string
// The primary email address of the user.
PrimaryEmail *string
// The primary phone number associated with the user.
PrimaryProvisionedNumber *string
// Date and time when the user is registered, in ISO 8601 format.
RegisteredOn *time.Time
// The user invite status.
UserInvitationStatus InviteStatus
// The user registration status.
UserRegistrationStatus RegistrationStatus
// The user type.
UserType UserType
noSmithyDocumentSerde
}
// The list of errors returned when errors are encountered during the
// BatchSuspendUser , BatchUnsuspendUser , or BatchUpdateUser actions. This
// includes user IDs, error codes, and error messages.
type UserError struct {
// The error code.
ErrorCode ErrorCode
// The error message.
ErrorMessage *string
// The user ID for which the action failed.
UserId *string
noSmithyDocumentSerde
}
// Settings associated with an Amazon Chime user, including inbound and outbound
// calling and text messaging.
type UserSettings struct {
// The telephony settings associated with the user.
//
// This member is required.
Telephony *TelephonySettings
noSmithyDocumentSerde
}
// The video artifact configuration object.
type VideoArtifactsConfiguration struct {
// Indicates whether the video artifact is enabled or disabled.
//
// This member is required.
State ArtifactsState
// The MUX type of the video artifact configuration object.
MuxType VideoMuxType
noSmithyDocumentSerde
}
// The Amazon Chime Voice Connector configuration, including outbound host name
// and encryption settings.
type VoiceConnector struct {
// The AWS Region in which the Amazon Chime Voice Connector is created. Default:
// us-east-1 .
AwsRegion VoiceConnectorAwsRegion
// The Amazon Chime Voice Connector creation timestamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// The name of the Amazon Chime Voice Connector.
Name *string
// The outbound host name for the Amazon Chime Voice Connector.
OutboundHostName *string
// Designates whether encryption is required for the Amazon Chime Voice Connector.
RequireEncryption *bool
// The updated Amazon Chime Voice Connector timestamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
// The ARN of the specified Amazon Chime Voice Connector.
VoiceConnectorArn *string
// The Amazon Chime Voice Connector ID.
VoiceConnectorId *string
noSmithyDocumentSerde
}
// The Amazon Chime Voice Connector group configuration, including associated
// Amazon Chime Voice Connectors. You can include Amazon Chime Voice Connectors
// from different AWS Regions in your group. This creates a fault tolerant
// mechanism for fallback in case of availability events.
type VoiceConnectorGroup struct {
// The Amazon Chime Voice Connector group creation time stamp, in ISO 8601 format.
CreatedTimestamp *time.Time
// The name of the Amazon Chime Voice Connector group.
Name *string
// The updated Amazon Chime Voice Connector group time stamp, in ISO 8601 format.
UpdatedTimestamp *time.Time
// The ARN of the specified Amazon Chime Voice Connector group.
VoiceConnectorGroupArn *string
// The Amazon Chime Voice Connector group ID.
VoiceConnectorGroupId *string
// The Amazon Chime Voice Connectors to which to route inbound calls.
VoiceConnectorItems []VoiceConnectorItem
noSmithyDocumentSerde
}
// For Amazon Chime Voice Connector groups, the Amazon Chime Voice Connectors to
// which to route inbound calls. Includes priority configuration settings. Limit: 3
// VoiceConnectorItems per Amazon Chime Voice Connector group.
type VoiceConnectorItem struct {
// The priority associated with the Amazon Chime Voice Connector, with 1 being the
// highest priority. Higher priority Amazon Chime Voice Connectors are attempted
// first.
//
// This member is required.
Priority *int32
// The Amazon Chime Voice Connector ID.
//
// This member is required.
VoiceConnectorId *string
noSmithyDocumentSerde
}
// The Amazon Chime Voice Connector settings. Includes any Amazon S3 buckets
// designated for storing call detail records.
type VoiceConnectorSettings struct {
// The Amazon S3 bucket designated for call detail record storage.
CdrBucket *string
noSmithyDocumentSerde
}
type noSmithyDocumentSerde = smithydocument.NoSerde
|