aws-sdk-rekognition 1.3.0 → 1.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/aws-sdk-rekognition.rb +1 -1
- data/lib/aws-sdk-rekognition/client.rb +192 -151
- data/lib/aws-sdk-rekognition/types.rb +105 -90
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: ccfa4c9d2458982f1cdba49e5e5bc6340823e48c
|
4
|
+
data.tar.gz: 858434f3d92c1b9026ecd66e459e7e9d74efddc1
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 472a97e56f4b30c658fe9d6d31055c34d4507218686a8eb3fb905328a3b50ed63f81bc71cfbe7559cf74ae8a644b7542d84d59bd76b7b28c33ed4558bea9a3a0
|
7
|
+
data.tar.gz: 0b8043cf5886befce106db85d875ee9404b55924c7a5852ba05bd1e64510e260f68938413c9f7609103c411f4d75d94ccda38aba54bc5ce7240a8e7b8e4fc1d8
|
data/lib/aws-sdk-rekognition.rb
CHANGED
@@ -202,7 +202,8 @@ module Aws::Rekognition
|
|
202
202
|
#
|
203
203
|
# </note>
|
204
204
|
#
|
205
|
-
# For an example, see
|
205
|
+
# For an example, see Comparing Faces in Images in the Amazon
|
206
|
+
# Rekognition Developer Guide.
|
206
207
|
#
|
207
208
|
# This operation requires permissions to perform the
|
208
209
|
# `rekognition:CompareFaces` action.
|
@@ -408,9 +409,9 @@ module Aws::Rekognition
|
|
408
409
|
# Creates an Amazon Rekognition stream processor that you can use to
|
409
410
|
# detect and recognize faces in a streaming video.
|
410
411
|
#
|
411
|
-
# Rekognition Video is a consumer of live video from Amazon
|
412
|
-
# Video Streams. Rekognition Video sends analysis results
|
413
|
-
# Kinesis Data Streams.
|
412
|
+
# Amazon Rekognition Video is a consumer of live video from Amazon
|
413
|
+
# Kinesis Video Streams. Amazon Rekognition Video sends analysis results
|
414
|
+
# to Amazon Kinesis Data Streams.
|
414
415
|
#
|
415
416
|
# You provide as input a Kinesis video stream (`Input`) and a Kinesis
|
416
417
|
# data stream (`Output`) stream. You also specify the face recognition
|
@@ -429,7 +430,7 @@ module Aws::Rekognition
|
|
429
430
|
# `StreamProcessorInput`.
|
430
431
|
#
|
431
432
|
# @option params [required, Types::StreamProcessorOutput] :output
|
432
|
-
# Kinesis data stream stream to which Rekognition Video puts the
|
433
|
+
# Kinesis data stream stream to which Amazon Rekognition Video puts the
|
433
434
|
# analysis results. If you are using the AWS CLI, the parameter name is
|
434
435
|
# `StreamProcessorOutput`.
|
435
436
|
#
|
@@ -677,8 +678,6 @@ module Aws::Rekognition
|
|
677
678
|
#
|
678
679
|
# </note>
|
679
680
|
#
|
680
|
-
# For an example, see procedure-detecting-faces-in-images.
|
681
|
-
#
|
682
681
|
# This operation requires permissions to perform the
|
683
682
|
# `rekognition:DetectFaces` action.
|
684
683
|
#
|
@@ -835,11 +834,15 @@ module Aws::Rekognition
|
|
835
834
|
# Detects instances of real-world entities within an image (JPEG or PNG)
|
836
835
|
# provided as input. This includes objects like flower, tree, and table;
|
837
836
|
# events like wedding, graduation, and birthday party; and concepts like
|
838
|
-
# landscape, evening, and nature.
|
837
|
+
# landscape, evening, and nature.
|
838
|
+
#
|
839
|
+
# For an example, see Analyzing Images Stored in an Amazon S3 Bucket in
|
840
|
+
# the Amazon Rekognition Developer Guide.
|
839
841
|
#
|
840
842
|
# <note markdown="1"> `DetectLabels` does not support the detection of activities. However,
|
841
843
|
# activity detection is supported for label detection in videos. For
|
842
|
-
# more information, see
|
844
|
+
# more information, see StartLabelDetection in the Amazon Rekognition
|
845
|
+
# Developer Guide.
|
843
846
|
#
|
844
847
|
# </note>
|
845
848
|
#
|
@@ -981,8 +984,10 @@ module Aws::Rekognition
|
|
981
984
|
# content.
|
982
985
|
#
|
983
986
|
# To filter images, use the labels returned by `DetectModerationLabels`
|
984
|
-
# to determine which types of content are appropriate.
|
985
|
-
#
|
987
|
+
# to determine which types of content are appropriate.
|
988
|
+
#
|
989
|
+
# For information about moderation labels, see Detecting Unsafe Content
|
990
|
+
# in the Amazon Rekognition Developer Guide.
|
986
991
|
#
|
987
992
|
# You pass the input image either as base64-encoded image bytes or as a
|
988
993
|
# reference to an image in an Amazon S3 bucket. If you use the Amazon
|
@@ -1068,7 +1073,8 @@ module Aws::Rekognition
|
|
1068
1073
|
# To be detected, text must be within +/- 30 degrees orientation of the
|
1069
1074
|
# horizontal axis.
|
1070
1075
|
#
|
1071
|
-
# For more information, see
|
1076
|
+
# For more information, see DetectText in the Amazon Rekognition
|
1077
|
+
# Developer Guide.
|
1072
1078
|
#
|
1073
1079
|
# @option params [required, Types::Image] :image
|
1074
1080
|
# The input image as base64-encoded bytes or an Amazon S3 object. If you
|
@@ -1118,8 +1124,10 @@ module Aws::Rekognition
|
|
1118
1124
|
# Gets the name and additional information about a celebrity based on
|
1119
1125
|
# his or her Rekognition ID. The additional information is returned as
|
1120
1126
|
# an array of URLs. If there is no additional information about the
|
1121
|
-
# celebrity, this list is empty.
|
1122
|
-
#
|
1127
|
+
# celebrity, this list is empty.
|
1128
|
+
#
|
1129
|
+
# For more information, see Recognizing Celebrities in an Image in the
|
1130
|
+
# Amazon Rekognition Developer Guide.
|
1123
1131
|
#
|
1124
1132
|
# This operation requires permissions to perform the
|
1125
1133
|
# `rekognition:GetCelebrityInfo` action.
|
@@ -1152,20 +1160,22 @@ module Aws::Rekognition
|
|
1152
1160
|
req.send_request(options)
|
1153
1161
|
end
|
1154
1162
|
|
1155
|
-
# Gets the celebrity recognition results for a Rekognition Video
|
1163
|
+
# Gets the celebrity recognition results for a Amazon Rekognition Video
|
1156
1164
|
# analysis started by .
|
1157
1165
|
#
|
1158
1166
|
# Celebrity recognition in a video is an asynchronous operation.
|
1159
1167
|
# Analysis is started by a call to which returns a job identifier
|
1160
|
-
# (`JobId`). When the celebrity recognition operation finishes,
|
1168
|
+
# (`JobId`). When the celebrity recognition operation finishes, Amazon
|
1161
1169
|
# Rekognition Video publishes a completion status to the Amazon Simple
|
1162
1170
|
# Notification Service topic registered in the initial call to
|
1163
1171
|
# `StartCelebrityRecognition`. To get the results of the celebrity
|
1164
1172
|
# recognition analysis, first check that the status value published to
|
1165
1173
|
# the Amazon SNS topic is `SUCCEEDED`. If so, call
|
1166
1174
|
# `GetCelebrityDetection` and pass the job identifier (`JobId`) from the
|
1167
|
-
# initial call to `StartCelebrityDetection`.
|
1168
|
-
#
|
1175
|
+
# initial call to `StartCelebrityDetection`.
|
1176
|
+
#
|
1177
|
+
# For more information, see Working With Stored Videos in the Amazon
|
1178
|
+
# Rekognition Developer Guide.
|
1169
1179
|
#
|
1170
1180
|
# `GetCelebrityRecognition` returns detected celebrities and the time(s)
|
1171
1181
|
# they are detected in an array (`Celebrities`) of objects. Each
|
@@ -1175,7 +1185,8 @@ module Aws::Rekognition
|
|
1175
1185
|
# <note markdown="1"> `GetCelebrityRecognition` only returns the default facial attributes
|
1176
1186
|
# (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The
|
1177
1187
|
# other facial attributes listed in the `Face` object of the following
|
1178
|
-
# response syntax are not returned. For more information, see
|
1188
|
+
# response syntax are not returned. For more information, see FaceDetail
|
1189
|
+
# in the Amazon Rekognition Developer Guide.
|
1179
1190
|
#
|
1180
1191
|
# </note>
|
1181
1192
|
#
|
@@ -1210,9 +1221,9 @@ module Aws::Rekognition
|
|
1210
1221
|
#
|
1211
1222
|
# @option params [String] :next_token
|
1212
1223
|
# If the previous response was incomplete (because there is more
|
1213
|
-
# recognized celebrities to retrieve), Rekognition Video returns
|
1214
|
-
# pagination token in the response. You can use this pagination token
|
1215
|
-
# retrieve the next set of celebrities.
|
1224
|
+
# recognized celebrities to retrieve), Amazon Rekognition Video returns
|
1225
|
+
# a pagination token in the response. You can use this pagination token
|
1226
|
+
# to retrieve the next set of celebrities.
|
1216
1227
|
#
|
1217
1228
|
# @option params [String] :sort_by
|
1218
1229
|
# Sort to use for celebrities returned in `Celebrities` field. Specify
|
@@ -1301,19 +1312,21 @@ module Aws::Rekognition
|
|
1301
1312
|
req.send_request(options)
|
1302
1313
|
end
|
1303
1314
|
|
1304
|
-
# Gets the content moderation analysis results for a Rekognition
|
1305
|
-
# analysis started by .
|
1315
|
+
# Gets the content moderation analysis results for a Amazon Rekognition
|
1316
|
+
# Video analysis started by .
|
1306
1317
|
#
|
1307
1318
|
# Content moderation analysis of a video is an asynchronous operation.
|
1308
1319
|
# You start analysis by calling . which returns a job identifier
|
1309
|
-
# (`JobId`). When analysis finishes, Rekognition Video publishes
|
1310
|
-
# completion status to the Amazon Simple Notification Service topic
|
1320
|
+
# (`JobId`). When analysis finishes, Amazon Rekognition Video publishes
|
1321
|
+
# a completion status to the Amazon Simple Notification Service topic
|
1311
1322
|
# registered in the initial call to `StartContentModeration`. To get the
|
1312
1323
|
# results of the content moderation analysis, first check that the
|
1313
1324
|
# status value published to the Amazon SNS topic is `SUCCEEDED`. If so,
|
1314
1325
|
# call `GetCelebrityDetection` and pass the job identifier (`JobId`)
|
1315
|
-
# from the initial call to `StartCelebrityDetection`.
|
1316
|
-
#
|
1326
|
+
# from the initial call to `StartCelebrityDetection`.
|
1327
|
+
#
|
1328
|
+
# For more information, see Working with Stored Videos in the Amazon
|
1329
|
+
# Rekognition Devlopers Guide.
|
1317
1330
|
#
|
1318
1331
|
# `GetContentModeration` returns detected content moderation labels, and
|
1319
1332
|
# the time they are detected, in an array, `ModerationLabels`, of
|
@@ -1332,7 +1345,8 @@ module Aws::Rekognition
|
|
1332
1345
|
# and populate the `NextToken` request parameter with the value of
|
1333
1346
|
# `NextToken` returned from the previous call to `GetContentModeration`.
|
1334
1347
|
#
|
1335
|
-
# For more information, see
|
1348
|
+
# For more information, see Detecting Unsafe Content in the Amazon
|
1349
|
+
# Rekognition Developer Guide.
|
1336
1350
|
#
|
1337
1351
|
# @option params [required, String] :job_id
|
1338
1352
|
# The identifier for the content moderation job. Use `JobId` to identify
|
@@ -1398,18 +1412,18 @@ module Aws::Rekognition
|
|
1398
1412
|
req.send_request(options)
|
1399
1413
|
end
|
1400
1414
|
|
1401
|
-
# Gets face detection results for a Rekognition Video analysis
|
1402
|
-
# by .
|
1415
|
+
# Gets face detection results for a Amazon Rekognition Video analysis
|
1416
|
+
# started by .
|
1403
1417
|
#
|
1404
|
-
# Face detection with Rekognition Video is an asynchronous
|
1405
|
-
# You start face detection by calling which returns a job
|
1406
|
-
# (`JobId`). When the face detection operation finishes,
|
1407
|
-
# Video publishes a completion status to the Amazon
|
1408
|
-
# Service topic registered in the initial call to
|
1409
|
-
# To get the results of the face detection
|
1410
|
-
# the status value published to the Amazon
|
1411
|
-
# so, call and pass the job identifier
|
1412
|
-
# to `StartFaceDetection`.
|
1418
|
+
# Face detection with Amazon Rekognition Video is an asynchronous
|
1419
|
+
# operation. You start face detection by calling which returns a job
|
1420
|
+
# identifier (`JobId`). When the face detection operation finishes,
|
1421
|
+
# Amazon Rekognition Video publishes a completion status to the Amazon
|
1422
|
+
# Simple Notification Service topic registered in the initial call to
|
1423
|
+
# `StartFaceDetection`. To get the results of the face detection
|
1424
|
+
# operation, first check that the status value published to the Amazon
|
1425
|
+
# SNS topic is `SUCCEEDED`. If so, call and pass the job identifier
|
1426
|
+
# (`JobId`) from the initial call to `StartFaceDetection`.
|
1413
1427
|
#
|
1414
1428
|
# `GetFaceDetection` returns an array of detected faces (`Faces`) sorted
|
1415
1429
|
# by the time the faces were detected.
|
@@ -1433,9 +1447,9 @@ module Aws::Rekognition
|
|
1433
1447
|
#
|
1434
1448
|
# @option params [String] :next_token
|
1435
1449
|
# If the previous response was incomplete (because there are more faces
|
1436
|
-
# to retrieve), Rekognition Video returns a pagination token in
|
1437
|
-
# response. You can use this pagination token to retrieve the next
|
1438
|
-
# of faces.
|
1450
|
+
# to retrieve), Amazon Rekognition Video returns a pagination token in
|
1451
|
+
# the response. You can use this pagination token to retrieve the next
|
1452
|
+
# set of faces.
|
1439
1453
|
#
|
1440
1454
|
# @return [Types::GetFaceDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1441
1455
|
#
|
@@ -1509,20 +1523,22 @@ module Aws::Rekognition
|
|
1509
1523
|
req.send_request(options)
|
1510
1524
|
end
|
1511
1525
|
|
1512
|
-
# Gets the face search results for Rekognition Video face search
|
1513
|
-
# by . The search returns faces in a collection that match the
|
1514
|
-
# persons detected in a video. It also includes the time(s)
|
1515
|
-
# are matched in the video.
|
1526
|
+
# Gets the face search results for Amazon Rekognition Video face search
|
1527
|
+
# started by . The search returns faces in a collection that match the
|
1528
|
+
# faces of persons detected in a video. It also includes the time(s)
|
1529
|
+
# that faces are matched in the video.
|
1516
1530
|
#
|
1517
1531
|
# Face search in a video is an asynchronous operation. You start face
|
1518
1532
|
# search by calling to which returns a job identifier (`JobId`). When
|
1519
|
-
# the search operation finishes, Rekognition Video publishes a
|
1533
|
+
# the search operation finishes, Amazon Rekognition Video publishes a
|
1520
1534
|
# completion status to the Amazon Simple Notification Service topic
|
1521
1535
|
# registered in the initial call to `StartFaceSearch`. To get the search
|
1522
1536
|
# results, first check that the status value published to the Amazon SNS
|
1523
1537
|
# topic is `SUCCEEDED`. If so, call `GetFaceSearch` and pass the job
|
1524
|
-
# identifier (`JobId`) from the initial call to `StartFaceSearch`.
|
1525
|
-
#
|
1538
|
+
# identifier (`JobId`) from the initial call to `StartFaceSearch`.
|
1539
|
+
#
|
1540
|
+
# For more information, see Searching Faces in a Collection in the
|
1541
|
+
# Amazon Rekognition Developer Guide.
|
1526
1542
|
#
|
1527
1543
|
# The search results are retured in an array, `Persons`, of objects.
|
1528
1544
|
# Each`PersonMatch` element contains details about the matching faces in
|
@@ -1533,7 +1549,8 @@ module Aws::Rekognition
|
|
1533
1549
|
# <note markdown="1"> `GetFaceSearch` only returns the default facial attributes
|
1534
1550
|
# (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The
|
1535
1551
|
# other facial attributes listed in the `Face` object of the following
|
1536
|
-
# response syntax are not returned. For more information, see
|
1552
|
+
# response syntax are not returned. For more information, see FaceDetail
|
1553
|
+
# in the Amazon Rekognition Developer Guide.
|
1537
1554
|
#
|
1538
1555
|
# </note>
|
1539
1556
|
#
|
@@ -1553,9 +1570,9 @@ module Aws::Rekognition
|
|
1553
1570
|
#
|
1554
1571
|
# @option params [String] :next_token
|
1555
1572
|
# If the previous response was incomplete (because there is more search
|
1556
|
-
# results to retrieve), Rekognition Video returns a pagination
|
1557
|
-
# the response. You can use this pagination token to retrieve
|
1558
|
-
# set of search results.
|
1573
|
+
# results to retrieve), Amazon Rekognition Video returns a pagination
|
1574
|
+
# token in the response. You can use this pagination token to retrieve
|
1575
|
+
# the next set of search results.
|
1559
1576
|
#
|
1560
1577
|
# @option params [String] :sort_by
|
1561
1578
|
# Sort to use for grouping faces in the response. Use `TIMESTAMP` to
|
@@ -1650,8 +1667,8 @@ module Aws::Rekognition
|
|
1650
1667
|
req.send_request(options)
|
1651
1668
|
end
|
1652
1669
|
|
1653
|
-
# Gets the label detection results of a Rekognition Video
|
1654
|
-
# started by .
|
1670
|
+
# Gets the label detection results of a Amazon Rekognition Video
|
1671
|
+
# analysis started by .
|
1655
1672
|
#
|
1656
1673
|
# The label detection operation is started by a call to which returns a
|
1657
1674
|
# job identifier (`JobId`). When the label detection operation finishes,
|
@@ -1691,9 +1708,9 @@ module Aws::Rekognition
|
|
1691
1708
|
#
|
1692
1709
|
# @option params [String] :next_token
|
1693
1710
|
# If the previous response was incomplete (because there are more labels
|
1694
|
-
# to retrieve), Rekognition Video returns a pagination token in
|
1695
|
-
# response. You can use this pagination token to retrieve the next
|
1696
|
-
# of labels.
|
1711
|
+
# to retrieve), Amazon Rekognition Video returns a pagination token in
|
1712
|
+
# the response. You can use this pagination token to retrieve the next
|
1713
|
+
# set of labels.
|
1697
1714
|
#
|
1698
1715
|
# @option params [String] :sort_by
|
1699
1716
|
# Sort to use for elements in the `Labels` array. Use `TIMESTAMP` to
|
@@ -1742,14 +1759,14 @@ module Aws::Rekognition
|
|
1742
1759
|
req.send_request(options)
|
1743
1760
|
end
|
1744
1761
|
|
1745
|
-
# Gets the person tracking results of a Rekognition Video
|
1746
|
-
# started by .
|
1762
|
+
# Gets the person tracking results of a Amazon Rekognition Video
|
1763
|
+
# analysis started by .
|
1747
1764
|
#
|
1748
1765
|
# The person detection operation is started by a call to
|
1749
1766
|
# `StartPersonTracking` which returns a job identifier (`JobId`). When
|
1750
|
-
# the person detection operation finishes, Rekognition Video
|
1751
|
-
# completion status to the Amazon Simple Notification
|
1752
|
-
# registered in the initial call to `StartPersonTracking`.
|
1767
|
+
# the person detection operation finishes, Amazon Rekognition Video
|
1768
|
+
# publishes a completion status to the Amazon Simple Notification
|
1769
|
+
# Service topic registered in the initial call to `StartPersonTracking`.
|
1753
1770
|
#
|
1754
1771
|
# To get the results of the person tracking operation, first check that
|
1755
1772
|
# the status value published to the Amazon SNS topic is `SUCCEEDED`. If
|
@@ -1762,7 +1779,10 @@ module Aws::Rekognition
|
|
1762
1779
|
# <note markdown="1"> `GetPersonTracking` only returns the default facial attributes
|
1763
1780
|
# (`BoundingBox`, `Confidence`, `Landmarks`, `Pose`, and `Quality`). The
|
1764
1781
|
# other facial attributes listed in the `Face` object of the following
|
1765
|
-
# response syntax are not returned.
|
1782
|
+
# response syntax are not returned.
|
1783
|
+
#
|
1784
|
+
# For more information, see FaceDetail in the Amazon Rekognition
|
1785
|
+
# Developer Guide.
|
1766
1786
|
#
|
1767
1787
|
# </note>
|
1768
1788
|
#
|
@@ -1790,9 +1810,9 @@ module Aws::Rekognition
|
|
1790
1810
|
#
|
1791
1811
|
# @option params [String] :next_token
|
1792
1812
|
# If the previous response was incomplete (because there are more
|
1793
|
-
# persons to retrieve), Rekognition Video returns a pagination
|
1794
|
-
# the response. You can use this pagination token to retrieve
|
1795
|
-
# set of persons.
|
1813
|
+
# persons to retrieve), Amazon Rekognition Video returns a pagination
|
1814
|
+
# token in the response. You can use this pagination token to retrieve
|
1815
|
+
# the next set of persons.
|
1796
1816
|
#
|
1797
1817
|
# @option params [String] :sort_by
|
1798
1818
|
# Sort to use for elements in the `Persons` array. Use `TIMESTAMP` to
|
@@ -1893,8 +1913,10 @@ module Aws::Rekognition
|
|
1893
1913
|
# indexes the 15 largest faces in the input image. Later versions of the
|
1894
1914
|
# face detection model index the 100 largest faces in the input image.
|
1895
1915
|
# To determine which version of the model you are using, check the the
|
1896
|
-
# value of `FaceModelVersion` in the response from `IndexFaces`.
|
1897
|
-
#
|
1916
|
+
# value of `FaceModelVersion` in the response from `IndexFaces`.
|
1917
|
+
#
|
1918
|
+
# For more information, see Model Versioning in the Amazon Rekognition
|
1919
|
+
# Developer Guide.
|
1898
1920
|
#
|
1899
1921
|
# If you provide the optional `ExternalImageID` for the input image you
|
1900
1922
|
# provided, Amazon Rekognition associates this ID with all faces that it
|
@@ -1915,6 +1937,9 @@ module Aws::Rekognition
|
|
1915
1937
|
# the same collection, and use the same external ID in the `IndexFaces`
|
1916
1938
|
# operation, Amazon Rekognition doesn't save duplicate face metadata.
|
1917
1939
|
#
|
1940
|
+
# For more information, see Adding Faces to a Collection in the Amazon
|
1941
|
+
# Rekognition Developer Guide.
|
1942
|
+
#
|
1918
1943
|
# The input image is passed either as base64-encoded image bytes or as a
|
1919
1944
|
# reference to an image in an Amazon S3 bucket. If you use the Amazon
|
1920
1945
|
# CLI to call Amazon Rekognition operations, passing image bytes is not
|
@@ -2171,7 +2196,8 @@ module Aws::Rekognition
|
|
2171
2196
|
# truncated, the response also provides a `NextToken` that you can use
|
2172
2197
|
# in the subsequent request to fetch the next set of collection IDs.
|
2173
2198
|
#
|
2174
|
-
# For an example, see
|
2199
|
+
# For an example, see Listing Collections in the Amazon Rekognition
|
2200
|
+
# Developer Guide.
|
2175
2201
|
#
|
2176
2202
|
# This operation requires permissions to perform the
|
2177
2203
|
# `rekognition:ListCollections` action.
|
@@ -2228,7 +2254,8 @@ module Aws::Rekognition
|
|
2228
2254
|
# Returns metadata for faces in the specified collection. This metadata
|
2229
2255
|
# includes information such as the bounding box coordinates, the
|
2230
2256
|
# confidence (that the bounding box contains a face), and face ID. For
|
2231
|
-
# an example, see
|
2257
|
+
# an example, see Listing Faces in a Collection in the Amazon
|
2258
|
+
# Rekognition Developer Guide.
|
2232
2259
|
#
|
2233
2260
|
# This operation requires permissions to perform the
|
2234
2261
|
# `rekognition:ListFaces` action.
|
@@ -2421,13 +2448,13 @@ module Aws::Rekognition
|
|
2421
2448
|
#
|
2422
2449
|
# @option params [String] :next_token
|
2423
2450
|
# If the previous response was incomplete (because there are more stream
|
2424
|
-
# processors to retrieve), Rekognition Video returns a pagination
|
2425
|
-
# in the response. You can use this pagination token to retrieve
|
2426
|
-
# next set of stream processors.
|
2451
|
+
# processors to retrieve), Amazon Rekognition Video returns a pagination
|
2452
|
+
# token in the response. You can use this pagination token to retrieve
|
2453
|
+
# the next set of stream processors.
|
2427
2454
|
#
|
2428
2455
|
# @option params [Integer] :max_results
|
2429
|
-
# Maximum number of stream processors you want Rekognition Video
|
2430
|
-
# return in the response. The default is 1000.
|
2456
|
+
# Maximum number of stream processors you want Amazon Rekognition Video
|
2457
|
+
# to return in the response. The default is 1000.
|
2431
2458
|
#
|
2432
2459
|
# @return [Types::ListStreamProcessorsResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2433
2460
|
#
|
@@ -2456,7 +2483,8 @@ module Aws::Rekognition
|
|
2456
2483
|
end
|
2457
2484
|
|
2458
2485
|
# Returns an array of celebrities recognized in the input image. For
|
2459
|
-
# more information, see
|
2486
|
+
# more information, see Recognizing Celebrities in the Amazon
|
2487
|
+
# Rekognition Developer Guide.
|
2460
2488
|
#
|
2461
2489
|
# `RecognizeCelebrities` returns the 100 largest faces in the image. It
|
2462
2490
|
# lists recognized celebrities in the `CelebrityFaces` array and
|
@@ -2482,7 +2510,8 @@ module Aws::Rekognition
|
|
2482
2510
|
# CLI to call Amazon Rekognition operations, passing image bytes is not
|
2483
2511
|
# supported. The image must be either a PNG or JPEG formatted file.
|
2484
2512
|
#
|
2485
|
-
# For an example, see
|
2513
|
+
# For an example, see Recognizing Celebrities in an Image in the Amazon
|
2514
|
+
# Rekognition Developer Guide.
|
2486
2515
|
#
|
2487
2516
|
# This operation requires permissions to perform the
|
2488
2517
|
# `rekognition:RecognizeCelebrities` operation.
|
@@ -2575,7 +2604,8 @@ module Aws::Rekognition
|
|
2575
2604
|
# `confidence` value for each face match, indicating the confidence that
|
2576
2605
|
# the specific face matches the input face.
|
2577
2606
|
#
|
2578
|
-
# For an example, see
|
2607
|
+
# For an example, see Searching for a Face Using Its Face ID in the
|
2608
|
+
# Amazon Rekognition Developer Guide.
|
2579
2609
|
#
|
2580
2610
|
# This operation requires permissions to perform the
|
2581
2611
|
# `rekognition:SearchFaces` action.
|
@@ -2722,7 +2752,8 @@ module Aws::Rekognition
|
|
2722
2752
|
# bounding box contains a face) of the face that Amazon Rekognition used
|
2723
2753
|
# for the input image.
|
2724
2754
|
#
|
2725
|
-
# For an example,
|
2755
|
+
# For an example, Searching for a Face Using an Image in the Amazon
|
2756
|
+
# Rekognition Developer Guide.
|
2726
2757
|
#
|
2727
2758
|
# This operation requires permissions to perform the
|
2728
2759
|
# `rekognition:SearchFacesByImage` action.
|
@@ -2839,17 +2870,20 @@ module Aws::Rekognition
|
|
2839
2870
|
|
2840
2871
|
# Starts asynchronous recognition of celebrities in a stored video.
|
2841
2872
|
#
|
2842
|
-
# Rekognition Video can detect celebrities in a video must be
|
2843
|
-
# an Amazon S3 bucket. Use Video to specify the bucket name
|
2844
|
-
# filename of the video. `StartCelebrityRecognition` returns a
|
2845
|
-
# identifier (`JobId`) which you use to get the results of the
|
2846
|
-
# When celebrity recognition analysis is finished,
|
2847
|
-
# publishes a completion status to the Amazon Simple
|
2848
|
-
# Service topic that you specify in `NotificationChannel`.
|
2849
|
-
# results of the celebrity recognition analysis, first check
|
2850
|
-
# status value published to the Amazon SNS topic is
|
2851
|
-
# call and pass the job identifier (`JobId`) from
|
2852
|
-
#
|
2873
|
+
# Amazon Rekognition Video can detect celebrities in a video must be
|
2874
|
+
# stored in an Amazon S3 bucket. Use Video to specify the bucket name
|
2875
|
+
# and the filename of the video. `StartCelebrityRecognition` returns a
|
2876
|
+
# job identifier (`JobId`) which you use to get the results of the
|
2877
|
+
# analysis. When celebrity recognition analysis is finished, Amazon
|
2878
|
+
# Rekognition Video publishes a completion status to the Amazon Simple
|
2879
|
+
# Notification Service topic that you specify in `NotificationChannel`.
|
2880
|
+
# To get the results of the celebrity recognition analysis, first check
|
2881
|
+
# that the status value published to the Amazon SNS topic is
|
2882
|
+
# `SUCCEEDED`. If so, call and pass the job identifier (`JobId`) from
|
2883
|
+
# the initial call to `StartCelebrityRecognition`.
|
2884
|
+
#
|
2885
|
+
# For more information, see Recognizing Celebrities in the Amazon
|
2886
|
+
# Rekognition Developer Guide.
|
2853
2887
|
#
|
2854
2888
|
# @option params [required, Types::Video] :video
|
2855
2889
|
# The video in which you want to recognize celebrities. The video must
|
@@ -2862,8 +2896,9 @@ module Aws::Rekognition
|
|
2862
2896
|
# job from being accidently started more than once.
|
2863
2897
|
#
|
2864
2898
|
# @option params [Types::NotificationChannel] :notification_channel
|
2865
|
-
# The Amazon SNS topic ARN that you want Rekognition Video to
|
2866
|
-
# the completion status of the celebrity recognition analysis
|
2899
|
+
# The Amazon SNS topic ARN that you want Amazon Rekognition Video to
|
2900
|
+
# publish the completion status of the celebrity recognition analysis
|
2901
|
+
# to.
|
2867
2902
|
#
|
2868
2903
|
# @option params [String] :job_tag
|
2869
2904
|
# Unique identifier you specify to identify the job in the completion
|
@@ -2905,19 +2940,21 @@ module Aws::Rekognition
|
|
2905
2940
|
# Starts asynchronous detection of explicit or suggestive adult content
|
2906
2941
|
# in a stored video.
|
2907
2942
|
#
|
2908
|
-
# Rekognition Video can moderate content in a video stored in an
|
2909
|
-
# S3 bucket. Use Video to specify the bucket name and the
|
2910
|
-
# the video. `StartContentModeration` returns a job
|
2911
|
-
# which you use to get the results of the analysis.
|
2912
|
-
# moderation analysis is finished, Rekognition Video
|
2913
|
-
# completion status to the Amazon Simple Notification
|
2914
|
-
# you specify in `NotificationChannel`.
|
2943
|
+
# Amazon Rekognition Video can moderate content in a video stored in an
|
2944
|
+
# Amazon S3 bucket. Use Video to specify the bucket name and the
|
2945
|
+
# filename of the video. `StartContentModeration` returns a job
|
2946
|
+
# identifier (`JobId`) which you use to get the results of the analysis.
|
2947
|
+
# When content moderation analysis is finished, Amazon Rekognition Video
|
2948
|
+
# publishes a completion status to the Amazon Simple Notification
|
2949
|
+
# Service topic that you specify in `NotificationChannel`.
|
2915
2950
|
#
|
2916
2951
|
# To get the results of the content moderation analysis, first check
|
2917
2952
|
# that the status value published to the Amazon SNS topic is
|
2918
2953
|
# `SUCCEEDED`. If so, call and pass the job identifier (`JobId`) from
|
2919
|
-
# the initial call to `StartContentModeration`.
|
2920
|
-
#
|
2954
|
+
# the initial call to `StartContentModeration`.
|
2955
|
+
#
|
2956
|
+
# For more information, see Detecting Unsafe Content in the Amazon
|
2957
|
+
# Rekognition Developer Guide.
|
2921
2958
|
#
|
2922
2959
|
# @option params [required, Types::Video] :video
|
2923
2960
|
# The video in which you want to moderate content. The video must be
|
@@ -2938,8 +2975,8 @@ module Aws::Rekognition
|
|
2938
2975
|
# from being accidently started more than once.
|
2939
2976
|
#
|
2940
2977
|
# @option params [Types::NotificationChannel] :notification_channel
|
2941
|
-
# The Amazon SNS topic ARN that you want Rekognition Video to
|
2942
|
-
# the completion status of the content moderation analysis to.
|
2978
|
+
# The Amazon SNS topic ARN that you want Amazon Rekognition Video to
|
2979
|
+
# publish the completion status of the content moderation analysis to.
|
2943
2980
|
#
|
2944
2981
|
# @option params [String] :job_tag
|
2945
2982
|
# Unique identifier you specify to identify the job in the completion
|
@@ -2981,17 +3018,19 @@ module Aws::Rekognition
|
|
2981
3018
|
|
2982
3019
|
# Starts asynchronous detection of faces in a stored video.
|
2983
3020
|
#
|
2984
|
-
# Rekognition Video can detect faces in a video stored in an
|
2985
|
-
# bucket. Use Video to specify the bucket name and the
|
2986
|
-
# video. `StartFaceDetection` returns a job identifier
|
2987
|
-
# you use to get the results of the operation. When face
|
2988
|
-
# finished, Rekognition Video publishes a completion
|
2989
|
-
# Amazon Simple Notification Service topic that you
|
2990
|
-
# `NotificationChannel`. To get the results of the label
|
2991
|
-
# operation, first check that the status value published to
|
2992
|
-
# SNS topic is `SUCCEEDED`. If so, call and pass the job
|
2993
|
-
# (`JobId`) from the initial call to `StartFaceDetection`.
|
2994
|
-
#
|
3021
|
+
# Amazon Rekognition Video can detect faces in a video stored in an
|
3022
|
+
# Amazon S3 bucket. Use Video to specify the bucket name and the
|
3023
|
+
# filename of the video. `StartFaceDetection` returns a job identifier
|
3024
|
+
# (`JobId`) that you use to get the results of the operation. When face
|
3025
|
+
# detection is finished, Amazon Rekognition Video publishes a completion
|
3026
|
+
# status to the Amazon Simple Notification Service topic that you
|
3027
|
+
# specify in `NotificationChannel`. To get the results of the label
|
3028
|
+
# detection operation, first check that the status value published to
|
3029
|
+
# the Amazon SNS topic is `SUCCEEDED`. If so, call and pass the job
|
3030
|
+
# identifier (`JobId`) from the initial call to `StartFaceDetection`.
|
3031
|
+
#
|
3032
|
+
# For more information, see Detecting Faces in a Stored Video in the
|
3033
|
+
# Amazon Rekognition Developer Guide.
|
2995
3034
|
#
|
2996
3035
|
# @option params [required, Types::Video] :video
|
2997
3036
|
# The video in which you want to detect faces. The video must be stored
|
@@ -3004,8 +3043,9 @@ module Aws::Rekognition
|
|
3004
3043
|
# from being accidently started more than once.
|
3005
3044
|
#
|
3006
3045
|
# @option params [Types::NotificationChannel] :notification_channel
|
3007
|
-
# The ARN of the Amazon SNS topic to which you want Rekognition
|
3008
|
-
# publish the completion status of the face detection
|
3046
|
+
# The ARN of the Amazon SNS topic to which you want Amazon Rekognition
|
3047
|
+
# Video to publish the completion status of the face detection
|
3048
|
+
# operation.
|
3009
3049
|
#
|
3010
3050
|
# @option params [String] :face_attributes
|
3011
3051
|
# The face attributes you want returned.
|
@@ -3060,12 +3100,13 @@ module Aws::Rekognition
|
|
3060
3100
|
# the bucket name and the filename of the video. `StartFaceSearch`
|
3061
3101
|
# returns a job identifier (`JobId`) which you use to get the search
|
3062
3102
|
# results once the search has completed. When searching is finished,
|
3063
|
-
# Rekognition Video publishes a completion status to the Amazon
|
3064
|
-
# Notification Service topic that you specify in
|
3065
|
-
# To get the search results, first check that the
|
3066
|
-
# to the Amazon SNS topic is `SUCCEEDED`. If so,
|
3067
|
-
# identifier (`JobId`) from the initial call to
|
3068
|
-
# more information, see
|
3103
|
+
# Amazon Rekognition Video publishes a completion status to the Amazon
|
3104
|
+
# Simple Notification Service topic that you specify in
|
3105
|
+
# `NotificationChannel`. To get the search results, first check that the
|
3106
|
+
# status value published to the Amazon SNS topic is `SUCCEEDED`. If so,
|
3107
|
+
# call and pass the job identifier (`JobId`) from the initial call to
|
3108
|
+
# `StartFaceSearch`. For more information, see
|
3109
|
+
# collections-search-person.
|
3069
3110
|
#
|
3070
3111
|
# @option params [required, Types::Video] :video
|
3071
3112
|
# The video you want to search. The video must be stored in an Amazon S3
|
@@ -3086,8 +3127,8 @@ module Aws::Rekognition
|
|
3086
3127
|
# ID of the collection that contains the faces you want to search for.
|
3087
3128
|
#
|
3088
3129
|
# @option params [Types::NotificationChannel] :notification_channel
|
3089
|
-
# The ARN of the Amazon SNS topic to which you want Rekognition
|
3090
|
-
# publish the completion status of the search.
|
3130
|
+
# The ARN of the Amazon SNS topic to which you want Amazon Rekognition
|
3131
|
+
# Video to publish the completion status of the search.
|
3091
3132
|
#
|
3092
3133
|
# @option params [String] :job_tag
|
3093
3134
|
# Unique identifier you specify to identify the job in the completion
|
@@ -3130,17 +3171,17 @@ module Aws::Rekognition
|
|
3130
3171
|
|
3131
3172
|
# Starts asynchronous detection of labels in a stored video.
|
3132
3173
|
#
|
3133
|
-
# Rekognition Video can detect labels in a video. Labels are
|
3134
|
-
# of real-world entities. This includes objects like flower,
|
3135
|
-
# table; events like wedding, graduation, and birthday party;
|
3136
|
-
# like landscape, evening, and nature; and activities like a
|
3137
|
-
# getting out of a car or a person skiing.
|
3174
|
+
# Amazon Rekognition Video can detect labels in a video. Labels are
|
3175
|
+
# instances of real-world entities. This includes objects like flower,
|
3176
|
+
# tree, and table; events like wedding, graduation, and birthday party;
|
3177
|
+
# concepts like landscape, evening, and nature; and activities like a
|
3178
|
+
# person getting out of a car or a person skiing.
|
3138
3179
|
#
|
3139
3180
|
# The video must be stored in an Amazon S3 bucket. Use Video to specify
|
3140
3181
|
# the bucket name and the filename of the video. `StartLabelDetection`
|
3141
3182
|
# returns a job identifier (`JobId`) which you use to get the results of
|
3142
|
-
# the operation. When label detection is finished, Rekognition
|
3143
|
-
# publishes a completion status to the Amazon Simple Notification
|
3183
|
+
# the operation. When label detection is finished, Amazon Rekognition
|
3184
|
+
# Video publishes a completion status to the Amazon Simple Notification
|
3144
3185
|
# Service topic that you specify in `NotificationChannel`.
|
3145
3186
|
#
|
3146
3187
|
# To get the results of the label detection operation, first check that
|
@@ -3159,19 +3200,19 @@ module Aws::Rekognition
|
|
3159
3200
|
# from being accidently started more than once.
|
3160
3201
|
#
|
3161
3202
|
# @option params [Float] :min_confidence
|
3162
|
-
# Specifies the minimum confidence that Rekognition Video must
|
3163
|
-
# order to return a detected label. Confidence represents how
|
3164
|
-
# Amazon Rekognition is that a label is correctly identified.0
|
3165
|
-
# lowest confidence. 100 is the highest confidence.
|
3166
|
-
# doesn't return any labels with a confidence level
|
3167
|
-
# specified value.
|
3203
|
+
# Specifies the minimum confidence that Amazon Rekognition Video must
|
3204
|
+
# have in order to return a detected label. Confidence represents how
|
3205
|
+
# certain Amazon Rekognition is that a label is correctly identified.0
|
3206
|
+
# is the lowest confidence. 100 is the highest confidence. Amazon
|
3207
|
+
# Rekognition Video doesn't return any labels with a confidence level
|
3208
|
+
# lower than this specified value.
|
3168
3209
|
#
|
3169
3210
|
# If you don't specify `MinConfidence`, the operation returns labels
|
3170
3211
|
# with confidence values greater than or equal to 50 percent.
|
3171
3212
|
#
|
3172
3213
|
# @option params [Types::NotificationChannel] :notification_channel
|
3173
|
-
# The Amazon SNS topic ARN you want Rekognition Video to publish
|
3174
|
-
# completion status of the label detection operation to.
|
3214
|
+
# The Amazon SNS topic ARN you want Amazon Rekognition Video to publish
|
3215
|
+
# the completion status of the label detection operation to.
|
3175
3216
|
#
|
3176
3217
|
# @option params [String] :job_tag
|
3177
3218
|
# Unique identifier you specify to identify the job in the completion
|
@@ -3213,13 +3254,13 @@ module Aws::Rekognition
|
|
3213
3254
|
|
3214
3255
|
# Starts the asynchronous tracking of persons in a stored video.
|
3215
3256
|
#
|
3216
|
-
# Rekognition Video can track persons in a video stored in an
|
3217
|
-
# bucket. Use Video to specify the bucket name and the
|
3218
|
-
# video. `StartPersonTracking` returns a job identifier
|
3219
|
-
# you use to get the results of the operation. When
|
3220
|
-
# finished, Amazon Rekognition publishes a completion
|
3221
|
-
# Amazon Simple Notification Service topic that you
|
3222
|
-
# `NotificationChannel`.
|
3257
|
+
# Amazon Rekognition Video can track persons in a video stored in an
|
3258
|
+
# Amazon S3 bucket. Use Video to specify the bucket name and the
|
3259
|
+
# filename of the video. `StartPersonTracking` returns a job identifier
|
3260
|
+
# (`JobId`) which you use to get the results of the operation. When
|
3261
|
+
# label detection is finished, Amazon Rekognition publishes a completion
|
3262
|
+
# status to the Amazon Simple Notification Service topic that you
|
3263
|
+
# specify in `NotificationChannel`.
|
3223
3264
|
#
|
3224
3265
|
# To get the results of the person detection operation, first check that
|
3225
3266
|
# the status value published to the Amazon SNS topic is `SUCCEEDED`. If
|
@@ -3237,8 +3278,8 @@ module Aws::Rekognition
|
|
3237
3278
|
# from being accidently started more than once.
|
3238
3279
|
#
|
3239
3280
|
# @option params [Types::NotificationChannel] :notification_channel
|
3240
|
-
# The Amazon SNS topic ARN you want Rekognition Video to publish
|
3241
|
-
# completion status of the people detection operation to.
|
3281
|
+
# The Amazon SNS topic ARN you want Amazon Rekognition Video to publish
|
3282
|
+
# the completion status of the people detection operation to.
|
3242
3283
|
#
|
3243
3284
|
# @option params [String] :job_tag
|
3244
3285
|
# Unique identifier you specify to identify the job in the completion
|
@@ -3333,7 +3374,7 @@ module Aws::Rekognition
|
|
3333
3374
|
params: params,
|
3334
3375
|
config: config)
|
3335
3376
|
context[:gem_name] = 'aws-sdk-rekognition'
|
3336
|
-
context[:gem_version] = '1.
|
3377
|
+
context[:gem_version] = '1.4.0'
|
3337
3378
|
Seahorse::Client::Request.new(handlers, context)
|
3338
3379
|
end
|
3339
3380
|
|
@@ -170,7 +170,8 @@ module Aws::Rekognition
|
|
170
170
|
end
|
171
171
|
|
172
172
|
# Information about a detected celebrity and the time the celebrity was
|
173
|
-
# detected in a stored video. For more information, see
|
173
|
+
# detected in a stored video. For more information, see
|
174
|
+
# GetCelebrityRecognition in the Amazon Rekognition Developer Guide.
|
174
175
|
#
|
175
176
|
# @!attribute [rw] timestamp
|
176
177
|
# The time, in milliseconds from the start of the video, that the
|
@@ -455,9 +456,9 @@ module Aws::Rekognition
|
|
455
456
|
# @return [Types::StreamProcessorInput]
|
456
457
|
#
|
457
458
|
# @!attribute [rw] output
|
458
|
-
# Kinesis data stream stream to which Rekognition Video puts
|
459
|
-
# analysis results. If you are using the AWS CLI, the parameter
|
460
|
-
# is `StreamProcessorOutput`.
|
459
|
+
# Kinesis data stream stream to which Amazon Rekognition Video puts
|
460
|
+
# the analysis results. If you are using the AWS CLI, the parameter
|
461
|
+
# name is `StreamProcessorOutput`.
|
461
462
|
# @return [Types::StreamProcessorOutput]
|
462
463
|
#
|
463
464
|
# @!attribute [rw] name
|
@@ -615,8 +616,8 @@ module Aws::Rekognition
|
|
615
616
|
# @return [Types::StreamProcessorInput]
|
616
617
|
#
|
617
618
|
# @!attribute [rw] output
|
618
|
-
# Kinesis data stream to which Rekognition Video puts the
|
619
|
-
# results.
|
619
|
+
# Kinesis data stream to which Amazon Rekognition Video puts the
|
620
|
+
# analysis results.
|
620
621
|
# @return [Types::StreamProcessorOutput]
|
621
622
|
#
|
622
623
|
# @!attribute [rw] role_arn
|
@@ -953,11 +954,11 @@ module Aws::Rekognition
|
|
953
954
|
# all facial attributes. The default attributes are `BoundingBox`,
|
954
955
|
# `Confidence`, `Landmarks`, `Pose`, and `Quality`.
|
955
956
|
#
|
956
|
-
# is the only Rekognition Video stored video operation that can
|
957
|
-
# `FaceDetail` object with all attributes. To specify which
|
958
|
-
# to return, use the `FaceAttributes` input parameter for .
|
959
|
-
# following Rekognition Video operations return only the
|
960
|
-
# attributes. The corresponding Start operations don't have a
|
957
|
+
# is the only Amazon Rekognition Video stored video operation that can
|
958
|
+
# return a `FaceDetail` object with all attributes. To specify which
|
959
|
+
# attributes to return, use the `FaceAttributes` input parameter for .
|
960
|
+
# The following Amazon Rekognition Video operations return only the
|
961
|
+
# default attributes. The corresponding Start operations don't have a
|
961
962
|
# `FaceAttributes` input parameter.
|
962
963
|
#
|
963
964
|
# * GetCelebrityRecognition
|
@@ -966,10 +967,10 @@ module Aws::Rekognition
|
|
966
967
|
#
|
967
968
|
# * GetFaceSearch
|
968
969
|
#
|
969
|
-
# The Rekognition Image and operations can return all facial
|
970
|
-
# To specify which attributes to return, use the
|
971
|
-
# parameter for `DetectFaces`. For `IndexFaces`, use
|
972
|
-
# `DetectAttributes` input parameter.
|
970
|
+
# The Amazon Rekognition Image and operations can return all facial
|
971
|
+
# attributes. To specify which attributes to return, use the
|
972
|
+
# `Attributes` input parameter for `DetectFaces`. For `IndexFaces`, use
|
973
|
+
# the `DetectAttributes` input parameter.
|
973
974
|
#
|
974
975
|
# @!attribute [rw] bounding_box
|
975
976
|
# Bounding box of the face. Default attribute.
|
@@ -1237,9 +1238,9 @@ module Aws::Rekognition
|
|
1237
1238
|
#
|
1238
1239
|
# @!attribute [rw] next_token
|
1239
1240
|
# If the previous response was incomplete (because there is more
|
1240
|
-
# recognized celebrities to retrieve), Rekognition Video
|
1241
|
-
# pagination token in the response. You can use this
|
1242
|
-
# to retrieve the next set of celebrities.
|
1241
|
+
# recognized celebrities to retrieve), Amazon Rekognition Video
|
1242
|
+
# returns a pagination token in the response. You can use this
|
1243
|
+
# pagination token to retrieve the next set of celebrities.
|
1243
1244
|
# @return [String]
|
1244
1245
|
#
|
1245
1246
|
# @!attribute [rw] sort_by
|
@@ -1266,15 +1267,15 @@ module Aws::Rekognition
|
|
1266
1267
|
# @return [String]
|
1267
1268
|
#
|
1268
1269
|
# @!attribute [rw] video_metadata
|
1269
|
-
# Information about a video that Rekognition Video analyzed.
|
1270
|
+
# Information about a video that Amazon Rekognition Video analyzed.
|
1270
1271
|
# `Videometadata` is returned in every page of paginated responses
|
1271
|
-
# from a Rekognition Video operation.
|
1272
|
+
# from a Amazon Rekognition Video operation.
|
1272
1273
|
# @return [Types::VideoMetadata]
|
1273
1274
|
#
|
1274
1275
|
# @!attribute [rw] next_token
|
1275
|
-
# If the response is truncated, Rekognition Video returns this
|
1276
|
-
# that you can use in the subsequent request to retrieve the
|
1277
|
-
# of celebrities.
|
1276
|
+
# If the response is truncated, Amazon Rekognition Video returns this
|
1277
|
+
# token that you can use in the subsequent request to retrieve the
|
1278
|
+
# next set of celebrities.
|
1278
1279
|
# @return [String]
|
1279
1280
|
#
|
1280
1281
|
# @!attribute [rw] celebrities
|
@@ -1355,9 +1356,9 @@ module Aws::Rekognition
|
|
1355
1356
|
# @return [Array<Types::ContentModerationDetection>]
|
1356
1357
|
#
|
1357
1358
|
# @!attribute [rw] next_token
|
1358
|
-
# If the response is truncated, Rekognition Video returns this
|
1359
|
-
# that you can use in the subsequent request to retrieve the
|
1360
|
-
# of moderation labels.
|
1359
|
+
# If the response is truncated, Amazon Rekognition Video returns this
|
1360
|
+
# token that you can use in the subsequent request to retrieve the
|
1361
|
+
# next set of moderation labels.
|
1361
1362
|
# @return [String]
|
1362
1363
|
#
|
1363
1364
|
class GetContentModerationResponse < Struct.new(
|
@@ -1392,9 +1393,9 @@ module Aws::Rekognition
|
|
1392
1393
|
#
|
1393
1394
|
# @!attribute [rw] next_token
|
1394
1395
|
# If the previous response was incomplete (because there are more
|
1395
|
-
# faces to retrieve), Rekognition Video returns a pagination
|
1396
|
-
# the response. You can use this pagination token to retrieve
|
1397
|
-
# set of faces.
|
1396
|
+
# faces to retrieve), Amazon Rekognition Video returns a pagination
|
1397
|
+
# token in the response. You can use this pagination token to retrieve
|
1398
|
+
# the next set of faces.
|
1398
1399
|
# @return [String]
|
1399
1400
|
#
|
1400
1401
|
class GetFaceDetectionRequest < Struct.new(
|
@@ -1414,7 +1415,7 @@ module Aws::Rekognition
|
|
1414
1415
|
# @return [String]
|
1415
1416
|
#
|
1416
1417
|
# @!attribute [rw] video_metadata
|
1417
|
-
# Information about a video that Rekognition Video analyzed.
|
1418
|
+
# Information about a video that Amazon Rekognition Video analyzed.
|
1418
1419
|
# `Videometadata` is returned in every page of paginated responses
|
1419
1420
|
# from a Amazon Rekognition video operation.
|
1420
1421
|
# @return [Types::VideoMetadata]
|
@@ -1464,9 +1465,9 @@ module Aws::Rekognition
|
|
1464
1465
|
#
|
1465
1466
|
# @!attribute [rw] next_token
|
1466
1467
|
# If the previous response was incomplete (because there is more
|
1467
|
-
# search results to retrieve), Rekognition Video returns a
|
1468
|
-
# token in the response. You can use this pagination token
|
1469
|
-
# the next set of search results.
|
1468
|
+
# search results to retrieve), Amazon Rekognition Video returns a
|
1469
|
+
# pagination token in the response. You can use this pagination token
|
1470
|
+
# to retrieve the next set of search results.
|
1470
1471
|
# @return [String]
|
1471
1472
|
#
|
1472
1473
|
# @!attribute [rw] sort_by
|
@@ -1493,15 +1494,15 @@ module Aws::Rekognition
|
|
1493
1494
|
# @return [String]
|
1494
1495
|
#
|
1495
1496
|
# @!attribute [rw] next_token
|
1496
|
-
# If the response is truncated, Rekognition Video returns this
|
1497
|
-
# that you can use in the subsequent request to retrieve the
|
1498
|
-
# of search results.
|
1497
|
+
# If the response is truncated, Amazon Rekognition Video returns this
|
1498
|
+
# token that you can use in the subsequent request to retrieve the
|
1499
|
+
# next set of search results.
|
1499
1500
|
# @return [String]
|
1500
1501
|
#
|
1501
1502
|
# @!attribute [rw] video_metadata
|
1502
1503
|
# Information about a video that Amazon Rekognition analyzed.
|
1503
1504
|
# `Videometadata` is returned in every page of paginated responses
|
1504
|
-
# from a Rekognition Video operation.
|
1505
|
+
# from a Amazon Rekognition Video operation.
|
1505
1506
|
# @return [Types::VideoMetadata]
|
1506
1507
|
#
|
1507
1508
|
# @!attribute [rw] persons
|
@@ -1548,9 +1549,9 @@ module Aws::Rekognition
|
|
1548
1549
|
#
|
1549
1550
|
# @!attribute [rw] next_token
|
1550
1551
|
# If the previous response was incomplete (because there are more
|
1551
|
-
# labels to retrieve), Rekognition Video returns a pagination
|
1552
|
-
# the response. You can use this pagination token to retrieve
|
1553
|
-
# set of labels.
|
1552
|
+
# labels to retrieve), Amazon Rekognition Video returns a pagination
|
1553
|
+
# token in the response. You can use this pagination token to retrieve
|
1554
|
+
# the next set of labels.
|
1554
1555
|
# @return [String]
|
1555
1556
|
#
|
1556
1557
|
# @!attribute [rw] sort_by
|
@@ -1579,15 +1580,15 @@ module Aws::Rekognition
|
|
1579
1580
|
# @return [String]
|
1580
1581
|
#
|
1581
1582
|
# @!attribute [rw] video_metadata
|
1582
|
-
# Information about a video that Rekognition Video analyzed.
|
1583
|
+
# Information about a video that Amazon Rekognition Video analyzed.
|
1583
1584
|
# `Videometadata` is returned in every page of paginated responses
|
1584
1585
|
# from a Amazon Rekognition video operation.
|
1585
1586
|
# @return [Types::VideoMetadata]
|
1586
1587
|
#
|
1587
1588
|
# @!attribute [rw] next_token
|
1588
|
-
# If the response is truncated, Rekognition Video returns this
|
1589
|
-
# that you can use in the subsequent request to retrieve the
|
1590
|
-
# of labels.
|
1589
|
+
# If the response is truncated, Amazon Rekognition Video returns this
|
1590
|
+
# token that you can use in the subsequent request to retrieve the
|
1591
|
+
# next set of labels.
|
1591
1592
|
# @return [String]
|
1592
1593
|
#
|
1593
1594
|
# @!attribute [rw] labels
|
@@ -1629,9 +1630,9 @@ module Aws::Rekognition
|
|
1629
1630
|
#
|
1630
1631
|
# @!attribute [rw] next_token
|
1631
1632
|
# If the previous response was incomplete (because there are more
|
1632
|
-
# persons to retrieve), Rekognition Video returns a pagination
|
1633
|
-
# in the response. You can use this pagination token to retrieve
|
1634
|
-
# next set of persons.
|
1633
|
+
# persons to retrieve), Amazon Rekognition Video returns a pagination
|
1634
|
+
# token in the response. You can use this pagination token to retrieve
|
1635
|
+
# the next set of persons.
|
1635
1636
|
# @return [String]
|
1636
1637
|
#
|
1637
1638
|
# @!attribute [rw] sort_by
|
@@ -1660,15 +1661,15 @@ module Aws::Rekognition
|
|
1660
1661
|
# @return [String]
|
1661
1662
|
#
|
1662
1663
|
# @!attribute [rw] video_metadata
|
1663
|
-
# Information about a video that Rekognition Video analyzed.
|
1664
|
+
# Information about a video that Amazon Rekognition Video analyzed.
|
1664
1665
|
# `Videometadata` is returned in every page of paginated responses
|
1665
|
-
# from a Rekognition Video operation.
|
1666
|
+
# from a Amazon Rekognition Video operation.
|
1666
1667
|
# @return [Types::VideoMetadata]
|
1667
1668
|
#
|
1668
1669
|
# @!attribute [rw] next_token
|
1669
|
-
# If the response is truncated, Rekognition Video returns this
|
1670
|
-
# that you can use in the subsequent request to retrieve the
|
1671
|
-
# of persons.
|
1670
|
+
# If the response is truncated, Amazon Rekognition Video returns this
|
1671
|
+
# token that you can use in the subsequent request to retrieve the
|
1672
|
+
# next set of persons.
|
1672
1673
|
# @return [String]
|
1673
1674
|
#
|
1674
1675
|
# @!attribute [rw] persons
|
@@ -1693,7 +1694,10 @@ module Aws::Rekognition
|
|
1693
1694
|
# pass an image loaded from a local file system. Image bytes passed by
|
1694
1695
|
# using the `Bytes` property must be base64-encoded. Your code may not
|
1695
1696
|
# need to encode image bytes if you are using an AWS SDK to call
|
1696
|
-
# Rekognition API operations.
|
1697
|
+
# Rekognition API operations.
|
1698
|
+
#
|
1699
|
+
# For more information, see Analyzing an Image Loaded from a Local File
|
1700
|
+
# System in the Amazon Rekognition Developer Guide.
|
1697
1701
|
#
|
1698
1702
|
# You pass images stored in an S3 bucket to a Rekognition API operation
|
1699
1703
|
# by using the `S3Object` property. Images stored in an S3 bucket do not
|
@@ -1708,8 +1712,8 @@ module Aws::Rekognition
|
|
1708
1712
|
# operation using the S3Object property.
|
1709
1713
|
#
|
1710
1714
|
# For Amazon Rekognition to process an S3 object, the user must have
|
1711
|
-
# permission to access the S3 object. For more information, see
|
1712
|
-
#
|
1715
|
+
# permission to access the S3 object. For more information, see Resource
|
1716
|
+
# Based Policies in the Amazon Rekognition Developer Guide.
|
1713
1717
|
#
|
1714
1718
|
# @note When making an API call, you may pass Image
|
1715
1719
|
# data as a hash:
|
@@ -1813,7 +1817,8 @@ module Aws::Rekognition
|
|
1813
1817
|
|
1814
1818
|
# @!attribute [rw] face_records
|
1815
1819
|
# An array of faces detected and added to the collection. For more
|
1816
|
-
# information, see
|
1820
|
+
# information, see Searching Faces in a Collection in the Amazon
|
1821
|
+
# Rekognition Developer Guide.
|
1817
1822
|
# @return [Array<Types::FaceRecord>]
|
1818
1823
|
#
|
1819
1824
|
# @!attribute [rw] orientation_correction
|
@@ -1847,7 +1852,8 @@ module Aws::Rekognition
|
|
1847
1852
|
|
1848
1853
|
# The Kinesis data stream Amazon Rekognition to which the analysis
|
1849
1854
|
# results of a Amazon Rekognition stream processor are streamed. For
|
1850
|
-
# more information, see
|
1855
|
+
# more information, see CreateStreamProcessor in the Amazon Rekognition
|
1856
|
+
# Developer Guide.
|
1851
1857
|
#
|
1852
1858
|
# @note When making an API call, you may pass KinesisDataStream
|
1853
1859
|
# data as a hash:
|
@@ -1866,7 +1872,8 @@ module Aws::Rekognition
|
|
1866
1872
|
end
|
1867
1873
|
|
1868
1874
|
# Kinesis video stream stream that provides the source streaming video
|
1869
|
-
# for a Rekognition Video stream processor. For more information,
|
1875
|
+
# for a Amazon Rekognition Video stream processor. For more information,
|
1876
|
+
# see CreateStreamProcessor in the Amazon Rekognition Developer Guide.
|
1870
1877
|
#
|
1871
1878
|
# @note When making an API call, you may pass KinesisVideoStream
|
1872
1879
|
# data as a hash:
|
@@ -2056,14 +2063,14 @@ module Aws::Rekognition
|
|
2056
2063
|
#
|
2057
2064
|
# @!attribute [rw] next_token
|
2058
2065
|
# If the previous response was incomplete (because there are more
|
2059
|
-
# stream processors to retrieve), Rekognition Video returns a
|
2066
|
+
# stream processors to retrieve), Amazon Rekognition Video returns a
|
2060
2067
|
# pagination token in the response. You can use this pagination token
|
2061
2068
|
# to retrieve the next set of stream processors.
|
2062
2069
|
# @return [String]
|
2063
2070
|
#
|
2064
2071
|
# @!attribute [rw] max_results
|
2065
|
-
# Maximum number of stream processors you want Rekognition
|
2066
|
-
# return in the response. The default is 1000.
|
2072
|
+
# Maximum number of stream processors you want Amazon Rekognition
|
2073
|
+
# Video to return in the response. The default is 1000.
|
2067
2074
|
# @return [Integer]
|
2068
2075
|
#
|
2069
2076
|
class ListStreamProcessorsRequest < Struct.new(
|
@@ -2073,9 +2080,9 @@ module Aws::Rekognition
|
|
2073
2080
|
end
|
2074
2081
|
|
2075
2082
|
# @!attribute [rw] next_token
|
2076
|
-
# If the response is truncated, Rekognition Video returns this
|
2077
|
-
# that you can use in the subsequent request to retrieve the
|
2078
|
-
# of stream processors.
|
2083
|
+
# If the response is truncated, Amazon Rekognition Video returns this
|
2084
|
+
# token that you can use in the subsequent request to retrieve the
|
2085
|
+
# next set of stream processors.
|
2079
2086
|
# @return [String]
|
2080
2087
|
#
|
2081
2088
|
# @!attribute [rw] stream_processors
|
@@ -2090,7 +2097,8 @@ module Aws::Rekognition
|
|
2090
2097
|
|
2091
2098
|
# Provides information about a single type of moderated content found in
|
2092
2099
|
# an image or video. Each type of moderated content has a label within a
|
2093
|
-
# hierarchical taxonomy. For more information, see
|
2100
|
+
# hierarchical taxonomy. For more information, see Detecting Unsafe
|
2101
|
+
# Content in the Amazon Rekognition Developer Guide.
|
2094
2102
|
#
|
2095
2103
|
# @!attribute [rw] confidence
|
2096
2104
|
# Specifies the confidence that Amazon Rekognition has that the label
|
@@ -2206,7 +2214,10 @@ module Aws::Rekognition
|
|
2206
2214
|
# Details and tracking information for a single time a person is tracked
|
2207
2215
|
# in a video. Amazon Rekognition operations that track persons return an
|
2208
2216
|
# array of `PersonDetection` objects with elements for each time a
|
2209
|
-
# person is tracked in a video.
|
2217
|
+
# person is tracked in a video.
|
2218
|
+
#
|
2219
|
+
# For more information, see API\_GetPersonTracking in the Amazon
|
2220
|
+
# Rekognition Developer Guide.
|
2210
2221
|
#
|
2211
2222
|
# @!attribute [rw] timestamp
|
2212
2223
|
# The time, in milliseconds from the start of the video, that the
|
@@ -2257,7 +2268,7 @@ module Aws::Rekognition
|
|
2257
2268
|
#
|
2258
2269
|
# An array of `Point` objects, `Polygon`, is returned by . `Polygon`
|
2259
2270
|
# represents a fine-grained polygon around detected text. For more
|
2260
|
-
# information, see .
|
2271
|
+
# information, see Geometry in the Amazon Rekognition Developer Guide.
|
2261
2272
|
#
|
2262
2273
|
# @!attribute [rw] x
|
2263
2274
|
# The value of the X coordinate for a point on a `Polygon`.
|
@@ -2361,8 +2372,8 @@ module Aws::Rekognition
|
|
2361
2372
|
# region you use for Amazon Rekognition operations.
|
2362
2373
|
#
|
2363
2374
|
# For Amazon Rekognition to process an S3 object, the user must have
|
2364
|
-
# permission to access the S3 object. For more information, see
|
2365
|
-
#
|
2375
|
+
# permission to access the S3 object. For more information, see Resource
|
2376
|
+
# Based Policies in the Amazon Rekognition Developer Guide.
|
2366
2377
|
#
|
2367
2378
|
# @note When making an API call, you may pass S3Object
|
2368
2379
|
# data as a hash:
|
@@ -2574,8 +2585,9 @@ module Aws::Rekognition
|
|
2574
2585
|
# @return [String]
|
2575
2586
|
#
|
2576
2587
|
# @!attribute [rw] notification_channel
|
2577
|
-
# The Amazon SNS topic ARN that you want Rekognition Video to
|
2578
|
-
# the completion status of the celebrity recognition analysis
|
2588
|
+
# The Amazon SNS topic ARN that you want Amazon Rekognition Video to
|
2589
|
+
# publish the completion status of the celebrity recognition analysis
|
2590
|
+
# to.
|
2579
2591
|
# @return [Types::NotificationChannel]
|
2580
2592
|
#
|
2581
2593
|
# @!attribute [rw] job_tag
|
@@ -2644,8 +2656,8 @@ module Aws::Rekognition
|
|
2644
2656
|
# @return [String]
|
2645
2657
|
#
|
2646
2658
|
# @!attribute [rw] notification_channel
|
2647
|
-
# The Amazon SNS topic ARN that you want Rekognition Video to
|
2648
|
-
# the completion status of the content moderation analysis to.
|
2659
|
+
# The Amazon SNS topic ARN that you want Amazon Rekognition Video to
|
2660
|
+
# publish the completion status of the content moderation analysis to.
|
2649
2661
|
# @return [Types::NotificationChannel]
|
2650
2662
|
#
|
2651
2663
|
# @!attribute [rw] job_tag
|
@@ -2705,8 +2717,9 @@ module Aws::Rekognition
|
|
2705
2717
|
# @return [String]
|
2706
2718
|
#
|
2707
2719
|
# @!attribute [rw] notification_channel
|
2708
|
-
# The ARN of the Amazon SNS topic to which you want Rekognition
|
2709
|
-
# to publish the completion status of the face detection
|
2720
|
+
# The ARN of the Amazon SNS topic to which you want Amazon Rekognition
|
2721
|
+
# Video to publish the completion status of the face detection
|
2722
|
+
# operation.
|
2710
2723
|
# @return [Types::NotificationChannel]
|
2711
2724
|
#
|
2712
2725
|
# @!attribute [rw] face_attributes
|
@@ -2786,8 +2799,8 @@ module Aws::Rekognition
|
|
2786
2799
|
# @return [String]
|
2787
2800
|
#
|
2788
2801
|
# @!attribute [rw] notification_channel
|
2789
|
-
# The ARN of the Amazon SNS topic to which you want Rekognition
|
2790
|
-
# to publish the completion status of the search.
|
2802
|
+
# The ARN of the Amazon SNS topic to which you want Amazon Rekognition
|
2803
|
+
# Video to publish the completion status of the search.
|
2791
2804
|
# @return [Types::NotificationChannel]
|
2792
2805
|
#
|
2793
2806
|
# @!attribute [rw] job_tag
|
@@ -2848,20 +2861,20 @@ module Aws::Rekognition
|
|
2848
2861
|
# @return [String]
|
2849
2862
|
#
|
2850
2863
|
# @!attribute [rw] min_confidence
|
2851
|
-
# Specifies the minimum confidence that Rekognition Video must
|
2852
|
-
# order to return a detected label. Confidence represents how
|
2853
|
-
# Amazon Rekognition is that a label is correctly identified.0
|
2854
|
-
# lowest confidence. 100 is the highest confidence.
|
2855
|
-
# doesn't return any labels with a confidence level
|
2856
|
-
# specified value.
|
2864
|
+
# Specifies the minimum confidence that Amazon Rekognition Video must
|
2865
|
+
# have in order to return a detected label. Confidence represents how
|
2866
|
+
# certain Amazon Rekognition is that a label is correctly identified.0
|
2867
|
+
# is the lowest confidence. 100 is the highest confidence. Amazon
|
2868
|
+
# Rekognition Video doesn't return any labels with a confidence level
|
2869
|
+
# lower than this specified value.
|
2857
2870
|
#
|
2858
2871
|
# If you don't specify `MinConfidence`, the operation returns labels
|
2859
2872
|
# with confidence values greater than or equal to 50 percent.
|
2860
2873
|
# @return [Float]
|
2861
2874
|
#
|
2862
2875
|
# @!attribute [rw] notification_channel
|
2863
|
-
# The Amazon SNS topic ARN you want Rekognition Video to
|
2864
|
-
# completion status of the label detection operation to.
|
2876
|
+
# The Amazon SNS topic ARN you want Amazon Rekognition Video to
|
2877
|
+
# publish the completion status of the label detection operation to.
|
2865
2878
|
# @return [Types::NotificationChannel]
|
2866
2879
|
#
|
2867
2880
|
# @!attribute [rw] job_tag
|
@@ -2920,8 +2933,8 @@ module Aws::Rekognition
|
|
2920
2933
|
# @return [String]
|
2921
2934
|
#
|
2922
2935
|
# @!attribute [rw] notification_channel
|
2923
|
-
# The Amazon SNS topic ARN you want Rekognition Video to
|
2924
|
-
# completion status of the people detection operation to.
|
2936
|
+
# The Amazon SNS topic ARN you want Amazon Rekognition Video to
|
2937
|
+
# publish the completion status of the people detection operation to.
|
2925
2938
|
# @return [Types::NotificationChannel]
|
2926
2939
|
#
|
2927
2940
|
# @!attribute [rw] job_tag
|
@@ -3025,8 +3038,9 @@ module Aws::Rekognition
|
|
3025
3038
|
end
|
3026
3039
|
|
3027
3040
|
# Information about the Amazon Kinesis Data Streams stream to which a
|
3028
|
-
# Rekognition Video stream processor streams the results of a
|
3029
|
-
# analysis. For more information, see
|
3041
|
+
# Amazon Rekognition Video stream processor streams the results of a
|
3042
|
+
# video analysis. For more information, see CreateStreamProcessor in the
|
3043
|
+
# Amazon Rekognition Developer Guide.
|
3030
3044
|
#
|
3031
3045
|
# @note When making an API call, you may pass StreamProcessorOutput
|
3032
3046
|
# data as a hash:
|
@@ -3097,7 +3111,8 @@ module Aws::Rekognition
|
|
3097
3111
|
# of text in which the word appears. The word `Id` is also an index for
|
3098
3112
|
# the word within a line of words.
|
3099
3113
|
#
|
3100
|
-
# For more information, see
|
3114
|
+
# For more information, see Detecting Text in the Amazon Rekognition
|
3115
|
+
# Developer Guide.
|
3101
3116
|
#
|
3102
3117
|
# @!attribute [rw] detected_text
|
3103
3118
|
# The word or line of text recognized by Amazon Rekognition.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: aws-sdk-rekognition
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 1.
|
4
|
+
version: 1.4.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Amazon Web Services
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2018-
|
11
|
+
date: 2018-06-19 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: aws-sdk-core
|