/usr/lib/python3/dist-packages/botocore/data/aws/sns.json is in python3-botocore 0.29.0+repack-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | {
"api_version": "2010-03-31",
"type": "query",
"result_wrapped": true,
"signature_version": "v4",
"service_full_name": "Amazon Simple Notification Service",
"service_abbreviation": "Amazon SNS",
"endpoint_prefix": "sns",
"xmlnamespace": "http://sns.amazonaws.com/doc/2010-03-31/",
"documentation": "\n <fullname>Amazon Simple Notification Service</fullname>\n \n\t<p>Amazon Simple Notification Service (Amazon SNS) is a web service that enables you to build distributed web-enabled applications. \n \tApplications can use Amazon SNS to easily push real-time notification messages \n \tto interested subscribers over multiple delivery protocols. For more information about this product\n\t\tsee <a href=\"http://aws.amazon.com/sns/\">http://aws.amazon.com/sns</a>. For detailed information about Amazon SNS features and their associated API calls,\n\t\tsee the <a href=\"http://docs.aws.amazon.com/sns/latest/dg/\">Amazon SNS Developer Guide</a>.\n\t</p>\n <p>We also provide SDKs that enable you to access Amazon SNS from your preferred programming language. \n The SDKs contain functionality that automatically takes care of tasks such as: cryptographically signing your service requests, \n retrying requests, and handling error responses. For a list of available SDKs, go to <a href=\"http://aws.amazon.com/tools/\">Tools for Amazon Web Services</a>. \n </p> \n\n ",
"operations": {
"AddPermission": {
"name": "AddPermission",
"input": {
"shape_name": "AddPermissionInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic whose access control policy you wish to modify.</p>\n ",
"required": true
},
"Label": {
"shape_name": "label",
"type": "string",
"documentation": "\n <p>A unique identifier for the new policy statement.</p>\n ",
"required": true
},
"AWSAccountId": {
"shape_name": "DelegatesList",
"type": "list",
"members": {
"shape_name": "delegate",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The AWS account IDs of the users (principals) who will be given access to the specified\n actions. The users must have AWS accounts, but do not need to be signed up \n for this service. <!--For information about locating the AWS\n account identification, see <a href=\"http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/index.html?AWSCredentials.html\">Your\n AWS Identifiers</aulink> in the &service; Developer Guide.--></p>\n ",
"required": true
},
"ActionName": {
"shape_name": "ActionsList",
"type": "list",
"members": {
"shape_name": "action",
"type": "string",
"documentation": null
},
"documentation": "\n <p>The action you want to allow for the specified principal(s).</p>\n <p>Valid values: any Amazon SNS action name.</p>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>AddPermission</code> action adds a statement to a topic's access control policy, granting access for the specified AWS accounts to the specified actions.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &ActionName.member.1=Publish\n &ActionName.member.2=GetTopicAttributes\n &Label=NewPermission\n &AWSAccountId.member.1=987654321000\n &AWSAccountId.member.2=876543210000\n &Action=AddPermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=k%2FAU%2FKp13pjndwJ7rr1sZszy6MZMlOhRBCHx1ZaZFiw%3D\n\n </queryrequest>\n <queryresponse>\n \n<AddPermissionResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>6a213e4e-33a8-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</AddPermissionResponse>\n \n </queryresponse>\n</examples>\n "
},
"ConfirmSubscription": {
"name": "ConfirmSubscription",
"input": {
"shape_name": "ConfirmSubscriptionInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic for which you wish to confirm a subscription.</p>\n ",
"required": true
},
"Token": {
"shape_name": "token",
"type": "string",
"documentation": "\n <p>Short-lived token sent to an endpoint during the <code>Subscribe</code> action.</p>\n ",
"required": true
},
"AuthenticateOnUnsubscribe": {
"shape_name": "authenticateOnUnsubscribe",
"type": "string",
"documentation": "\n <p>Disallows unauthenticated unsubscribes of the subscription. \n If the value of this parameter is <code>true</code> and the request has an AWS signature, then only the topic owner\n and the subscription owner can unsubscribe the endpoint. The unsubscribe\n action requires AWS authentication. </p>\n "
}
},
"documentation": "\n Input for ConfirmSubscription action.\n "
},
"output": {
"shape_name": "ConfirmSubscriptionResponse",
"type": "structure",
"members": {
"SubscriptionArn": {
"shape_name": "subscriptionARN",
"type": "string",
"documentation": "\n <p>The ARN of the created subscription.</p>\n "
}
},
"documentation": "\n Response for ConfirmSubscriptions action.\n "
},
"errors": [
{
"shape_name": "SubscriptionLimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the customer already owns the maximum allowed number of subscriptions.</p>\n "
},
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>ConfirmSubscription</code> action verifies an endpoint owner's intent to receive messages by validating\n the token sent to the endpoint by an earlier <code>Subscribe</code> action. If the\n token is valid, the action creates a new subscription and returns its\n Amazon Resource Name (ARN). This call requires an AWS signature only when the <code>AuthenticateOnUnsubscribe</code> flag is set to \"true\".</p>\n<examples>\n <queryrequest>\n\n https://sns.us-east-1.amazonaws.com/\n ?Action=ConfirmSubscription\n &TopicArn=arn:aws:sns:us-east-1:123456789012:My-Topic\n &Token=51b2ff3edb475b7d91550e0ab6edf0c1de2a34e6ebaf6\n c2262a001bcb7e051c43aa00022ceecce70bd2a67b2042da8d8\n eb47fef7a4e4e942d23e7fa56146b9ee35da040b4b8af564cc4\n 184a7391c834cb75d75c22981f776ad1ce8805e9bab29da2329\n 985337bb8095627907b46c8577c8440556b6f86582a95475802\n 6f41fc62041c4b3f67b0f5921232b5dae5aaca1\n\n </queryrequest>\n <queryresponse>\n \n<ConfirmSubscriptionResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ConfirmSubscriptionResult>\n <SubscriptionArn>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>\n </ConfirmSubscriptionResult>\n <ResponseMetadata>\n <RequestId>7a50221f-3774-11df-a9b7-05d48da6f042</RequestId>\n </ResponseMetadata>\n</ConfirmSubscriptionResponse>\n \n </queryresponse>\n</examples>\n\n\n "
},
"CreatePlatformApplication": {
"name": "CreatePlatformApplication",
"input": {
"shape_name": "CreatePlatformApplicationInput",
"type": "structure",
"members": {
"Name": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Application names must be made up of only uppercase and lowercase ASCII letters, numbers, underscores, hyphens, and periods, and must be between 1 and 256 characters long.</p> \n ",
"required": true
},
"Platform": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>The following platforms are supported: ADM (Amazon Device Messaging), APNS (Apple Push Notification Service), APNS_SANDBOX, and GCM (Google Cloud Messaging).</p> \n ",
"required": true
},
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>For a list of attributes, see <a href=\"http://docs.aws.amazon.com/sns/latest/api/API_SetPlatformApplicationAttributes.html\">SetPlatformApplicationAttributes</a></p> \n ",
"required": true
}
},
"documentation": "\n <p>Input for CreatePlatformApplication action.</p> \n "
},
"output": {
"shape_name": "CreatePlatformApplicationResponse",
"type": "structure",
"members": {
"PlatformApplicationArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>PlatformApplicationArn is returned.</p> \n "
}
},
"documentation": "\n <p>Response from CreatePlatformApplication action.</p> \n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n \n <p>The <code>CreatePlatformApplication</code> action creates a platform application object for one of the supported push notification services, \n such as APNS and GCM, to which devices and mobile apps may register. You must specify PlatformPrincipal and PlatformCredential attributes when using \n the <code>CreatePlatformApplication</code> action. The PlatformPrincipal is received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". \n For GCM, PlatformPrincipal is not applicable. For ADM, <!-- , WNS and MPNS--> PlatformPrincipal is \"client id\". The PlatformCredential is also received from the notification service. \n For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". For GCM, PlatformCredential is \"API key\". For ADM,<!-- , WNS and MPNS--> PlatformCredential is \"client secret\". \n The PlatformApplicationArn that is returned when using <code>CreatePlatformApplication</code> is then used as an attribute for the <code>CreatePlatformEndpoint</code> action.\n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>. \n </p>\n \n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.2.key=PlatformPrincipal\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=AIzaSyClE2lcV2zEKTLYYo645zfk2jhQPFeyxDo\n&Attributes.entry.2.value=There+is+no+principal+for+GCM\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Signature=82sHzg1Wfbgisw3i%2BHA2OgBmRktsqUKFinknkq3u%2FQ4%3D\n&Timestamp=2013-07-01T15%3A49%3A50.354Z\n&Name=gcmpushapp\n&Attributes.entry.1.key=PlatformCredential\n&Action=CreatePlatformApplication\n&Version=2010-03-31\n&SignatureVersion=2\n&Platform=GCM\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<CreatePlatformApplicationResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <CreatePlatformApplicationResult>\n <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp</PlatformApplicationArn>\n </CreatePlatformApplicationResult>\n <ResponseMetadata>\n <RequestId>b6f0e78b-e9d4-5a0e-b973-adc04e8a4ff9</RequestId>\n </ResponseMetadata>\n</CreatePlatformApplicationResponse>\n\n </queryresponse>\n </examples> \n "
},
"CreatePlatformEndpoint": {
"name": "CreatePlatformEndpoint",
"input": {
"shape_name": "CreatePlatformEndpointInput",
"type": "structure",
"members": {
"PlatformApplicationArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>PlatformApplicationArn returned from CreatePlatformApplication is used to create a an endpoint.</p> \n ",
"required": true
},
"Token": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Unique identifier created by the notification service for an app on a device. \n The specific name for Token will vary, depending on which notification service is being used. \n For example, when using APNS as the notification service, you need the device token. \n Alternatively, when using GCM or ADM, the device token equivalent is called the registration ID.</p> \n ",
"required": true
},
"CustomUserData": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</p> \n "
},
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>For a list of attributes, see <a href=\"http://docs.aws.amazon.com/sns/latest/api/API_SetEndpointAttributes.html\">SetEndpointAttributes</a>.</p> \n "
}
},
"documentation": "\n <p>Input for CreatePlatformEndpoint action.</p> \n "
},
"output": {
"shape_name": "CreateEndpointResponse",
"type": "structure",
"members": {
"EndpointArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>EndpointArn returned from CreateEndpoint action.</p> \n "
}
},
"documentation": "\n <p>Response from CreateEndpoint action.</p>\n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>CreatePlatformEndpoint</code> creates an endpoint for a device and mobile app on one of the supported push notification services, such as GCM and APNS. \n <code>CreatePlatformEndpoint</code> requires the PlatformApplicationArn that is returned from <code>CreatePlatformApplication</code>. The EndpointArn that is\n returned when using <code>CreatePlatformEndpoint</code> can then be used by the <code>Publish</code> action to send a message to a mobile app or by the <code>Subscribe</code> \n action for subscription to a topic. \n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=CreatePlatformEndpoint\n&SignatureMethod=HmacSHA256\n&CustomUserData=UserId%3D27576823\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&Token=APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Rg5vXBS6OfgPtWkt1u32p1w14uiGh%2BKOicvXNWTEz2w%3D\n&Timestamp=2013-07-01T15%3A49%3A50.598Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<CreatePlatformEndpointResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <CreatePlatformEndpointResult>\n <EndpointArn>arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3</EndpointArn>\n </CreatePlatformEndpointResult>\n <ResponseMetadata>\n <RequestId>6613341d-3e15-53f7-bf3c-7e56994ba278</RequestId>\n </ResponseMetadata>\n</CreatePlatformEndpointResponse>\n\n </queryresponse>\n </examples> \n "
},
"CreateTopic": {
"name": "CreateTopic",
"input": {
"shape_name": "CreateTopicInput",
"type": "structure",
"members": {
"Name": {
"shape_name": "topicName",
"type": "string",
"documentation": "\n <p>The name of the topic you want to create.</p>\n <p>Constraints: Topic names must be made up of \n only uppercase and lowercase ASCII letters, numbers, underscores, and hyphens, and must be \n between 1 and 256 characters long. </p>\n ",
"required": true
}
},
"documentation": "\n <p>Input for CreateTopic action.</p>\n "
},
"output": {
"shape_name": "CreateTopicResponse",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The Amazon Resource Name (ARN) assigned to the created topic.</p>\n "
}
},
"documentation": "\n <p>Response from CreateTopic action.</p>\n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "TopicLimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the customer already owns the maximum allowed number of topics.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>CreateTopic</code> action creates a topic to which notifications can be published. Users can create\n at most 100 topics. For more information, see <a href=\"http://aws.amazon.com/sns/\">http://aws.amazon.com/sns</a>. \n This action is idempotent, so if the requester already owns a topic with the specified name, that topic's ARN is \n returned without creating a new topic.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?Name=My-Topic\n &Action=CreateTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=gfzIF53exFVdpSNb8AiwN3Lv%2FNYXh6S%2Br3yySK70oX4%3D\n\n </queryrequest>\n <queryresponse>\n \n <CreateTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <CreateTopicResult>\n <TopicArn>arn:aws:sns:us-east-1:123456789012:My-Topic</TopicArn>\n </CreateTopicResult>\n <ResponseMetadata>\n <RequestId>a8dec8b3-33a4-11df-8963-01868b7c937a</RequestId>\n </ResponseMetadata>\n </CreateTopicResponse>\n \n </queryresponse>\n</examples>\n "
},
"DeleteEndpoint": {
"name": "DeleteEndpoint",
"input": {
"shape_name": "DeleteEndpointInput",
"type": "structure",
"members": {
"EndpointArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>EndpointArn of endpoint to delete.</p> \n ",
"required": true
}
},
"documentation": "\n <p>Input for DeleteEndpoint action.</p> \n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>DeleteEndpoint</code> action, which is idempotent, deletes the endpoint from SNS. \n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p> \n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=DeleteEndpoint\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=LIc6GI3JbNhmHBEDmSxzZp648XPe5CMeFny%2BTQFtomQ%3D\n&Timestamp=2013-07-01T23%3A00%3A12.456Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<DeleteEndpointResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>c1d2b191-353c-5a5f-8969-fbdd3900afa8</RequestId>\n </ResponseMetadata>\n</DeleteEndpointResponse>\n\n </queryresponse>\n </examples> \n "
},
"DeletePlatformApplication": {
"name": "DeletePlatformApplication",
"input": {
"shape_name": "DeletePlatformApplicationInput",
"type": "structure",
"members": {
"PlatformApplicationArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>PlatformApplicationArn of platform application object to delete.</p> \n ",
"required": true
}
},
"documentation": "\n <p>Input for DeletePlatformApplication action.</p> \n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>DeletePlatformApplication</code> action deletes a platform application object for one of the supported push notification services, \n such as APNS and GCM.\n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=DeletePlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=Mh7X%2BQo%2BGpcm5B1IpkovBaRiJCJOqvFlIOYzL62SGrg%3D\n&Timestamp=2013-07-01T23%3A02%3A03.872Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<DeletePlatformApplicationResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>097dac18-7a77-5823-a8dd-e65476dcb037</RequestId>\n </ResponseMetadata>\n</DeletePlatformApplicationResponse>\n\n </queryresponse>\n </examples> \n "
},
"DeleteTopic": {
"name": "DeleteTopic",
"input": {
"shape_name": "DeleteTopicInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic you want to delete.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=DjHBa%2BbYCKQAzctOPnLP7MbHnrHT3%2FK3kFEZjwcf9%2FU%3D\n\n </queryrequest>\n <queryresponse>\n \n<DeleteTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>fba800b9-3765-11df-8cf3-c58c53254dfb</RequestId>\n </ResponseMetadata>\n</DeleteTopicResponse>\n \n </queryresponse>\n</examples>\n ",
"required": true
}
},
"documentation": null
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>DeleteTopic</code> action deletes a topic and all its subscriptions. Deleting a topic might\n prevent some messages previously sent to the topic from being delivered to\n subscribers. This action is idempotent, so deleting a topic that does not\n exist does not result in an error.</p>\n<examples>\n<queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=DeleteTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n\n</queryrequest>\n<queryresponse>\n\n<DeleteTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>f3aa9ac9-3c3d-11df-8235-9dab105e9c32</RequestId>\n </ResponseMetadata>\n</DeleteTopicResponse>\n\n</queryresponse>\n</examples>\n "
},
"GetEndpointAttributes": {
"name": "GetEndpointAttributes",
"input": {
"shape_name": "GetEndpointAttributesInput",
"type": "structure",
"members": {
"EndpointArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>EndpointArn for GetEndpointAttributes input.</p> \n ",
"required": true
}
},
"documentation": "\n <p>Input for GetEndpointAttributes action.</p> \n "
},
"output": {
"shape_name": "GetEndpointAttributesResponse",
"type": "structure",
"members": {
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>Attributes include the following:</p>\n <ul>\n <!-- Policy is not yet supported. Will remove comments once it is available -->\n <li>\n<code>CustomUserData</code> -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</li>\n <li>\n<code>Enabled</code> -- flag that enables/disables delivery to the endpoint. \n Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. \n Users can set it back to true, typically after updating Token.</li>\n <!-- <li><code>Policy</code> access policy controlling who can send messages to this endpoint .</li> -->\n <li>\n<code>Token</code> -- device token, also referred to as a registration id, for an app and mobile device. \n This is returned from the notification service when an app and mobile device are registered with the notification service.</li> \n </ul> \n "
}
},
"documentation": "\n <p>Response from GetEndpointAttributes of the EndpointArn.</p> \n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>GetEndpointAttributes</code> retrieves the endpoint attributes for a device on one of the supported push notification services, such as GCM and APNS. \n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=GetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=%2B2egbEoT4npw3p5H3wiIdzZBoTn4KI3UWmMFyBsHH9c%3D\n&Timestamp=2013-07-01T22%3A44%3A56.515Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<GetEndpointAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetEndpointAttributesResult>\n <Attributes>\n <entry>\n <key>Enabled</key>\n <value>true</value>\n </entry>\n <entry>\n <key>CustomUserData</key>\n <value>UserId=01234567</value>\n </entry>\n <entry>\n <key>Token</key>\n <value>APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE</value>\n </entry>\n </Attributes>\n </GetEndpointAttributesResult>\n <ResponseMetadata>\n <RequestId>6c725a19-a142-5b77-94f9-1055a9ea04e7</RequestId>\n </ResponseMetadata>\n</GetEndpointAttributesResponse>\n\n </queryresponse>\n </examples> \n "
},
"GetPlatformApplicationAttributes": {
"name": "GetPlatformApplicationAttributes",
"input": {
"shape_name": "GetPlatformApplicationAttributesInput",
"type": "structure",
"members": {
"PlatformApplicationArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>PlatformApplicationArn for GetPlatformApplicationAttributesInput.</p> \n ",
"required": true
}
},
"documentation": "\n <p>Input for GetPlatformApplicationAttributes action.</p> \n "
},
"output": {
"shape_name": "GetPlatformApplicationAttributesResponse",
"type": "structure",
"members": {
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>Attributes include the following:</p>\n <ul> \n <!-- AllowEndpointPolicies, EventDeliveryAttemptFailure, and Policy are not yet supported. Will remove comments once it is available -->\n <!-- <li><code>AllowEndpointPolicies</code> true or false (default false) - If true, then policies on endpoints will be evaluated to determine if the topic or user has the rights to send messages to it. \n If false, the endpoint policy will be ignored and only the mobile app policy will be considered.</li> -->\n <li>\n<code>EventEndpointCreated</code> -- Topic ARN to which EndpointCreated event notifications should be sent.</li>\n <li>\n<code>EventEndpointDeleted</code> -- Topic ARN to which EndpointDeleted event notifications should be sent.</li>\n <li>\n<code>EventEndpointUpdated</code> -- Topic ARN to which EndpointUpdate event notifications should be sent.</li>\n <!-- <li><code>EventDeliveryAttemptFailure</code> Topic ARN to which DeliveryAttemptFailure event notifications should be sent upon Direct Publish delivery attempt failures to one of the application's endpoints.</li> -->\n <li>\n<code>EventDeliveryFailure</code> -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</li>\n <!-- <li><code>Policy</code> Access policy controlling who can send messages to endpoints under this mobile app.</li> -->\n </ul>\n "
}
},
"documentation": "\n <p>Response for GetPlatformApplicationAttributes action.</p> \n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>GetPlatformApplicationAttributes</code> action retrieves the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=GetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=UGMaCq8CCJGSYXO9Ehr2VuHIBYSe6WbxkqgMKRslTK4%3D\n&Timestamp=2013-07-01T22%3A40%3A50.643Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<GetPlatformApplicationAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetPlatformApplicationAttributesResult>\n <Attributes>\n <entry>\n <key>AllowEndpointPolicies</key>\n <value>false</value>\n </entry>\n </Attributes>\n </GetPlatformApplicationAttributesResult>\n <ResponseMetadata>\n <RequestId>74848df2-87f6-55ed-890c-c7be80442462</RequestId>\n </ResponseMetadata>\n</GetPlatformApplicationAttributesResponse>\n\n </queryresponse>\n </examples> \n "
},
"GetSubscriptionAttributes": {
"name": "GetSubscriptionAttributes",
"input": {
"shape_name": "GetSubscriptionAttributesInput",
"type": "structure",
"members": {
"SubscriptionArn": {
"shape_name": "subscriptionARN",
"type": "string",
"documentation": "\n <p>The ARN of the subscription whose properties you want to get.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Input for GetSubscriptionAttributes.</p>\n "
},
"output": {
"shape_name": "GetSubscriptionAttributesResponse",
"type": "structure",
"members": {
"Attributes": {
"shape_name": "SubscriptionAttributesMap",
"type": "map",
"keys": {
"shape_name": "attributeName",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "attributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A map of the subscription's attributes. Attributes in this map include the following:</p>\n <ul>\n <li>\n<code>SubscriptionArn</code> -- the subscription's ARN</li>\n <li>\n<code>TopicArn</code> -- the topic ARN that the subscription is associated with</li>\n <li>\n<code>Owner</code> -- the AWS account ID of the subscription's owner</li>\n <li>\n<code>ConfirmationWasAuthenticated</code> -- true if the subscription confirmation request was authenticated</li>\n <li>\n<code>DeliveryPolicy</code> -- the JSON serialization of the subscription's delivery policy</li>\n <li>\n<code>EffectiveDeliveryPolicy</code> -- the JSON serialization of the effective delivery policy that takes \n into account the topic delivery policy and account system defaults</li>\n </ul>\n "
}
},
"documentation": "\n <p>Response for GetSubscriptionAttributes action.</p>\n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>GetSubscriptionAttribtues</code> action returns all of the properties of a subscription.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=GetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n </queryrequest>\n <queryresponse>\n \n<GetSubscriptionAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetSubscriptionAttributesResult>\n <Attributes>\n <entry>\n <key>Owner</key>\n <value>123456789012</value>\n </entry>\n <entry>\n <key>DeliveryPolicy</key>\n <value>{"healthyRetryPolicy":{"numRetries":10}}</value>\n </entry>\n <entry>\n <key>SubscriptionArn</key>\n <value>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</value>\n </entry>\n </Attributes>\n </GetSubscriptionAttributesResult>\n <ResponseMetadata>\n <RequestId>057f074c-33a7-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</GetTopicAttributesResponse>\n \n </queryresponse>\n</examples>\n "
},
"GetTopicAttributes": {
"name": "GetTopicAttributes",
"input": {
"shape_name": "GetTopicAttributesInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic whose properties you want to get.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Input for GetTopicAttributes action.</p> \n "
},
"output": {
"shape_name": "GetTopicAttributesResponse",
"type": "structure",
"members": {
"Attributes": {
"shape_name": "TopicAttributesMap",
"type": "map",
"keys": {
"shape_name": "attributeName",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "attributeValue",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A map of the topic's attributes. Attributes in this map include the following:</p>\n <ul>\n <li>\n<code>TopicArn</code> -- the topic's ARN</li>\n <li>\n<code>Owner</code> -- the AWS account ID of the topic's owner</li>\n <li>\n<code>Policy</code> -- the JSON serialization of the topic's access control policy</li>\n <li>\n<code>DisplayName</code> -- the human-readable name used in the \"From\" field for notifications to email and email-json endpoints</li>\n <li>\n<code>SubscriptionsPending</code> -- the number of subscriptions pending confirmation on this topic</li>\n <li>\n<code>SubscriptionsConfirmed</code> -- the number of confirmed subscriptions on this topic</li>\n <li>\n<code>SubscriptionsDeleted</code> -- the number of deleted subscriptions on this topic</li>\n <li>\n<code>DeliveryPolicy</code> -- the JSON serialization of the topic's delivery policy</li>\n <li>\n<code>EffectiveDeliveryPolicy</code> -- the JSON serialization of the effective delivery policy that takes into account system defaults</li> \n </ul>\n "
}
},
"documentation": "\n <p>Response for GetTopicAttributes action.</p>\n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>GetTopicAttributes</code> action returns all of the properties of a topic. \n Topic properties returned might differ based on the authorization of the user. </p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=GetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=92lBGRVq0%2BxhaACaBGqtdemy%2Bi9isfgyTljCbJM80Yk%3D\n\n </queryrequest>\n <queryresponse>\n \n<GetTopicAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <GetTopicAttributesResult>\n <Attributes>\n <entry>\n <key>Owner</key>\n <value>123456789012</value>\n </entry>\n <entry>\n <key>Policy</key>\n <value>{\n"Version":"2008-10-17","Id":"us-east-1/698519295917/test__default_policy_ID","Statement" : [{"Effect":"Allow","Sid":"us-east-1/698519295917/test__default_statement_ID","Principal" : {"AWS": "*"},"Action":["SNS:GetTopicAttributes","SNS:SetTopicAttributes","SNS:AddPermission","SNS:RemovePermission","SNS:DeleteTopic","SNS:Subscribe","SNS:ListSubscriptionsByTopic","SNS:Publish","SNS:Receive"],"Resource":"arn:aws:sns:us-east-1:698519295917:test","Condition" : {"StringLike" : {"AWS:SourceArn": "arn:aws:*:*:698519295917:*"}}}]}</value>\n </entry>\n <entry>\n <key>TopicArn</key>\n <value>arn:aws:sns:us-east-1:123456789012:My-Topic</value>\n </entry>\n </Attributes>\n </GetTopicAttributesResult>\n <ResponseMetadata>\n <RequestId>057f074c-33a7-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</GetTopicAttributesResponse>\n \n </queryresponse>\n</examples>\n "
},
"ListEndpointsByPlatformApplication": {
"name": "ListEndpointsByPlatformApplication",
"input": {
"shape_name": "ListEndpointsByPlatformApplicationInput",
"type": "structure",
"members": {
"PlatformApplicationArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>PlatformApplicationArn for ListEndpointsByPlatformApplicationInput action.</p> \n ",
"required": true
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>NextToken string is used when calling ListEndpointsByPlatformApplication action to retrieve additional records that are available after the first page results.</p> \n "
}
},
"documentation": "\n <p>Input for ListEndpointsByPlatformApplication action.</p> \n "
},
"output": {
"shape_name": "ListEndpointsByPlatformApplicationResponse",
"type": "structure",
"members": {
"Endpoints": {
"shape_name": "ListOfEndpoints",
"type": "list",
"members": {
"shape_name": "Endpoint",
"type": "structure",
"members": {
"EndpointArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>EndpointArn for mobile app and device.</p> \n "
},
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>Attributes for endpoint.</p> \n "
}
},
"documentation": "\n <p>Endpoint for mobile app and device.</p> \n "
},
"documentation": "\n <p>Endpoints returned for ListEndpointsByPlatformApplication action.</p> \n "
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>NextToken string is returned when calling ListEndpointsByPlatformApplication action if additional records are available after the first page results.</p> \n "
}
},
"documentation": "\n <p>Response for ListEndpointsByPlatformApplication action.</p> \n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>ListEndpointsByPlatformApplication</code> action lists the endpoints and endpoint attributes for devices in a supported push notification service, such as GCM and APNS. \n The results for <code>ListEndpointsByPlatformApplication</code> are paginated and return a limited list of endpoints, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call <code>ListEndpointsByPlatformApplication</code> again using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nPlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=ListEndpointsByPlatformApplication\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=e6H4sJSCRBBlh%2BaigB%2FtYgp4%2Bjl7dikAQ6WKf%2BMTwNM%3D\n&Timestamp=2013-07-01T23%3A00%3A52.515Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<ListEndpointsByPlatformApplicationResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListEndpointsByPlatformApplicationResult>\n <Endpoints>\n <member>\n <EndpointArn>arn:aws:sns:us-west-2:123456789012:endpoint/GCM/gcmpushapp/5e3e9847-3183-3f18-a7e8-671c3a57d4b3</EndpointArn>\n <Attributes>\n <entry>\n <key>Enabled</key>\n <value>true</value>\n </entry>\n <entry>\n <key>CustomUserData</key>\n <value>UserId=27576823</value>\n </entry>\n <entry>\n <key>Token</key>\n <value>APA91bGi7fFachkC1xjlqT66VYEucGHochmf1VQAr9k...jsM0PKPxKhddCzx6paEsyay9Zn3D4wNUJb8m6HZrBEXAMPLE</value>\n </entry>\n </Attributes>\n </member>\n </Endpoints>\n </ListEndpointsByPlatformApplicationResult>\n <ResponseMetadata>\n <RequestId>9a48768c-dac8-5a60-aec0-3cc27ea08d96</RequestId>\n </ResponseMetadata>\n</ListEndpointsByPlatformApplicationResponse>\n\n </queryresponse>\n </examples>\n \n "
},
"ListPlatformApplications": {
"name": "ListPlatformApplications",
"input": {
"shape_name": "ListPlatformApplicationsInput",
"type": "structure",
"members": {
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>NextToken string is used when calling ListPlatformApplications action to retrieve additional records that are available after the first page results.</p> \n "
}
},
"documentation": "\n <p>Input for ListPlatformApplications action.</p> \n "
},
"output": {
"shape_name": "ListPlatformApplicationsResponse",
"type": "structure",
"members": {
"PlatformApplications": {
"shape_name": "ListOfPlatformApplications",
"type": "list",
"members": {
"shape_name": "PlatformApplication",
"type": "structure",
"members": {
"PlatformApplicationArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>PlatformApplicationArn for platform application object.</p> \n "
},
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>Attributes for platform application object.</p> \n "
}
},
"documentation": "\n <p>Platform application object.</p> \n "
},
"documentation": "\n <p>Platform applications returned when calling ListPlatformApplications action.</p> \n "
},
"NextToken": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>NextToken string is returned when calling ListPlatformApplications action if additional records are available after the first page results.</p> \n "
}
},
"documentation": "\n <p>Response for ListPlatformApplications action.</p> \n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>ListPlatformApplications</code> action lists the platform application objects for the supported push notification services, \n such as APNS and GCM. The results for <code>ListPlatformApplications</code> are paginated and return a limited list of applications, up to 100.\n If additional records are available after the first page results, then a NextToken string will be returned. \n To receive the next page, you call <code>ListPlatformApplications</code> using the NextToken string received from the previous call. \n When there are no more records to return, NextToken will be null.\n \n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=ListPlatformApplications\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=drVbTuyR5N9e88WJMNPzBOjNFNvawkCaMfZI0xa9kIQ%3D\n&Timestamp=2013-07-01T22%3A33%3A55.618Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<ListPlatformApplicationsResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListPlatformApplicationsResult>\n <PlatformApplications>\n <member>\n <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/APNS_SANDBOX/apnspushapp</PlatformApplicationArn>\n <Attributes>\n <entry>\n <key>AllowEndpointPolicies</key>\n <value>false</value>\n </entry>\n </Attributes>\n </member>\n <member>\n <PlatformApplicationArn>arn:aws:sns:us-west-2:123456789012:app/GCM/gcmpushapp</PlatformApplicationArn>\n <Attributes>\n <entry>\n <key>AllowEndpointPolicies</key>\n <value>false</value>\n </entry>\n </Attributes>\n </member>\n </PlatformApplications>\n </ListPlatformApplicationsResult>\n <ResponseMetadata>\n <RequestId>315a335e-85d8-52df-9349-791283cbb529</RequestId>\n </ResponseMetadata>\n</ListPlatformApplicationsResponse>\n\n </queryresponse>\n </examples> \n "
},
"ListSubscriptions": {
"name": "ListSubscriptions",
"input": {
"shape_name": "ListSubscriptionsInput",
"type": "structure",
"members": {
"NextToken": {
"shape_name": "nextToken",
"type": "string",
"documentation": "\n <p>Token returned by the previous <code>ListSubscriptions</code> request.</p>\n "
}
},
"documentation": "\n Input for ListSubscriptions action.\n "
},
"output": {
"shape_name": "ListSubscriptionsResponse",
"type": "structure",
"members": {
"Subscriptions": {
"shape_name": "SubscriptionsList",
"type": "list",
"members": {
"shape_name": "Subscription",
"type": "structure",
"members": {
"SubscriptionArn": {
"shape_name": "subscriptionARN",
"type": "string",
"documentation": "\n <p>The subscription's ARN.</p>\n "
},
"Owner": {
"shape_name": "account",
"type": "string",
"documentation": "\n <p>The subscription's owner.</p>\n "
},
"Protocol": {
"shape_name": "protocol",
"type": "string",
"documentation": "\n <p>The subscription's protocol.</p>\n "
},
"Endpoint": {
"shape_name": "endpoint",
"type": "string",
"documentation": "\n <p>The subscription's endpoint (format depends on the protocol).</p>\n "
},
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the subscription's topic.</p>\n "
}
},
"documentation": "<p>A wrapper type for the attributes of an SNS subscription.</p>"
},
"documentation": "\n <p>A list of subscriptions.</p>\n "
},
"NextToken": {
"shape_name": "nextToken",
"type": "string",
"documentation": "\n <p>Token to pass along to the next <code>ListSubscriptions</code> request. This element is returned if there are more subscriptions to retrieve.</p>\n "
}
},
"documentation": null
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>ListSubscriptions</code> action returns a list of the requester's subscriptions. Each call returns a limited list\n of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a \n new <code>ListSubscriptions</code> call to get further results.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n &Action=ListSubscriptions\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n </queryrequest>\n <queryresponse>\n \n<ListSubscriptionsResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListSubscriptionsResult>\n <Subscriptions>\n <member>\n <TopicArn>arn:aws:sns:us-east-1:698519295917:My-Topic</TopicArn>\n <Protocol>email</Protocol>\n <SubscriptionArn>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>\n <Owner>123456789012</Owner>\n <Endpoint>example@amazon.com</Endpoint>\n </member>\n </Subscriptions>\n </ListSubscriptionsResult>\n <ResponseMetadata>\n <RequestId>384ac68d-3775-11df-8963-01868b7c937a</RequestId>\n </ResponseMetadata>\n</ListSubscriptionsResponse>\n \n </queryresponse>\n</examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Subscriptions",
"py_input_token": "next_token"
}
},
"ListSubscriptionsByTopic": {
"name": "ListSubscriptionsByTopic",
"input": {
"shape_name": "ListSubscriptionsByTopicInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic for which you wish to find subscriptions.</p>\n ",
"required": true
},
"NextToken": {
"shape_name": "nextToken",
"type": "string",
"documentation": "\n <p>Token returned by the previous <code>ListSubscriptionsByTopic</code> request.</p>\n "
}
},
"documentation": "\n <p>Input for ListSubscriptionsByTopic action.</p> \n "
},
"output": {
"shape_name": "ListSubscriptionsByTopicResponse",
"type": "structure",
"members": {
"Subscriptions": {
"shape_name": "SubscriptionsList",
"type": "list",
"members": {
"shape_name": "Subscription",
"type": "structure",
"members": {
"SubscriptionArn": {
"shape_name": "subscriptionARN",
"type": "string",
"documentation": "\n <p>The subscription's ARN.</p>\n "
},
"Owner": {
"shape_name": "account",
"type": "string",
"documentation": "\n <p>The subscription's owner.</p>\n "
},
"Protocol": {
"shape_name": "protocol",
"type": "string",
"documentation": "\n <p>The subscription's protocol.</p>\n "
},
"Endpoint": {
"shape_name": "endpoint",
"type": "string",
"documentation": "\n <p>The subscription's endpoint (format depends on the protocol).</p>\n "
},
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the subscription's topic.</p>\n "
}
},
"documentation": "<p>A wrapper type for the attributes of an SNS subscription.</p>"
},
"documentation": "\n <p>A list of subscriptions.</p>\n "
},
"NextToken": {
"shape_name": "nextToken",
"type": "string",
"documentation": "\n <p>Token to pass along to the next <code>ListSubscriptionsByTopic</code> request. This element is returned if there are more subscriptions to retrieve.</p>\n "
}
},
"documentation": "\n <p>Response for ListSubscriptionsByTopic action.</p> \n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>ListSubscriptionsByTopic</code> action returns a list of the subscriptions to a specific topic. Each call returns \n a limited list of subscriptions, up to 100. If there are more subscriptions, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> \n parameter in a new <code>ListSubscriptionsByTopic</code> call to get further results.</p>\n <examples>\n <queryrequest>\n \n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Action=ListSubscriptionsByTopic\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=SZmBxEPqfs9R7xxhSt6C1b7PnOEvg%2BSVyyMYJfLRFCA%3D\n\n </queryrequest>\n <queryresponse>\n \n<ListSubscriptionsByTopicResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListSubscriptionsByTopicResult>\n <Subscriptions>\n <member>\n <TopicArn>arn:aws:sns:us-east-1:123456789012:My-Topic</TopicArn>\n <Protocol>email</Protocol>\n <SubscriptionArn>arn:aws:sns:us-east-1:123456789012:My-Topic:80289ba6-0fd4-4079-afb4-ce8c8260f0ca</SubscriptionArn>\n <Owner>123456789012</Owner>\n <Endpoint>example@amazon.com</Endpoint>\n </member>\n </Subscriptions>\n </ListSubscriptionsByTopicResult>\n <ResponseMetadata>\n <RequestId>b9275252-3774-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</ListSubscriptionsByTopicResponse>\n \n </queryresponse>\n </examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Subscriptions",
"py_input_token": "next_token"
}
},
"ListTopics": {
"name": "ListTopics",
"input": {
"shape_name": "ListTopicsInput",
"type": "structure",
"members": {
"NextToken": {
"shape_name": "nextToken",
"type": "string",
"documentation": "\n <p>Token returned by the previous <code>ListTopics</code> request.</p>\n "
}
},
"documentation": null
},
"output": {
"shape_name": "ListTopicsResponse",
"type": "structure",
"members": {
"Topics": {
"shape_name": "TopicsList",
"type": "list",
"members": {
"shape_name": "Topic",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The topic's ARN.</p>\n "
}
},
"documentation": "<p>A wrapper type for the topic's Amazon Resource Name (ARN). To retrieve a topic's attributes, use <code>GetTopicAttributes</code>.</p>"
},
"documentation": "\n <p>A list of topic ARNs.</p>\n "
},
"NextToken": {
"shape_name": "nextToken",
"type": "string",
"documentation": "\n <p>Token to pass along to the next <code>ListTopics</code> request. This element is returned if there are additional topics to retrieve.</p>\n "
}
},
"documentation": "\n <p>Response for ListTopics action.</p>\n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>ListTopics</code> action returns a list of the requester's topics. Each call returns a limited list of topics, up to 100. If\n there are more topics, a <code>NextToken</code> is also returned. Use the <code>NextToken</code> parameter in a new <code>ListTopics</code> call to get \n further results.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?Action=ListTopics\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=tPg1qKNTNVPydnL3Yx5Fqm2O9GxCr9vh3EF5r9%2F5%2BJs%3D\n\n </queryrequest>\n <queryresponse>\n \n<ListTopicsResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ListTopicsResult>\n <Topics>\n <member>\n <TopicArn>arn:aws:sns:us-east-1:123456789012:My-Topic</TopicArn>\n </member>\n </Topics>\n </ListTopicsResult>\n <ResponseMetadata>\n <RequestId>3f1478c7-33a9-11df-9540-99d0768312d3</RequestId>\n </ResponseMetadata>\n</ListTopicsResponse>\n \n </queryresponse>\n</examples>\n ",
"pagination": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Topics",
"py_input_token": "next_token"
}
},
"Publish": {
"name": "Publish",
"input": {
"shape_name": "PublishInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The topic you want to publish to.</p>\n "
},
"TargetArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>Either TopicArn or EndpointArn, but not both.</p> \n "
},
"Message": {
"shape_name": "message",
"type": "string",
"documentation": "\n <p>The message you want to send to the topic.</p>\n <p>If you want to send the same message to all transport protocols,\n include the text of the message as a String value.</p>\n <p>If you want to send different messages for each transport protocol,\n set the value of the <code>MessageStructure</code> parameter to <code>json</code>\n and use a JSON object for the <code>Message</code> parameter.\n See the Examples section for the format of the JSON object. </p>\n <p>Constraints: Messages must be UTF-8 encoded\n strings at most 256 KB in size (262144 bytes, not 262144 characters).</p>\n <p>JSON-specific constraints:\n <ul>\n <li>Keys in the JSON object that correspond to supported transport\n protocols must have simple JSON string values. </li>\n <li>The values will be parsed (unescaped)\n before they are used in outgoing messages.</li>\n <li>Outbound notifications are JSON\n encoded (meaning that the characters will be reescaped for sending).</li>\n <li>Values have a minimum length of 0 (the empty string, \"\", is allowed).</li>\n <li>Values have a maximum length bounded by the overall message size (so, including\n multiple protocols may limit message sizes).</li>\n <li>Non-string values will cause the key\n to be ignored.</li>\n <li>Keys that do not correspond to supported transport protocols are ignored.</li>\n <li>Duplicate keys are not allowed.</li>\n <li>Failure to parse or validate any key or\n value in the message will cause the <code>Publish</code> call to return an error (no partial\n delivery).</li>\n </ul>\n </p>\n ",
"required": true
},
"Subject": {
"shape_name": "subject",
"type": "string",
"documentation": "\n <p>Optional parameter to be used as the \"Subject\" line when the message is\n delivered to email endpoints. This field will also be included, if present, \n in the standard JSON messages delivered to other endpoints.</p>\n <p>Constraints: Subjects must be ASCII text that begins with a letter, number, \n or punctuation mark; must not include line breaks or control characters; and \n must be less than 100 characters long.</p>\n "
},
"MessageStructure": {
"shape_name": "messageStructure",
"type": "string",
"documentation": "\n <p>Set <code>MessageStructure</code> to <code>json</code> if you want to send\n a different message for each protocol. For example, using one publish action,\n you can send a short message to your SMS subscribers and a longer message to\n your email subscribers.\n If you set <code>MessageStructure</code> to <code>json</code>, the value of \n the <code>Message</code> parameter must:\n </p>\n <ul>\n <li>be a syntactically valid JSON object; and</li>\n <li>contain at least a top-level JSON key of \"default\" with a value that is a string.</li>\n </ul>\n <p> You can define other top-level keys that define the message you want to send\n to a specific transport protocol (e.g., \"http\"). </p>\n <p>For information about sending different messages for each protocol using\n the AWS Management Console, go to <a href=\"http://docs.aws.amazon.com/sns/latest/gsg/Publish.html#sns-message-formatting-by-protocol\">Create \n Different Messages for Each Protocol</a> in the <i>Amazon Simple Notification Service\n Getting Started Guide</i>.\n </p>\n\n <p>Valid value: <code>json</code></p>\n "
}
},
"documentation": "\n <p>Input for Publish action.</p>\n "
},
"output": {
"shape_name": "PublishResponse",
"type": "structure",
"members": {
"MessageId": {
"shape_name": "messageId",
"type": "string",
"documentation": "\n <p>Unique identifier assigned to the published message.</p>\n <p>Length Constraint: Maximum 100 characters</p>\n\n "
}
},
"documentation": "\n <p>Response for Publish action.</p>\n "
},
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "EndpointDisabledException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": "\n <p>Message for endpoint disabled.</p> \n "
}
},
"documentation": "\n <p>Exception error indicating endpoint disabled.</p> \n "
},
{
"shape_name": "PlatformApplicationDisabledException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": "\n <p>Message for platform application disabled.</p> \n "
}
},
"documentation": "\n <p>Exception error indicating platform application disabled.</p> \n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>Publish</code> action sends a message to all of a topic's subscribed endpoints. When a\n <code>messageId</code> is returned, the message has been saved and Amazon SNS will attempt to deliver it \n to the topic's subscribers shortly. The format of the outgoing message to each\n subscribed endpoint depends on the notification protocol selected.</p>\n <p>To use the <code>Publish</code> action for sending a message to a mobile endpoint, such as an app on a Kindle device or mobile phone, \n you must specify the EndpointArn. The EndpointArn is returned when making a call with the <code>CreatePlatformEndpoint</code> action. \n The second example below shows a request and response for publishing to a mobile endpoint.\n </p>\n <examples>\n <queryrequest>\n \n The following example publishes the same message to all protocols:\n \n http://sns.us-east-1.amazonaws.com/\n ?Subject=My%20first%20message\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A698519295917%3AMy-Topic\n &Message=Hello%20world%21\n &Action=Publish\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n &Signature=9GZysQ4Jpnz%2BHklqM7VFTvEcjR2LIUtn6jW47054xxE%3D\n \n Use the following JSON object format for the Message parameter to send different messages to each protocol (linebreaks added for readability):\n {\n \"default\" : \"some message\",\n \"email\" : \"some email message\",\n \"email-json\" : \"some email-json message\",\n \"http\" : \"some http message\",\n \"https\" : \"some https message\",\n \"sqs\" : \"some sqs message\"\n }\n \n\n </queryrequest>\n <queryresponse>\n \n<PublishResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <PublishResult>\n <MessageId>94f20ce6-13c5-43a0-9a9e-ca52d816e90b</MessageId>\n </PublishResult>\n <ResponseMetadata>\n <RequestId>f187a3c1-376f-11df-8963-01868b7c937a</RequestId>\n </ResponseMetadata>\n</PublishResponse>\n \n </queryresponse>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAction=Publish\n&Message=%7B%22default%22%3A%22This+is+the+default+Message%22%2C%22APNS_SANDBOX%22%3A%22%7B+%5C%22aps%5C%22+%3A+%7B+%5C%22alert%5C%22+%3A+%5C%22You+have+got+email.%5C%22%2C+%5C%22badge%5C%22+%3A+9%2C%5C%22sound%5C%22+%3A%5C%22default%5C%22%7D%7D%22%7D\n&TargetArn=arn%3Aaws%3Asns%3Aus-west-2%3A803981987763%3Aendpoint%2FAPNS_SANDBOX%2Fpushapp%2F98e9ced9-f136-3893-9d60-776547eafebb\n&SignatureMethod=HmacSHA256\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=vmqc4XRupKAxsDAdN4j4Ayw5LQljXMps3kss4bkDfCk%3D\n&Timestamp=2013-07-18T22%3A44%3A09.452Z\n&MessageStructure=json\n \n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<PublishResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <PublishResult>\n <MessageId>567910cd-659e-55d4-8ccb-5aaf14679dc0</MessageId>\n </PublishResult>\n <ResponseMetadata>\n <RequestId>d74b8436-ae13-5ab4-a9ff-ce54dfea72a0</RequestId>\n </ResponseMetadata>\n</PublishResponse>\n \n </queryresponse>\n </examples>\n "
},
"RemovePermission": {
"name": "RemovePermission",
"input": {
"shape_name": "RemovePermissionInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic whose access control policy you wish to modify.</p>\n ",
"required": true
},
"Label": {
"shape_name": "label",
"type": "string",
"documentation": "\n <p>The unique label of the statement you want to remove.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Input for RemovePermission action.</p> \n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>RemovePermission</code> action removes a statement from a topic's access control policy.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Test\n &Label=NewPermission\n &Action=RemovePermission\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=N1abwRY9i7zaSQmbAlm71pPf9EEFOqNbQL1alzw2yCg%3D\n\n </queryrequest>\n <queryresponse>\n \n<RemovePermissionResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>d170b150-33a8-11df-995a-2d6fbe836cc1</RequestId>\n </ResponseMetadata>\n</RemovePermissionResponse>\n \n </queryresponse>\n</examples>\n "
},
"SetEndpointAttributes": {
"name": "SetEndpointAttributes",
"input": {
"shape_name": "SetEndpointAttributesInput",
"type": "structure",
"members": {
"EndpointArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>EndpointArn used for SetEndpointAttributes action.</p> \n ",
"required": true
},
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A map of the endpoint attributes. Attributes in this map include the following:</p>\n <ul>\n <!-- Policy is not yet supported. Will remove comments once it is available -->\n <li>\n<code>CustomUserData</code> -- arbitrary user data to associate with the endpoint. SNS does not use this data. The data must be in UTF-8 format and less than 2KB.</li>\n <li>\n<code>Enabled</code> -- flag that enables/disables delivery to the endpoint. \n Message Processor will set this to false when a notification service indicates to SNS that the endpoint is invalid. \n Users can set it back to true, typically after updating Token.</li>\n <!-- <li><code>Policy</code> access policy controlling who can send messages to this endpoint .</li> -->\n <li>\n<code>Token</code> -- device token, also referred to as a registration id, for an app and mobile device. \n This is returned from the notification service when an app and mobile device are registered with the notification service.</li> \n </ul> \n ",
"required": true
}
},
"documentation": "\n <p>Input for SetEndpointAttributes action.</p> \n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>SetEndpointAttributes</code> action sets the attributes for an endpoint for a device on one of the supported push notification services, such as GCM and APNS.\n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=CustomUserData\n&Action=SetEndpointAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=My+custom+userdata\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&EndpointArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aendpoint%2FGCM%2Fgcmpushapp%2F5e3e9847-3183-3f18-a7e8-671c3a57d4b3\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=CFTGfGOS5vgSU3%2FZgv2h%2FJdWgr2JQdDJSrUU9k38wSM%3D\n&Timestamp=2013-07-01T22%3A56%3A45.582Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<SetEndpointAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>2fe0bfc7-3e85-5ee5-a9e2-f58b35e85f6a</RequestId>\n </ResponseMetadata>\n</SetEndpointAttributesResponse>\n\n </queryresponse>\n </examples> \n "
},
"SetPlatformApplicationAttributes": {
"name": "SetPlatformApplicationAttributes",
"input": {
"shape_name": "SetPlatformApplicationAttributesInput",
"type": "structure",
"members": {
"PlatformApplicationArn": {
"shape_name": "String",
"type": "string",
"documentation": "\n <p>PlatformApplicationArn for SetPlatformApplicationAttributes action.</p> \n ",
"required": true
},
"Attributes": {
"shape_name": "MapStringToString",
"type": "map",
"keys": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"members": {
"shape_name": "String",
"type": "string",
"documentation": null
},
"documentation": "\n <p>A map of the platform application attributes. Attributes in this map include the following:</p>\n <ul>\n <!-- AllowEndpointPolicies, EventDeliveryAttemptFailure, and Policy are not yet supported. Will remove comments once it is available -->\n <li>\n<code>PlatformCredential</code> -- The credential received from the notification service. For APNS/APNS_SANDBOX, PlatformCredential is \"private key\". \n For GCM, PlatformCredential is \"API key\". For ADM,<!-- , WNS and MPNS--> PlatformCredential is \"client secret\".</li>\n <li>\n<code>PlatformPrincipal</code> -- The principal received from the notification service. For APNS/APNS_SANDBOX, PlatformPrincipal is \"SSL certificate\". \n For GCM, PlatformPrincipal is not applicable. For ADM,<!-- , WNS and MPNS--> PlatformPrincipal is \"client id\".</li>\n <!-- <li><code>AllowEndpointPolicies</code> true or false (default false) - If true, then policies on endpoints will be evaluated to determine if the topic or user has the rights to send messages to it. \n If false, the endpoint policy will be ignored and only the mobile app policy will be considered.</li> -->\n <li>\n<code>EventEndpointCreated</code> -- Topic ARN to which EndpointCreated event notifications should be sent.</li>\n <li>\n<code>EventEndpointDeleted</code> -- Topic ARN to which EndpointDeleted event notifications should be sent.</li>\n <li>\n<code>EventEndpointUpdated</code> -- Topic ARN to which EndpointUpdate event notifications should be sent.</li>\n <!-- <li><code>EventDeliveryAttemptFailure</code> Topic ARN to which DeliveryAttemptFailure event notifications should be sent upon Direct Publish delivery attempt failures to one of the application's endpoints.</li> -->\n <li>\n<code>EventDeliveryFailure</code> -- Topic ARN to which DeliveryFailure event notifications should be sent upon Direct Publish delivery failure (permanent) to one of the application's endpoints.</li>\n <!-- <li><code>Policy</code> Access policy controlling who can send messages to endpoints under this mobile app.</li> -->\n </ul> \n ",
"required": true
}
},
"documentation": "\n <p>Input for SetPlatformApplicationAttributes action.</p> \n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>SetPlatformApplicationAttributes</code> action sets the attributes of the platform application object for the supported push notification services, \n such as APNS and GCM.\n For more information, see <a href=\"http://docs.aws.amazon.com/sns/latest/dg/SNSMobilePush.html\">Using Amazon SNS Mobile Push Notifications</a>.\n </p>\n <examples>\n <queryrequest>\n \nPOST http://sns.us-west-2.amazonaws.com/ HTTP/1.1\n...\nAttributes.entry.1.key=EventEndpointCreated&PlatformApplicationArn=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Aapp%2FGCM%2Fgcmpushapp\n&Action=SetPlatformApplicationAttributes\n&SignatureMethod=HmacSHA256\n&Attributes.entry.1.value=arn%3Aaws%3Asns%3Aus-west-2%3A123456789012%3Atopicarn\n&AWSAccessKeyId=AKIAIOSFODNN7EXAMPLE\n&SignatureVersion=2\n&Version=2010-03-31\n&Signature=06L2TsW3jiH%2FGKDYuT8w4NojSrTf4Ig2GKqGeJPhPT4%3D\n&Timestamp=2013-07-01T22%3A53%3A17.800Z\n\n </queryrequest>\n <queryresponse>\n \nHTTP/1.1 200 OK\n...\n<SetPlatformApplicationAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>cf577bcc-b3dc-5463-88f1-3180b9412395</RequestId>\n </ResponseMetadata>\n</SetPlatformApplicationAttributesResponse>\n\n </queryresponse>\n </examples> \n "
},
"SetSubscriptionAttributes": {
"name": "SetSubscriptionAttributes",
"input": {
"shape_name": "SetSubscriptionAttributesInput",
"type": "structure",
"members": {
"SubscriptionArn": {
"shape_name": "subscriptionARN",
"type": "string",
"documentation": "\n <p>The ARN of the subscription to modify.</p>\n ",
"required": true
},
"AttributeName": {
"shape_name": "attributeName",
"type": "string",
"documentation": "\n <p>The name of the attribute you want to set. Only a subset of the subscriptions attributes are mutable.</p>\n <p>Valid values: <code>DeliveryPolicy</code></p>\n ",
"required": true
},
"AttributeValue": {
"shape_name": "attributeValue",
"type": "string",
"documentation": "\n <p>The new value for the attribute in JSON format.</p>\n "
}
},
"documentation": "\n <p>Input for SetSubscriptionAttributes action.</p>\n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>SetSubscriptionAttributes</code> action allows a subscription owner to set an attribute of the topic to a new value.</p>\n<examples>\n <queryrequest>\n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"healthyRetryPolicy\":{\"numRetries\":5}}\n &SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &AttributeName=DeliveryPolicy\n &Action=SetSubscriptionAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"healthyRetryPolicy\": \n {\n \"minDelayTarget\": <int>,\n \"maxDelayTarget\": <int>,\n \"numRetries\": <int>,\n \"numMaxDelayRetries\": <int>,\n \"backoffFunction\": \"<linear|arithmetic|geometric|exponential>\"\n },\n \"throttlePolicy\":\n {\n \"maxReceivesPerSecond\": <int>\n }\n}\n </queryrequest>\n <queryresponse>\n \n<SetSubscriptionAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>a8763b99-33a7-11df-a9b7-05d48da6f042</RequestId>\n </ResponseMetadata>\n</SetSubscriptionAttributesResponse>\n \n </queryresponse>\n</examples>\n\n\n "
},
"SetTopicAttributes": {
"name": "SetTopicAttributes",
"input": {
"shape_name": "SetTopicAttributesInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic to modify.</p>\n ",
"required": true
},
"AttributeName": {
"shape_name": "attributeName",
"type": "string",
"documentation": "\n <p>The name of the attribute you want to set. Only a subset of the topic's attributes are mutable.</p>\n <p>Valid values: <code>Policy</code> | <code>DisplayName</code> | <code>DeliveryPolicy</code></p>\n ",
"required": true
},
"AttributeValue": {
"shape_name": "attributeValue",
"type": "string",
"documentation": "\n <p>The new value for the attribute.</p>\n \n\n "
}
},
"documentation": "\n <p>Input for SetTopicAttributes action.</p> \n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>SetTopicAttributes</code> action allows a topic owner to set an attribute of the topic to a new value.</p>\n<examples>\n <queryrequest>\nThe following example sets the DisplayName attribute to MyTopicName\n\n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue=MyTopicName\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DisplayName\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D\n \nThe following example sets the delivery policy to 5 total retries\n \n http://sns.us-east-1.amazonaws.com/\n ?AttributeValue={\"http\":{\"defaultHealthyRetryPolicy\":{\"numRetries\":5}}}\n &TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &AttributeName=DeliveryPolicy\n &Action=SetTopicAttributes\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key Id)\n &Signature=mQA3nJI%2BcmAIY7r8HCArGElSqPX5JG4UGzF4yo0RygE%3D \n \nThe JSON format for the DeliveryPolicy AttributeValue (linebreaks added for readability):\n{\n \"http\": {\n \"defaultHealthyRetryPolicy\": \n {\n \"minDelayTarget\": <int>,\n \"maxDelayTarget\": <int>,\n \"numRetries\": <int>,\n \"numMaxDelayRetries\": <int>,\n \"backoffFunction\": \"<linear|arithmetic|geometric|exponential>\"\n },\n \"disableSubscriptionOverrides\": <boolean>,\n \"defaultThrottlePolicy\": \n {\n \"maxReceivesPerSecond\": <int>\n }\n }\n </queryrequest>\n <queryresponse>\n \n<SetTopicAttributesResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>a8763b99-33a7-11df-a9b7-05d48da6f042</RequestId>\n </ResponseMetadata>\n</SetTopicAttributesResponse>\n \n </queryresponse>\n</examples>\n\n\n "
},
"Subscribe": {
"name": "Subscribe",
"input": {
"shape_name": "SubscribeInput",
"type": "structure",
"members": {
"TopicArn": {
"shape_name": "topicARN",
"type": "string",
"documentation": "\n <p>The ARN of the topic you want to subscribe to.</p>\n ",
"required": true
},
"Protocol": {
"shape_name": "protocol",
"type": "string",
"documentation": "\n <p>The protocol you want to use. Supported protocols include:</p>\n <ul>\n <li>\n<code>http</code> -- delivery of JSON-encoded message via HTTP POST</li>\n <li>\n<code>https</code> -- delivery of JSON-encoded message via HTTPS POST</li>\n <li>\n<code>email</code> -- delivery of message via SMTP</li>\n <li>\n<code>email-json</code> -- delivery of JSON-encoded message via SMTP</li>\n <li>\n<code>sms</code> -- delivery of message via SMS</li>\n <li>\n<code>sqs</code> -- delivery of JSON-encoded message to an Amazon SQS queue</li>\n <li>\n<code>application</code> -- delivery of JSON-encoded message to an EndpointArn for a mobile app and device.</li>\n </ul>\n ",
"required": true
},
"Endpoint": {
"shape_name": "endpoint",
"type": "string",
"documentation": "\n <p>The endpoint that you want to receive notifications. Endpoints vary by protocol:</p>\n <ul>\n <li>For the <code>http</code> protocol, the endpoint is an URL beginning with \"http://\"</li>\n <li>For the <code>https</code> protocol, the endpoint is a URL beginning with \"https://\"</li>\n <li>For the <code>email</code> protocol, the endpoint is an email address</li>\n <li>For the <code>email-json</code> protocol, the endpoint is an email address</li>\n <li>For the <code>sms</code> protocol, the endpoint is a phone number of an SMS-enabled device</li>\n <li>For the <code>sqs</code> protocol, the endpoint is the ARN of an Amazon SQS queue</li>\n <li>For the <code>application</code> protocol, the endpoint is the EndpointArn of a mobile app and device.</li>\n </ul>\n ",
"py_name": "notification_endpoint",
"cli_name": "notification-endpoint",
"no_paramfile": true
}
},
"documentation": "\n Input for Subscribe action.\n "
},
"output": {
"shape_name": "SubscribeResponse",
"type": "structure",
"members": {
"SubscriptionArn": {
"shape_name": "subscriptionARN",
"type": "string",
"documentation": "\n <p>The ARN of the subscription, if the service was able to create a \n subscription immediately (without requiring endpoint owner confirmation).</p>\n "
}
},
"documentation": "\n Response for Subscribe action.\n "
},
"errors": [
{
"shape_name": "SubscriptionLimitExceededException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the customer already owns the maximum allowed number of subscriptions.</p>\n "
},
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
}
],
"documentation": "\n <p>The <code>Subscribe</code> action prepares to subscribe an endpoint by sending the endpoint a confirmation message. To actually create a\n subscription, the endpoint owner must call the <code>ConfirmSubscription</code>\n action with the token from the confirmation message. Confirmation tokens are\n valid for three days.</p>\n<examples>\n <queryrequest>\n\n http://sns.us-east-1.amazonaws.com/\n ?TopicArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic\n &Endpoint=example%40amazon.com\n &Protocol=email\n &Action=Subscribe\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=1%2FeGaDphxXq%2Fa89x6HvKh%2Fc1yLGXzuhS7vS2MslToDM%3D\n\n </queryrequest>\n <queryresponse>\n \n<SubscribeResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <SubscribeResult>\n <SubscriptionArn>pending confirmation</SubscriptionArn>\n </SubscribeResult>\n <ResponseMetadata>\n <RequestId>a169c740-3766-11df-8963-01868b7c937a</RequestId>\n </ResponseMetadata>\n</SubscribeResponse>\n \n </queryresponse>\n</examples>\n "
},
"Unsubscribe": {
"name": "Unsubscribe",
"input": {
"shape_name": "UnsubscribeInput",
"type": "structure",
"members": {
"SubscriptionArn": {
"shape_name": "subscriptionARN",
"type": "string",
"documentation": "\n <p>The ARN of the subscription to be deleted.</p>\n ",
"required": true
}
},
"documentation": "\n <p>Input for Unsubscribe action.</p>\n "
},
"output": null,
"errors": [
{
"shape_name": "InvalidParameterException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that a request parameter does not comply with the associated constraints.</p>\n "
},
{
"shape_name": "InternalErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates an internal service error.</p>\n "
},
{
"shape_name": "AuthorizationErrorException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the user has been denied access to the requested resource.</p>\n "
},
{
"shape_name": "NotFoundException",
"type": "structure",
"members": {
"message": {
"shape_name": "string",
"type": "string",
"documentation": null
}
},
"documentation": "\n <p>Indicates that the requested resource does not exist.</p>\n "
}
],
"documentation": "\n <p>The <code>Unsubscribe</code> action deletes a subscription. If the subscription requires authentication for \n deletion, only the owner of the subscription or the topic's owner \n can unsubscribe, and an AWS signature is required. If the \n <code>Unsubscribe</code> call does not require authentication and the requester is not \n the subscription owner, a final cancellation message is delivered to the \n endpoint, so that the endpoint owner can easily resubscribe to the topic if \n the <code>Unsubscribe</code> request was unintended.</p>\n <examples>\n <queryrequest>\n \n http://sns.us-east-1.amazonaws.com/\n ?SubscriptionArn=arn%3Aaws%3Asns%3Aus-east-1%3A123456789012%3AMy-Topic%3A80289ba6-0fd4-4079-afb4-ce8c8260f0ca\n &Action=Unsubscribe\n &SignatureVersion=2\n &SignatureMethod=HmacSHA256\n &Timestamp=2010-03-31T12%3A00%3A00.000Z\n &AWSAccessKeyId=(AWS Access Key ID)\n &Signature=e8IwhPzuWeMvPDVrN7jUVxasd3Wv2LuO8x6rE23VCv8%3D\n\n </queryrequest>\n <queryresponse>\n \n<UnsubscribeResponse xmlns=\"http://sns.amazonaws.com/doc/2010-03-31/\">\n <ResponseMetadata>\n <RequestId>18e0ac39-3776-11df-84c0-b93cc1666b84</RequestId>\n </ResponseMetadata>\n</UnsubscribeResponse>\n \n </queryresponse>\n </examples>\n "
}
},
"metadata": {
"regions": {
"us-east-1": null,
"ap-northeast-1": null,
"sa-east-1": null,
"ap-southeast-1": null,
"ap-southeast-2": null,
"us-west-2": null,
"us-west-1": null,
"eu-west-1": null,
"us-gov-west-1": null,
"cn-north-1": "https://sns.cn-north-1.amazonaws.com.cn"
},
"protocols": [
"https",
"http"
]
},
"pagination": {
"ListSubscriptions": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Subscriptions",
"py_input_token": "next_token"
},
"ListSubscriptionsByTopic": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Subscriptions",
"py_input_token": "next_token"
},
"ListTopics": {
"input_token": "NextToken",
"output_token": "NextToken",
"result_key": "Topics",
"py_input_token": "next_token"
}
},
"retry": {
"__default__": {
"max_attempts": 5,
"delay": {
"type": "exponential",
"base": "rand",
"growth_factor": 2
},
"policies": {
"general_socket_errors": {
"applies_when": {
"socket_errors": [
"GENERAL_CONNECTION_ERROR"
]
}
},
"general_server_error": {
"applies_when": {
"response": {
"http_status_code": 500
}
}
},
"service_unavailable": {
"applies_when": {
"response": {
"http_status_code": 503
}
}
},
"limit_exceeded": {
"applies_when": {
"response": {
"http_status_code": 509
}
}
},
"throttling": {
"applies_when": {
"response": {
"service_error_code": "Throttling",
"http_status_code": 400
}
}
}
}
}
}
}
|