AWS.Tools.Rekognition.XML
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 |
<?xml version="1.0"?>
<doc> <assembly> <name>AWS.Tools.Rekognition</name> </assembly> <members> <member name="T:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet"> <summary> Detects faces in the input image and adds them to the specified collection. <para> Amazon Rekognition doesn't save the actual faces that are detected. Instead, the underlying detection algorithm first detects the faces in the input image. For each face, the algorithm extracts facial features into a feature vector, and stores it in the backend database. Amazon Rekognition uses feature vectors when it performs face match and search operations using the <a>SearchFaces</a> and <a>SearchFacesByImage</a> operations. </para><para> For more information, see Adding Faces to a Collection in the Amazon Rekognition Developer Guide. </para><para> To get the number of faces in a collection, call <a>DescribeCollection</a>. </para><para> If you're using version 1.0 of the face detection model, <code>IndexFaces</code> indexes the 15 largest faces in the input image. Later versions of the face detection model index the 100 largest faces in the input image. </para><para> If you're using version 4 or later of the face model, image orientation information is not returned in the <code>OrientationCorrection</code> field. </para><para> To determine which version of the model you're using, call <a>DescribeCollection</a> and supply the collection ID. You can also get the model version from the value of <code>FaceModelVersion</code> in the response from <code>IndexFaces</code></para><para> For more information, see Model Versioning in the Amazon Rekognition Developer Guide. </para><para> If you provide the optional <code>ExternalImageID</code> for the input image you provided, Amazon Rekognition associates this ID with all faces that it detects. When you call the <a>ListFaces</a> operation, the response returns the external ID. You can use this external image ID to create a client-side index to associate the faces with each image. You can then use the index to find all faces in an image. </para><para> You can specify the maximum number of faces to index with the <code>MaxFaces</code> input parameter. This is useful when you want to index the largest faces in an image and don't want to index smaller faces, such as those belonging to people standing in the background. </para><para> The <code>QualityFilter</code> input parameter allows you to filter out detected faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. By default, <code>IndexFaces</code> filters detected faces. You can also explicitly filter detected faces by specifying <code>AUTO</code> for the value of <code>QualityFilter</code>. If you do not want to filter detected faces, specify <code>NONE</code>. </para><note><para> To use quality filtering, you need a collection associated with version 3 of the face model. To get the version of the face model associated with a collection, call <a>DescribeCollection</a>. </para></note><para> Information about faces detected in an image, but not indexed, is returned in an array of <a>UnindexedFace</a> objects, <code>UnindexedFaces</code>. Faces aren't indexed for reasons such as: </para><ul><li><para> The number of faces detected exceeds the value of the <code>MaxFaces</code> request parameter. </para></li><li><para> The face is too small compared to the image dimensions. </para></li><li><para> The face is too blurry. </para></li><li><para> The image is too dark. </para></li><li><para> The face has an extreme pose. </para></li></ul><para> In response, the <code>IndexFaces</code> operation returns an array of metadata for all detected faces, <code>FaceRecords</code>. This includes: </para><ul><li><para> The bounding box, <code>BoundingBox</code>, of the detected face. </para></li><li><para> A confidence value, <code>Confidence</code>, which indicates the confidence that the bounding box contains a face. </para></li><li><para> A face ID, <code>FaceId</code>, assigned by the service for each face that's detected and stored. </para></li><li><para> An image ID, <code>ImageId</code>, assigned by the service for the input image. </para></li></ul><para> If you request all facial attributes (by using the <code>detectionAttributes</code> parameter), Amazon Rekognition returns detailed facial attributes, such as facial landmarks (for example, location of eye and mouth) and other facial attributes like gender. If you provide the same image, specify the same collection, and use the same external ID in the <code>IndexFaces</code> operation, Amazon Rekognition doesn't save duplicate face metadata. </para><para> The input image is passed either as base64-encoded image bytes, or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </para><para> This operation requires permissions to perform the <code>rekognition:IndexFaces</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.CollectionId"> <summary> <para> <para>The ID of an existing collection to which you want to add the faces that are detected in the input images.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.DetectionAttribute"> <summary> <para> <para>An array of facial attributes that you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial attributes are returned, but the operation takes longer to complete.</para><para>If you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ExternalImageId"> <summary> <para> <para>The ID you want to assign to all the faces detected in the image.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.MaxFace"> <summary> <para> <para>The maximum number of faces to index. The value of <code>MaxFaces</code> must be greater than or equal to 1. <code>IndexFaces</code> returns no more than 100 detected faces in an image, even if you specify a larger value for <code>MaxFaces</code>.</para><para>If <code>IndexFaces</code> detects more faces than the value of <code>MaxFaces</code>, the faces with the lowest quality are filtered out first. If there are still more faces than the value of <code>MaxFaces</code>, the faces with the smallest bounding boxes are filtered out (up to the number that's needed to satisfy the value of <code>MaxFaces</code>). Information about the unindexed faces is available in the <code>UnindexedFaces</code> array. </para><para>The faces that are returned by <code>IndexFaces</code> are sorted by the largest face bounding box size to the smallest size, in descending order.</para><para><code>MaxFaces</code> can be used with a collection associated with any version of the face model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.QualityFilter"> <summary> <para> <para>A filter that specifies how much filtering is done to identify faces that are detected with low quality. Filtered faces aren't indexed. If you specify <code>AUTO</code>, filtering prioritizes the identification of faces that don’t meet the required quality bar chosen by Amazon Rekognition. The quality bar is based on a variety of common use cases. Low-quality detections can occur for a number of reasons. Some examples are an object that's misidentified as a face, a face that's too blurry, or a face with a pose that's too extreme to use. If you specify <code>NONE</code>, no filtering is performed. The default value is AUTO.</para><para>To use quality filtering, the collection you are using must be associated with version 3 of the face model.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.AddREKDetectedFacesToCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet"> <summary> Compares a face in the <i>source</i> input image with each of the 100 largest faces detected in the <i>target</i> input image. <note><para> If the source image contains multiple faces, the service detects the largest face and compares it with each face detected in the target image. </para></note><para> You pass the input and target images either as base64-encoded image bytes or as references to images in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes isn't supported. The image must be formatted as a PNG or JPEG file. </para><para> In response, the operation returns an array of face matches ordered by similarity score in descending order. For each face match, the response provides a bounding box of the face, facial landmarks, pose details (pitch, role, and yaw), quality (brightness and sharpness), and confidence value (indicating the level of confidence that the bounding box contains a face). The response also provides a similarity score, which indicates how closely the faces match. </para><note><para> By default, only faces with a similarity score of greater than or equal to 80% are returned in the response. You can change this value by specifying the <code>SimilarityThreshold</code> parameter. </para></note><para><code>CompareFaces</code> also returns an array of faces that don't match the source image. For each face, it returns a bounding box, confidence value, landmarks, pose details, and quality. The response also returns information about the face in the source image, including the bounding box of the face and confidence value. </para><para> If the image doesn't contain Exif metadata, <code>CompareFaces</code> returns orientation information for the source and target images. Use these values to display the images with the correct image orientation. </para><para> If no faces are detected in the source or target images, <code>CompareFaces</code> returns an <code>InvalidParameterException</code> error. </para><note><para> This is a stateless API operation. That is, data returned by this operation doesn't persist. </para></note><para> For an example, see Comparing Faces in Images in the Amazon Rekognition Developer Guide. </para><para> This operation requires permissions to perform the <code>rekognition:CompareFaces</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SimilarityThreshold"> <summary> <para> <para>The minimum level of confidence in the face matches that a match must meet to be included in the <code>FaceMatches</code> array.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.SourceImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.TargetImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.CompareREKFaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet"> <summary> Returns an array of celebrities recognized in the input image. For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. <para><code>RecognizeCelebrities</code> returns the 100 largest faces in the image. It lists recognized celebrities in the <code>CelebrityFaces</code> array and unrecognized faces in the <code>UnrecognizedFaces</code> array. <code>RecognizeCelebrities</code> doesn't return celebrities whose faces aren't among the largest 100 faces in the image. </para><para> For each celebrity recognized, <code>RecognizeCelebrities</code> returns a <code>Celebrity</code> object. The <code>Celebrity</code> object contains the celebrity name, ID, URL links to additional information, match confidence, and a <code>ComparedFace</code> object that you can use to locate the celebrity's face on the image. </para><para> Amazon Rekognition doesn't retain information about which images a celebrity has been recognized in. Your application must store this information and use the <code>Celebrity</code> ID property as a unique identifier for the celebrity. If you don't store the celebrity name or additional information URLs returned by <code>RecognizeCelebrities</code>, you will need the ID to identify the celebrity in a call to the <a>GetCelebrityInfo</a> operation. </para><para> You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </para><para> For an example, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. </para><para> This operation requires permissions to perform the <code>rekognition:RecognizeCelebrities</code> operation. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKCelebrityCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet"> <summary> Detects faces within an image that is provided as input. <para><code>DetectFaces</code> detects the 100 largest faces in the image. For each face detected, the operation returns face details. These details include a bounding box of the face, a confidence value (that the bounding box contains a face), and a fixed set of attributes such as facial landmarks (for example, coordinates of eye and mouth), gender, presence of beard, sunglasses, and so on. </para><para> The face-detection algorithm is most effective on frontal faces. For non-frontal or obscured faces, the algorithm might not detect the faces or might detect faces with lower confidence. </para><para> You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </para><note><para> This is a stateless API operation. That is, the operation does not persist any data. </para></note><para> This operation requires permissions to perform the <code>rekognition:DetectFaces</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.Attribute"> <summary> <para> <para>An array of facial attributes you want to be returned. This can be the default list of attributes or all attributes. If you don't specify a value for <code>Attributes</code> or if you specify <code>["DEFAULT"]</code>, the API returns the following subset of facial attributes: <code>BoundingBox</code>, <code>Confidence</code>, <code>Pose</code>, <code>Quality</code>, and <code>Landmarks</code>. If you provide <code>["ALL"]</code>, all facial attributes are returned, but the operation takes longer to complete.</para><para>If you provide both, <code>["ALL", "DEFAULT"]</code>, the service uses a logical AND operator to determine which attributes to return (in this case, all attributes). </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKFaceCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet"> <summary> Detects instances of real-world entities within an image (JPEG or PNG) provided as input. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; and concepts like landscape, evening, and nature. <para> For an example, see Analyzing Images Stored in an Amazon S3 Bucket in the Amazon Rekognition Developer Guide. </para><note><para><code>DetectLabels</code> does not support the detection of activities. However, activity detection is supported for label detection in videos. For more information, see StartLabelDetection in the Amazon Rekognition Developer Guide. </para></note><para> You pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </para><para> For each object, scene, and concept the API returns one or more labels. Each label provides the object name, and the level of confidence that the image contains the object. For example, suppose the input image has a lighthouse, the sea, and a rock. The response includes all three labels, one for each object. </para><para><code>{Name: lighthouse, Confidence: 98.4629}</code></para><para><code>{Name: rock,Confidence: 79.2097}</code></para><para><code> {Name: sea,Confidence: 75.061}</code></para><para> In the preceding example, the operation returns one label for each of the three objects. The operation can also return multiple labels for the same object in the image. For example, if the input image shows a flower (for example, a tulip), the operation might return the following three labels. </para><para><code>{Name: flower,Confidence: 99.0562}</code></para><para><code>{Name: plant,Confidence: 99.0562}</code></para><para><code>{Name: tulip,Confidence: 99.0562}</code></para><para> In this example, the detection algorithm more precisely identifies the flower as a tulip. </para><para> In response, the API returns an array of labels. In addition, the response also includes the orientation correction. Optionally, you can specify <code>MinConfidence</code> to control the confidence threshold for the labels returned. The default is 55%. You can also add the <code>MaxLabels</code> parameter to limit the number of labels returned. </para><note><para> If the object detected is a person, the operation doesn't provide the same facial details that the <a>DetectFaces</a> operation provides. </para></note><para><code>DetectLabels</code> returns bounding boxes for instances of common object labels in an array of <a>Instance</a> objects. An <code>Instance</code> object contains a <a>BoundingBox</a> object, for the location of the label on the image. It also includes the confidence by which the bounding box was detected. </para><para><code>DetectLabels</code> also returns a hierarchical taxonomy of detected labels. For example, a detected car might be assigned the label <i>car</i>. The label <i>car</i> has two parent labels: <i>Vehicle</i> (its parent) and <i>Transportation</i> (its grandparent). The response returns the entire list of ancestors for a label. Each ancestor is a unique label in the response. In the previous example, <i>Car</i>, <i>Vehicle</i>, and <i>Transportation</i> are returned as unique labels in the response. </para><para> This is a stateless API operation. That is, the operation does not persist any data. </para><para> This operation requires permissions to perform the <code>rekognition:DetectLabels</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.MaxLabel"> <summary> <para> <para>Maximum number of labels you want the service to return in the response. The service returns the specified number of highest confidence labels. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with confidence lower than this specified value.</para><para>If <code>MinConfidence</code> is not specified, the operation returns labels with a confidence values greater than or equal to 55 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKLabelCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet"> <summary> Detects unsafe content in a specified JPEG or PNG format image. Use <code>DetectModerationLabels</code> to moderate images depending on your requirements. For example, you might want to filter images that contain nudity, but not images containing suggestive content. <para> To filter images, use the labels returned by <code>DetectModerationLabels</code> to determine which types of content are appropriate. </para><para> For information about moderation labels, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. </para><para> You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.S3Object_Bucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.Image_Byte"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence level for the labels to return. Amazon Rekognition doesn't return any labels with a confidence level lower than this specified value.</para><para>If you don't specify <code>MinConfidence</code>, the operation returns labels with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.S3Object_Name"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKModerationLabelCmdlet.S3Object_Version"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet"> <summary> Detects text in the input image and converts it into machine-readable text. <para> Pass the input image as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, you must pass it as a reference to an image in an Amazon S3 bucket. For the AWS CLI, passing image bytes is not supported. The image must be either a .png or .jpeg formatted file. </para><para> The <code>DetectText</code> operation returns text in an array of <a>TextDetection</a> elements, <code>TextDetections</code>. Each <code>TextDetection</code> element provides information about a single word or line of text that was detected in the image. </para><para> A word is one or more ISO basic latin script characters that are not separated by spaces. <code>DetectText</code> can detect up to 50 words in an image. </para><para> A line is a string of equally spaced words. A line isn't necessarily a complete sentence. For example, a driver's license number is detected as a line. A line ends when there is no aligned text after it. Also, a line ends when there is a large gap between words, relative to the length of the words. This means, depending on the gap between words, Amazon Rekognition may detect multiple lines in text aligned in the same direction. Periods don't represent the end of a line. If a sentence spans multiple lines, the <code>DetectText</code> operation returns multiple lines. </para><para> To determine whether a <code>TextDetection</code> element is a line of text or a word, use the <code>TextDetection</code> object <code>Type</code> field. </para><para> To be detected, text must be within +/- 90 degrees orientation of the horizontal axis. </para><para> For more information, see DetectText in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.FindREKTextCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityInfoCmdlet"> <summary> Gets the name and additional information about a celebrity based on his or her Amazon Rekognition ID. The additional information is returned as an array of URLs. If there is no additional information about the celebrity, this list is empty. <para> For more information, see Recognizing Celebrities in an Image in the Amazon Rekognition Developer Guide. </para><para> This operation requires permissions to perform the <code>rekognition:GetCelebrityInfo</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityInfoCmdlet.Id"> <summary> <para> <para>The ID for the celebrity. You get the celebrity ID from a call to the <a>RecognizeCelebrities</a> operation, which recognizes celebrities in an image. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet"> <summary> Gets the celebrity recognition results for a Amazon Rekognition Video analysis started by <a>StartCelebrityRecognition</a>. <para> Celebrity recognition in a video is an asynchronous operation. Analysis is started by a call to <a>StartCelebrityRecognition</a> which returns a job identifier (<code>JobId</code>). When the celebrity recognition operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartCelebrityRecognition</code>. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetCelebrityDetection</code> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityDetection</code>. </para><para> For more information, see Working With Stored Videos in the Amazon Rekognition Developer Guide. </para><para><code>GetCelebrityRecognition</code> returns detected celebrities and the time(s) they are detected in an array (<code>Celebrities</code>) of <a>CelebrityRecognition</a> objects. Each <code>CelebrityRecognition</code> contains information about the celebrity in a <a>CelebrityDetail</a> object and the time, <code>Timestamp</code>, the celebrity was detected. </para><note><para><code>GetCelebrityRecognition</code> only returns the default facial attributes (<code>BoundingBox</code>, <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed in the <code>Face</code> object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. </para></note><para> By default, the <code>Celebrities</code> array is sorted by time (milliseconds from the start of the video). You can also sort the array by celebrity by specifying the value <code>ID</code> in the <code>SortBy</code> input parameter. </para><para> The <code>CelebrityDetail</code> object includes the celebrity identifer and additional information urls. If you don't store the additional information urls, you can get them later by calling <a>GetCelebrityInfo</a> with the celebrity identifer. </para><para> No information is returned for faces not recognized as celebrities. </para><para> Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetCelebrityDetection</code> and populate the <code>NextToken</code> request parameter with the token value returned from the previous call to <code>GetCelebrityRecognition</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.JobId"> <summary> <para> <para>Job identifier for the required celebrity recognition analysis. You can get the job identifer from a call to <code>StartCelebrityRecognition</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.SortBy"> <summary> <para> <para>Sort to use for celebrities returned in <code>Celebrities</code> field. Specify <code>ID</code> to sort by the celebrity identifier, specify <code>TIMESTAMP</code> to sort by the time the celebrity was recognized.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCelebrityRecognitionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more recognized celebrities to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of celebrities. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionCmdlet"> <summary> Describes the specified collection. You can use <code>DescribeCollection</code> to get information, such as the number of faces indexed into a collection and the version of the model used by the collection for face detection. <para> For more information, see Describing a Collection in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionCmdlet.CollectionId"> <summary> <para> <para>The ID of the collection to describe.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet"> <summary> Returns list of collection IDs in your account. If the result is truncated, the response also provides a <code>NextToken</code> that you can use in the subsequent request to fetch the next set of collection IDs. <para> For an example, see Listing Collections in the Amazon Rekognition Developer Guide. </para><para> This operation requires permissions to perform the <code>rekognition:ListCollections</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of collection IDs to return. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKCollectionIdListCmdlet.NextToken"> <summary> <para> <para>Pagination token from the previous response.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet"> <summary> Gets the unsafe content analysis results for a Amazon Rekognition Video analysis started by <a>StartContentModeration</a>. <para> Unsafe content analysis of a video is an asynchronous operation. You start analysis by calling <a>StartContentModeration</a> which returns a job identifier (<code>JobId</code>). When analysis finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartContentModeration</code>. To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetContentModeration</code> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </para><para> For more information, see Working with Stored Videos in the Amazon Rekognition Devlopers Guide. </para><para><code>GetContentModeration</code> returns detected unsafe content labels, and the time they are detected, in an array, <code>ModerationLabels</code>, of <a>ContentModerationDetection</a> objects. </para><para> By default, the moderated labels are returned sorted by time, in milliseconds from the start of the video. You can also sort them by moderated label by specifying <code>NAME</code> for the <code>SortBy</code> input parameter. </para><para> Since video analysis can return a large number of results, use the <code>MaxResults</code> parameter to limit the number of labels returned in a single call to <code>GetContentModeration</code>. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetContentModeration</code> and populate the <code>NextToken</code> request parameter with the value of <code>NextToken</code> returned from the previous call to <code>GetContentModeration</code>. </para><para> For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.JobId"> <summary> <para> <para>The identifier for the unsafe content job. Use <code>JobId</code> to identify the job in a subsequent call to <code>GetContentModeration</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.SortBy"> <summary> <para> <para>Sort to use for elements in the <code>ModerationLabelDetections</code> array. Use <code>TIMESTAMP</code> to sort array elements by the time labels are detected. Use <code>NAME</code> to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by <code>TIMESTAMP</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKContentModerationCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of unsafe content labels.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet"> <summary> Gets face detection results for a Amazon Rekognition Video analysis started by <a>StartFaceDetection</a>. <para> Face detection with Amazon Rekognition Video is an asynchronous operation. You start face detection by calling <a>StartFaceDetection</a> which returns a job identifier (<code>JobId</code>). When the face detection operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartFaceDetection</code>. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>. </para><para><code>GetFaceDetection</code> returns an array of detected faces (<code>Faces</code>) sorted by the time the faces were detected. </para><para> Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetFaceDetection</code> and populate the <code>NextToken</code> request parameter with the token value returned from the previous call to <code>GetFaceDetection</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.JobId"> <summary> <para> <para>Unique identifier for the face detection job. The <code>JobId</code> is returned from <code>StartFaceDetection</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceDetectionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more faces to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet"> <summary> Returns metadata for faces in the specified collection. This metadata includes information such as the bounding box coordinates, the confidence (that the bounding box contains a face), and face ID. For an example, see Listing Faces in a Collection in the Amazon Rekognition Developer Guide. <para> This operation requires permissions to perform the <code>rekognition:ListFaces</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.CollectionId"> <summary> <para> <para>ID of the collection from which to list the faces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of faces to return.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more data to retrieve), Amazon Rekognition returns a pagination token in the response. You can use this pagination token to retrieve the next set of faces.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet"> <summary> Gets the face search results for Amazon Rekognition Video face search started by <a>StartFaceSearch</a>. The search returns faces in a collection that match the faces of persons detected in a video. It also includes the time(s) that faces are matched in the video. <para> Face search in a video is an asynchronous operation. You start face search by calling to <a>StartFaceSearch</a> which returns a job identifier (<code>JobId</code>). When the search operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartFaceSearch</code>. To get the search results, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <code>GetFaceSearch</code> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. </para><para> For more information, see Searching Faces in a Collection in the Amazon Rekognition Developer Guide. </para><para> The search results are retured in an array, <code>Persons</code>, of <a>PersonMatch</a> objects. Each<code>PersonMatch</code> element contains details about the matching faces in the input collection, person information (facial attributes, bounding boxes, and person identifer) for the matched person, and the time the person was matched in the video. </para><note><para><code>GetFaceSearch</code> only returns the default facial attributes (<code>BoundingBox</code>, <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed in the <code>Face</code> object of the following response syntax are not returned. For more information, see FaceDetail in the Amazon Rekognition Developer Guide. </para></note><para> By default, the <code>Persons</code> array is sorted by the time, in milliseconds from the start of the video, persons are matched. You can also sort by persons by specifying <code>INDEX</code> for the <code>SORTBY</code> input parameter. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.JobId"> <summary> <para> <para>The job identifer for the search request. You get the job identifier from an initial call to <code>StartFaceSearch</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.SortBy"> <summary> <para> <para>Sort to use for grouping faces in the response. Use <code>TIMESTAMP</code> to group faces by the time that they are recognized. Use <code>INDEX</code> to sort by recognized faces. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKFaceSearchCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there is more search results to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of search results. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet"> <summary> Gets the label detection results of a Amazon Rekognition Video analysis started by <a>StartLabelDetection</a>. <para> The label detection operation is started by a call to <a>StartLabelDetection</a> which returns a job identifier (<code>JobId</code>). When the label detection operation finishes, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartlabelDetection</code>. To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>. </para><para><code>GetLabelDetection</code> returns an array of detected labels (<code>Labels</code>) sorted by the time the labels were detected. You can also sort by the label name by specifying <code>NAME</code> for the <code>SortBy</code> input parameter. </para><para> The labels returned include the label name, the percentage confidence in the accuracy of the detected label, and the time the label was detected in the video. </para><para> The returned labels also include bounding box information for common objects, a hierarchical taxonomy of detected labels, and the version of the label model used for detection. </para><para> Use MaxResults parameter to limit the number of labels returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetlabelDetection</code> and populate the <code>NextToken</code> request parameter with the token value returned from the previous call to <code>GetLabelDetection</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.JobId"> <summary> <para> <para>Job identifier for the label detection operation for which you want results returned. You get the job identifer from an initial call to <code>StartlabelDetection</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.SortBy"> <summary> <para> <para>Sort to use for elements in the <code>Labels</code> array. Use <code>TIMESTAMP</code> to sort array elements by the time labels are detected. Use <code>NAME</code> to alphabetically group elements for a label together. Within each label group, the array element are sorted by detection confidence. The default sort is by <code>TIMESTAMP</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKLabelDetectionCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more labels to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of labels. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet"> <summary> Gets the path tracking results of a Amazon Rekognition Video analysis started by <a>StartPersonTracking</a>. <para> The person path tracking operation is started by a call to <code>StartPersonTracking</code> which returns a job identifier (<code>JobId</code>). When the operation finishes, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic registered in the initial call to <code>StartPersonTracking</code>. </para><para> To get the results of the person path tracking operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>. </para><para><code>GetPersonTracking</code> returns an array, <code>Persons</code>, of tracked persons and the time(s) their paths were tracked in the video. </para><note><para><code>GetPersonTracking</code> only returns the default facial attributes (<code>BoundingBox</code>, <code>Confidence</code>, <code>Landmarks</code>, <code>Pose</code>, and <code>Quality</code>). The other facial attributes listed in the <code>Face</code> object of the following response syntax are not returned. </para><para> For more information, see FaceDetail in the Amazon Rekognition Developer Guide. </para></note><para> By default, the array is sorted by the time(s) a person's path is tracked in the video. You can sort by tracked persons by specifying <code>INDEX</code> for the <code>SortBy</code> input parameter. </para><para> Use the <code>MaxResults</code> parameter to limit the number of items returned. If there are more results than specified in <code>MaxResults</code>, the value of <code>NextToken</code> in the operation response contains a pagination token for getting the next set of results. To get the next page of results, call <code>GetPersonTracking</code> and populate the <code>NextToken</code> request parameter with the token value returned from the previous call to <code>GetPersonTracking</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.JobId"> <summary> <para> <para>The identifier for a job that tracks persons in a video. You get the <code>JobId</code> from a call to <code>StartPersonTracking</code>. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.SortBy"> <summary> <para> <para>Sort to use for elements in the <code>Persons</code> array. Use <code>TIMESTAMP</code> to sort array elements by the time persons are detected. Use <code>INDEX</code> to sort by the tracked persons. If you sort by <code>INDEX</code>, the array elements for each person are sorted by detection confidence. The default sort is by <code>TIMESTAMP</code>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.MaxResult"> <summary> <para> <para>Maximum number of results to return per paginated call. The largest value you can specify is 1000. If you specify a value greater than 1000, a maximum of 1000 results is returned. The default value is 1000.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKPersonTrackingCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more persons to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of persons. </para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorCmdlet"> <summary> Provides information about a stream processor created by <a>CreateStreamProcessor</a>. You can get information about the input and output streams, the input parameters for the face recognition being performed, and the current status of the stream processor. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorCmdlet.Name"> <summary> <para> <para>Name of the stream processor for which you want information.</para> </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet"> <summary> Gets a list of stream processors that you have created with <a>CreateStreamProcessor</a>.<br/><br/>This operation automatically pages all available results to the pipeline - parameters related to iteration are only needed if you want to manually control the paginated output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet.MaxResult"> <summary> <para> <para>Maximum number of stream processors you want Amazon Rekognition Video to return in the response. The default is 1000. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.GetREKStreamProcessorListCmdlet.NextToken"> <summary> <para> <para>If the previous response was incomplete (because there are more stream processors to retrieve), Amazon Rekognition Video returns a pagination token in the response. You can use this pagination token to retrieve the next set of stream processors. </para> </para> <para> <br/><b>Note:</b> This parameter is only used if you are manually controlling output pagination of the service API call. <br/>In order to manually control output pagination, assign $null, for the first call, and the value of $AWSHistory.LastServiceResponse.NextToken, for subsequent calls, to this parameter. </para> </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet"> <summary> Creates a collection in an AWS Region. You can add faces to the collection using the <a>IndexFaces</a> operation. <para> For example, you might create collections, one for each of your application users. A user can then index faces using the <code>IndexFaces</code> operation and persist results in a specific collection. Then, a user can search the collection for faces in the user-specific container. </para><para> When you create a collection, it is associated with the latest version of the face model version. </para><note><para> Collection names are case-sensitive. </para></note><para> This operation requires permissions to perform the <code>rekognition:CreateCollection</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet.CollectionId"> <summary> <para> <para>ID for the collection that you are creating.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet"> <summary> Creates an Amazon Rekognition stream processor that you can use to detect and recognize faces in a streaming video. <para> Amazon Rekognition Video is a consumer of live video from Amazon Kinesis Video Streams. Amazon Rekognition Video sends analysis results to Amazon Kinesis Data Streams. </para><para> You provide as input a Kinesis video stream (<code>Input</code>) and a Kinesis data stream (<code>Output</code>) stream. You also specify the face recognition criteria in <code>Settings</code>. For example, the collection containing faces that you want to recognize. Use <code>Name</code> to assign an identifier for the stream processor. You use <code>Name</code> to manage the stream processor. For example, you can start processing the source video by calling <a>StartStreamProcessor</a> with the <code>Name</code> field. </para><para> After you have finished analyzing a streaming video, use <a>StopStreamProcessor</a> to stop processing. You can delete the stream processor by calling <a>DeleteStreamProcessor</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.KinesisVideoStream_Arn"> <summary> <para> <para>ARN of the Kinesis video stream stream that streams the source video.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.KinesisDataStream_Arn"> <summary> <para> <para>ARN of the output Amazon Kinesis Data Streams stream.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.FaceSearch_CollectionId"> <summary> <para> <para>The ID of a collection that contains faces that you want to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.FaceSearch_FaceMatchThreshold"> <summary> <para> <para>Minimum face match confidence score that must be met to return a result for a recognized face. Default is 70. 0 is the lowest confidence. 100 is the highest confidence.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.Name"> <summary> <para> <para>An identifier you assign to the stream processor. You can use <code>Name</code> to manage the stream processor. For example, you can get the current status of the stream processor by calling <a>DescribeStreamProcessor</a>. <code>Name</code> is idempotent. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.RoleArn"> <summary> <para> <para>ARN of the IAM role that allows access to the stream processor.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.NewREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet"> <summary> Deletes the specified collection. Note that this operation removes all faces in the collection. For an example, see <a>delete-collection-procedure</a>. <para> This operation requires permissions to perform the <code>rekognition:DeleteCollection</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet.CollectionId"> <summary> <para> <para>ID of the collection to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKCollectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet"> <summary> Deletes faces from a collection. You specify a collection ID and an array of face IDs to remove from the collection. <para> This operation requires permissions to perform the <code>rekognition:DeleteFaces</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.CollectionId"> <summary> <para> <para>Collection from which to remove the specific faces.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.FaceId"> <summary> <para> <para>An array of face IDs to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKFaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet"> <summary> Deletes the stream processor identified by <code>Name</code>. You assign the value for <code>Name</code> when you create the stream processor with <a>CreateStreamProcessor</a>. You might not be able to use the same name for a stream processor for a few seconds after calling <code>DeleteStreamProcessor</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet.Name"> <summary> <para> <para>The name of the stream processor you want to delete.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.RemoveREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet"> <summary> For a given input face ID, searches for matching faces in the collection the face belongs to. You get a face ID when you add a face to the collection using the <a>IndexFaces</a> operation. The operation compares the features of the input face with faces in the specified collection. <note><para> You can also search faces without indexing faces by using the <code>SearchFacesByImage</code> operation. </para></note><para> The operation response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match that is found. Along with the metadata, the response also includes a <code>confidence</code> value for each face match, indicating the confidence that the specific face matches the input face. </para><para> For an example, see Searching for a Face Using Its Face ID in the Amazon Rekognition Developer Guide. </para><para> This operation requires permissions to perform the <code>rekognition:SearchFaces</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.CollectionId"> <summary> <para> <para>ID of the collection the face belongs to.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.FaceId"> <summary> <para> <para>ID of a face to find matches for in the collection.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.FaceMatchThreshold"> <summary> <para> <para>Optional value specifying the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.MaxFace"> <summary> <para> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFaceCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet"> <summary> For a given input image, first detects the largest face in the image, and then searches the specified collection for matching faces. The operation compares the features of the input face with faces in the specified collection. <note><para> To search for all faces in an input image, you might first call the <a>IndexFaces</a> operation, and then use the face IDs returned in subsequent calls to the <a>SearchFaces</a> operation. </para><para> You can also call the <code>DetectFaces</code> operation and use the bounding boxes in the response to make face crops, which then you can pass in to the <code>SearchFacesByImage</code> operation. </para></note><para> You pass the input image either as base64-encoded image bytes or as a reference to an image in an Amazon S3 bucket. If you use the AWS CLI to call Amazon Rekognition operations, passing image bytes is not supported. The image must be either a PNG or JPEG formatted file. </para><para> The response returns an array of faces that match, ordered by similarity score with the highest similarity first. More specifically, it is an array of metadata for each face match found. Along with the metadata, the response also includes a <code>similarity</code> indicating how similar the face is to the input face. In the response, the operation also returns the bounding box (and a confidence level that the bounding box contains a face) of the face that Amazon Rekognition used for the input image. </para><para> For an example, Searching for a Face Using an Image in the Amazon Rekognition Developer Guide. </para><para> This operation requires permissions to perform the <code>rekognition:SearchFacesByImage</code> action. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageBucket"> <summary> <para> <para>Name of the S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageContent"> <summary> <para> <para>Blob of image bytes up to 5 MBs.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.CollectionId"> <summary> <para> <para>ID of the collection to search.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.FaceMatchThreshold"> <summary> <para> <para>(Optional) Specifies the minimum confidence in the face match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.MaxFace"> <summary> <para> <para>Maximum number of faces to return. The operation returns the maximum number of faces with the highest confidence in the match.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageName"> <summary> <para> <para>S3 object key name.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.ImageVersion"> <summary> <para> <para>If the bucket is versioning enabled, you can specify the object version. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.SearchREKFacesByImageCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet"> <summary> Starts asynchronous recognition of celebrities in a stored video. <para> Amazon Rekognition Video can detect celebrities in a video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartCelebrityRecognition</code> returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis. When celebrity recognition analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. To get the results of the celebrity recognition analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetCelebrityRecognition</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartCelebrityRecognition</code>. </para><para> For more information, see Recognizing Celebrities in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartCelebrityRecognition</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.Video"> <summary> <para> <para>The video in which you want to recognize celebrities. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKCelebrityRecognitionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet"> <summary> Starts asynchronous detection of unsafe content in a stored video. <para> Amazon Rekognition Video can moderate content in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartContentModeration</code> returns a job identifier (<code>JobId</code>) which you use to get the results of the analysis. When unsafe content analysis is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. </para><para> To get the results of the unsafe content analysis, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetContentModeration</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartContentModeration</code>. </para><para> For more information, see Detecting Unsafe Content in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartContentModeration</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence that Amazon Rekognition must have in order to return a moderated content label. Confidence represents how certain Amazon Rekognition is that the moderated content is correctly identified. 0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition doesn't return any moderated content labels with a confidence level lower than this specified value. If you don't specify <code>MinConfidence</code>, <code>GetContentModeration</code> returns labels with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.Video"> <summary> <para> <para>The video in which you want to detect unsafe content. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKContentModerationCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet"> <summary> Starts asynchronous detection of faces in a stored video. <para> Amazon Rekognition Video can detect faces in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartFaceDetection</code> returns a job identifier (<code>JobId</code>) that you use to get the results of the operation. When face detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. To get the results of the face detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceDetection</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceDetection</code>. </para><para> For more information, see Detecting Faces in a Stored Video in the Amazon Rekognition Developer Guide. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartFaceDetection</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.FaceAttribute"> <summary> <para> <para>The face attributes you want returned.</para><para><code>DEFAULT</code> - The following subset of facial attributes are returned: BoundingBox, Confidence, Pose, Quality and Landmarks. </para><para><code>ALL</code> - All facial attributes are returned.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.Video"> <summary> <para> <para>The video in which you want to detect faces. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceDetectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet"> <summary> Starts the asynchronous search for faces in a collection that match the faces of persons detected in a stored video. <para> The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartFaceSearch</code> returns a job identifier (<code>JobId</code>) which you use to get the search results once the search has completed. When searching is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. To get the search results, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetFaceSearch</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartFaceSearch</code>. For more information, see <a>procedure-person-search-videos</a>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartFaceSearch</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.CollectionId"> <summary> <para> <para>ID of the collection that contains the faces you want to search for.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.FaceMatchThreshold"> <summary> <para> <para>The minimum confidence in the person match to return. For example, don't return any matches where confidence in matches is less than 70%. The default value is 80%.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.Video"> <summary> <para> <para>The video you want to search. The video must be stored in an Amazon S3 bucket. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKFaceSearchCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet"> <summary> Starts asynchronous detection of labels in a stored video. <para> Amazon Rekognition Video can detect labels in a video. Labels are instances of real-world entities. This includes objects like flower, tree, and table; events like wedding, graduation, and birthday party; concepts like landscape, evening, and nature; and activities like a person getting out of a car or a person skiing. </para><para> The video must be stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartLabelDetection</code> returns a job identifier (<code>JobId</code>) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition Video publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. </para><para> To get the results of the label detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetLabelDetection</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartLabelDetection</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartLabelDetection</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.MinConfidence"> <summary> <para> <para>Specifies the minimum confidence that Amazon Rekognition Video must have in order to return a detected label. Confidence represents how certain Amazon Rekognition is that a label is correctly identified.0 is the lowest confidence. 100 is the highest confidence. Amazon Rekognition Video doesn't return any labels with a confidence level lower than this specified value.</para><para>If you don't specify <code>MinConfidence</code>, the operation returns labels with confidence values greater than or equal to 50 percent.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.Video"> <summary> <para> <para>The video in which you want to detect labels. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKLabelDetectionCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet"> <summary> Starts the asynchronous tracking of a person's path in a stored video. <para> Amazon Rekognition Video can track the path of people in a video stored in an Amazon S3 bucket. Use <a>Video</a> to specify the bucket name and the filename of the video. <code>StartPersonTracking</code> returns a job identifier (<code>JobId</code>) which you use to get the results of the operation. When label detection is finished, Amazon Rekognition publishes a completion status to the Amazon Simple Notification Service topic that you specify in <code>NotificationChannel</code>. </para><para> To get the results of the person detection operation, first check that the status value published to the Amazon SNS topic is <code>SUCCEEDED</code>. If so, call <a>GetPersonTracking</a> and pass the job identifier (<code>JobId</code>) from the initial call to <code>StartPersonTracking</code>. </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.ClientRequestToken"> <summary> <para> <para>Idempotent token used to identify the start request. If you use the same token with multiple <code>StartPersonTracking</code> requests, the same <code>JobId</code> is returned. Use <code>ClientRequestToken</code> to prevent the same job from being accidently started more than once. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.JobTag"> <summary> <para> <para>An identifier you specify that's returned in the completion notification that's published to your Amazon Simple Notification Service topic. For example, you can use <code>JobTag</code> to group related jobs and identify them in the completion notification.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.NotificationChannel_RoleArn"> <summary> <para> <para>The ARN of an IAM role that gives Amazon Rekognition publishing permissions to the Amazon SNS topic. </para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.NotificationChannel_SNSTopicArn"> <summary> <para> <para>The Amazon SNS topic to which Amazon Rekognition to posts the completion status.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.Video"> <summary> <para> <para>The video in which you want to detect people. The video must be stored in an Amazon S3 bucket.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKPersonTrackingCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet"> <summary> Starts processing a stream processor. You create a stream processor by calling <a>CreateStreamProcessor</a>. To tell <code>StartStreamProcessor</code> which stream processor to start, use the value of the <code>Name</code> field specified in the call to <code>CreateStreamProcessor</code>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.Name"> <summary> <para> <para>The name of the stream processor to start processing.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StartREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> <member name="T:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet"> <summary> Stops a running stream processor that was created by <a>CreateStreamProcessor</a>. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet.Name"> <summary> <para> <para>The name of a stream processor created by <a>CreateStreamProcessor</a>.</para> </para> </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet.PassThru"> <summary> Returns the value passed to the Name parameter. By default, this cmdlet does not generate any output. </summary> </member> <member name="P:Amazon.PowerShell.Cmdlets.REK.StopREKStreamProcessorCmdlet.Force"> <summary> This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution. </summary> </member> </members> </doc> |