aws-sdk-rekognition 1.65.0 → 1.68.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +15 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rekognition/client.rb +297 -57
- data/lib/aws-sdk-rekognition/client_api.rb +90 -0
- data/lib/aws-sdk-rekognition/types.rb +671 -114
- data/lib/aws-sdk-rekognition.rb +1 -1
- metadata +4 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 77fa49261c6b4a5d979deb57fe71c6050ced87d6dc4969c109e69d1e8a87d756
|
4
|
+
data.tar.gz: a0b9505b507c579897359610488f0cd55b696721793793d7b66d20e752017997
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: d637bb63956ad7a33cbe53e7c096eb0c23bbff5924b6a77109bea43f7845c71dbedf58560b06edf9cc6160ca6b97617e8792e4676b5277bc236ff831c2f5c0a9
|
7
|
+
data.tar.gz: 863f592bccc9a6d923db2f5ddb3f5c0bec1e459b317aa7dcc65c16384dbfc083096ce733f50f8c69ea0fae0a949a2ecdc72cd08f0490feca8350347855f053c1
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,21 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.68.0 (2022-05-16)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Documentation updates for Amazon Rekognition.
|
8
|
+
|
9
|
+
1.67.0 (2022-04-27)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - This release adds support to configure stream-processor resources for label detections on streaming-videos. UpateStreamProcessor API is also launched with this release, which could be used to update an existing stream-processor.
|
13
|
+
|
14
|
+
1.66.0 (2022-02-24)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
4
19
|
1.65.0 (2022-02-03)
|
5
20
|
------------------
|
6
21
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.68.0
|
@@ -27,6 +27,7 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
30
31
|
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
31
32
|
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
32
33
|
require 'aws-sdk-core/plugins/signature_v4.rb'
|
@@ -75,6 +76,7 @@ module Aws::Rekognition
|
|
75
76
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
76
77
|
add_plugin(Aws::Plugins::TransferEncoding)
|
77
78
|
add_plugin(Aws::Plugins::HttpChecksum)
|
79
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
78
80
|
add_plugin(Aws::Plugins::DefaultsMode)
|
79
81
|
add_plugin(Aws::Plugins::RecursionDetection)
|
80
82
|
add_plugin(Aws::Plugins::SignatureV4)
|
@@ -789,7 +791,7 @@ module Aws::Rekognition
|
|
789
791
|
# project. For more information, see Creating training and test dataset
|
790
792
|
# in the *Amazon Rekognition Custom Labels Developer Guide*.
|
791
793
|
#
|
792
|
-
# <note markdown="1"> You can train a
|
794
|
+
# <note markdown="1"> You can train a model in a project that doesn't have associated
|
793
795
|
# datasets by specifying manifest files in the `TrainingData` and
|
794
796
|
# `TestingData` fields.
|
795
797
|
#
|
@@ -928,23 +930,36 @@ module Aws::Rekognition
|
|
928
930
|
end
|
929
931
|
|
930
932
|
# Creates an Amazon Rekognition stream processor that you can use to
|
931
|
-
# detect and recognize faces in a streaming video.
|
933
|
+
# detect and recognize faces or to detect labels in a streaming video.
|
932
934
|
#
|
933
935
|
# Amazon Rekognition Video is a consumer of live video from Amazon
|
934
|
-
# Kinesis Video Streams.
|
935
|
-
#
|
936
|
-
#
|
937
|
-
#
|
938
|
-
#
|
939
|
-
#
|
940
|
-
#
|
941
|
-
#
|
942
|
-
#
|
943
|
-
#
|
944
|
-
#
|
945
|
-
#
|
946
|
-
#
|
947
|
-
#
|
936
|
+
# Kinesis Video Streams. There are two different settings for stream
|
937
|
+
# processors in Amazon Rekognition: detecting faces and detecting
|
938
|
+
# labels.
|
939
|
+
#
|
940
|
+
# * If you are creating a stream processor for detecting faces, you
|
941
|
+
# provide as input a Kinesis video stream (`Input`) and a Kinesis data
|
942
|
+
# stream (`Output`) stream. You also specify the face recognition
|
943
|
+
# criteria in `Settings`. For example, the collection containing faces
|
944
|
+
# that you want to recognize. After you have finished analyzing a
|
945
|
+
# streaming video, use StopStreamProcessor to stop processing.
|
946
|
+
#
|
947
|
+
# * If you are creating a stream processor to detect labels, you provide
|
948
|
+
# as input a Kinesis video stream (`Input`), Amazon S3 bucket
|
949
|
+
# information (`Output`), and an Amazon SNS topic ARN
|
950
|
+
# (`NotificationChannel`). You can also provide a KMS key ID to
|
951
|
+
# encrypt the data sent to your Amazon S3 bucket. You specify what you
|
952
|
+
# want to detect in `ConnectedHomeSettings`, such as people, packages
|
953
|
+
# and people, or pets, people, and packages. You can also specify
|
954
|
+
# where in the frame you want Amazon Rekognition to monitor with
|
955
|
+
# `RegionsOfInterest`. When you run the StartStreamProcessor operation
|
956
|
+
# on a label detection stream processor, you input start and stop
|
957
|
+
# information to determine the length of the processing time.
|
958
|
+
#
|
959
|
+
# Use `Name` to assign an identifier for the stream processor. You use
|
960
|
+
# `Name` to manage the stream processor. For example, you can start
|
961
|
+
# processing the source video by calling StartStreamProcessor with the
|
962
|
+
# `Name` field.
|
948
963
|
#
|
949
964
|
# This operation requires permissions to perform the
|
950
965
|
# `rekognition:CreateStreamProcessor` action. If you want to tag your
|
@@ -954,31 +969,78 @@ module Aws::Rekognition
|
|
954
969
|
# @option params [required, Types::StreamProcessorInput] :input
|
955
970
|
# Kinesis video stream stream that provides the source streaming video.
|
956
971
|
# If you are using the AWS CLI, the parameter name is
|
957
|
-
# `StreamProcessorInput`.
|
972
|
+
# `StreamProcessorInput`. This is required for both face search and
|
973
|
+
# label detection stream processors.
|
958
974
|
#
|
959
975
|
# @option params [required, Types::StreamProcessorOutput] :output
|
960
|
-
# Kinesis data stream stream
|
961
|
-
# analysis results. If you are using
|
962
|
-
# `StreamProcessorOutput`.
|
976
|
+
# Kinesis data stream stream or Amazon S3 bucket location to which
|
977
|
+
# Amazon Rekognition Video puts the analysis results. If you are using
|
978
|
+
# the AWS CLI, the parameter name is `StreamProcessorOutput`. This must
|
979
|
+
# be a S3Destination of an Amazon S3 bucket that you own for a label
|
980
|
+
# detection stream processor or a Kinesis data stream ARN for a face
|
981
|
+
# search stream processor.
|
963
982
|
#
|
964
983
|
# @option params [required, String] :name
|
965
984
|
# An identifier you assign to the stream processor. You can use `Name`
|
966
985
|
# to manage the stream processor. For example, you can get the current
|
967
986
|
# status of the stream processor by calling DescribeStreamProcessor.
|
968
|
-
# `Name` is idempotent.
|
987
|
+
# `Name` is idempotent. This is required for both face search and label
|
988
|
+
# detection stream processors.
|
969
989
|
#
|
970
990
|
# @option params [required, Types::StreamProcessorSettings] :settings
|
971
|
-
#
|
972
|
-
#
|
973
|
-
#
|
991
|
+
# Input parameters used in a streaming video analyzed by a stream
|
992
|
+
# processor. You can use `FaceSearch` to recognize faces in a streaming
|
993
|
+
# video, or you can use `ConnectedHome` to detect labels.
|
974
994
|
#
|
975
995
|
# @option params [required, String] :role_arn
|
976
|
-
# ARN of the IAM role that allows access to
|
996
|
+
# The Amazon Resource Number (ARN) of the IAM role that allows access to
|
997
|
+
# the stream processor. The IAM role provides Rekognition read
|
998
|
+
# permissions for a Kinesis stream. It also provides write permissions
|
999
|
+
# to an Amazon S3 bucket and Amazon Simple Notification Service topic
|
1000
|
+
# for a label detection stream processor. This is required for both face
|
1001
|
+
# search and label detection stream processors.
|
977
1002
|
#
|
978
1003
|
# @option params [Hash<String,String>] :tags
|
979
1004
|
# A set of tags (key-value pairs) that you want to attach to the stream
|
980
1005
|
# processor.
|
981
1006
|
#
|
1007
|
+
# @option params [Types::StreamProcessorNotificationChannel] :notification_channel
|
1008
|
+
# The Amazon Simple Notification Service topic to which Amazon
|
1009
|
+
# Rekognition publishes the object detection results and completion
|
1010
|
+
# status of a video analysis operation.
|
1011
|
+
#
|
1012
|
+
# Amazon Rekognition publishes a notification the first time an object
|
1013
|
+
# of interest or a person is detected in the video stream. For example,
|
1014
|
+
# if Amazon Rekognition detects a person at second 2, a pet at second 4,
|
1015
|
+
# and a person again at second 5, Amazon Rekognition sends 2 object
|
1016
|
+
# class detected notifications, one for a person at second 2 and one for
|
1017
|
+
# a pet at second 4.
|
1018
|
+
#
|
1019
|
+
# Amazon Rekognition also publishes an an end-of-session notification
|
1020
|
+
# with a summary when the stream processing session is complete.
|
1021
|
+
#
|
1022
|
+
# @option params [String] :kms_key_id
|
1023
|
+
# The identifier for your AWS Key Management Service key (AWS KMS key).
|
1024
|
+
# This is an optional parameter for label detection stream processors
|
1025
|
+
# and should not be used to create a face search stream processor. You
|
1026
|
+
# can supply the Amazon Resource Name (ARN) of your KMS key, the ID of
|
1027
|
+
# your KMS key, an alias for your KMS key, or an alias ARN. The key is
|
1028
|
+
# used to encrypt results and data published to your Amazon S3 bucket,
|
1029
|
+
# which includes image frames and hero images. Your source images are
|
1030
|
+
# unaffected.
|
1031
|
+
#
|
1032
|
+
# @option params [Array<Types::RegionOfInterest>] :regions_of_interest
|
1033
|
+
# Specifies locations in the frames where Amazon Rekognition checks for
|
1034
|
+
# objects or people. You can specify up to 10 regions of interest. This
|
1035
|
+
# is an optional parameter for label detection stream processors and
|
1036
|
+
# should not be used to create a face search stream processor.
|
1037
|
+
#
|
1038
|
+
# @option params [Types::StreamProcessorDataSharingPreference] :data_sharing_preference
|
1039
|
+
# Shows whether you are sharing data with Rekognition to improve model
|
1040
|
+
# performance. You can choose this option at the account level or on a
|
1041
|
+
# per-stream basis. Note that if you opt out at the account level this
|
1042
|
+
# setting is ignored on individual streams.
|
1043
|
+
#
|
982
1044
|
# @return [Types::CreateStreamProcessorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
983
1045
|
#
|
984
1046
|
# * {Types::CreateStreamProcessorResponse#stream_processor_arn #stream_processor_arn} => String
|
@@ -995,6 +1057,10 @@ module Aws::Rekognition
|
|
995
1057
|
# kinesis_data_stream: {
|
996
1058
|
# arn: "KinesisDataArn",
|
997
1059
|
# },
|
1060
|
+
# s3_destination: {
|
1061
|
+
# bucket: "S3Bucket",
|
1062
|
+
# key_prefix: "S3KeyPrefix",
|
1063
|
+
# },
|
998
1064
|
# },
|
999
1065
|
# name: "StreamProcessorName", # required
|
1000
1066
|
# settings: { # required
|
@@ -1002,11 +1068,38 @@ module Aws::Rekognition
|
|
1002
1068
|
# collection_id: "CollectionId",
|
1003
1069
|
# face_match_threshold: 1.0,
|
1004
1070
|
# },
|
1071
|
+
# connected_home: {
|
1072
|
+
# labels: ["ConnectedHomeLabel"], # required
|
1073
|
+
# min_confidence: 1.0,
|
1074
|
+
# },
|
1005
1075
|
# },
|
1006
1076
|
# role_arn: "RoleArn", # required
|
1007
1077
|
# tags: {
|
1008
1078
|
# "TagKey" => "TagValue",
|
1009
1079
|
# },
|
1080
|
+
# notification_channel: {
|
1081
|
+
# sns_topic_arn: "SNSTopicArn", # required
|
1082
|
+
# },
|
1083
|
+
# kms_key_id: "KmsKeyId",
|
1084
|
+
# regions_of_interest: [
|
1085
|
+
# {
|
1086
|
+
# bounding_box: {
|
1087
|
+
# width: 1.0,
|
1088
|
+
# height: 1.0,
|
1089
|
+
# left: 1.0,
|
1090
|
+
# top: 1.0,
|
1091
|
+
# },
|
1092
|
+
# polygon: [
|
1093
|
+
# {
|
1094
|
+
# x: 1.0,
|
1095
|
+
# y: 1.0,
|
1096
|
+
# },
|
1097
|
+
# ],
|
1098
|
+
# },
|
1099
|
+
# ],
|
1100
|
+
# data_sharing_preference: {
|
1101
|
+
# opt_in: false, # required
|
1102
|
+
# },
|
1010
1103
|
# })
|
1011
1104
|
#
|
1012
1105
|
# @example Response structure
|
@@ -1021,12 +1114,16 @@ module Aws::Rekognition
|
|
1021
1114
|
end
|
1022
1115
|
|
1023
1116
|
# Deletes the specified collection. Note that this operation removes all
|
1024
|
-
# faces in the collection. For an example, see
|
1025
|
-
#
|
1117
|
+
# faces in the collection. For an example, see [Deleting a
|
1118
|
+
# collection][1].
|
1026
1119
|
#
|
1027
1120
|
# This operation requires permissions to perform the
|
1028
1121
|
# `rekognition:DeleteCollection` action.
|
1029
1122
|
#
|
1123
|
+
#
|
1124
|
+
#
|
1125
|
+
# [1]: https://docs.aws.amazon.com/rekognition/latest/dg/delete-collection-procedure.html
|
1126
|
+
#
|
1030
1127
|
# @option params [required, String] :collection_id
|
1031
1128
|
# ID of the collection to delete.
|
1032
1129
|
#
|
@@ -1512,6 +1609,10 @@ module Aws::Rekognition
|
|
1512
1609
|
# * {Types::DescribeStreamProcessorResponse#output #output} => Types::StreamProcessorOutput
|
1513
1610
|
# * {Types::DescribeStreamProcessorResponse#role_arn #role_arn} => String
|
1514
1611
|
# * {Types::DescribeStreamProcessorResponse#settings #settings} => Types::StreamProcessorSettings
|
1612
|
+
# * {Types::DescribeStreamProcessorResponse#notification_channel #notification_channel} => Types::StreamProcessorNotificationChannel
|
1613
|
+
# * {Types::DescribeStreamProcessorResponse#kms_key_id #kms_key_id} => String
|
1614
|
+
# * {Types::DescribeStreamProcessorResponse#regions_of_interest #regions_of_interest} => Array<Types::RegionOfInterest>
|
1615
|
+
# * {Types::DescribeStreamProcessorResponse#data_sharing_preference #data_sharing_preference} => Types::StreamProcessorDataSharingPreference
|
1515
1616
|
#
|
1516
1617
|
# @example Request syntax with placeholder values
|
1517
1618
|
#
|
@@ -1523,15 +1624,31 @@ module Aws::Rekognition
|
|
1523
1624
|
#
|
1524
1625
|
# resp.name #=> String
|
1525
1626
|
# resp.stream_processor_arn #=> String
|
1526
|
-
# resp.status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING"
|
1627
|
+
# resp.status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING", "UPDATING"
|
1527
1628
|
# resp.status_message #=> String
|
1528
1629
|
# resp.creation_timestamp #=> Time
|
1529
1630
|
# resp.last_update_timestamp #=> Time
|
1530
1631
|
# resp.input.kinesis_video_stream.arn #=> String
|
1531
1632
|
# resp.output.kinesis_data_stream.arn #=> String
|
1633
|
+
# resp.output.s3_destination.bucket #=> String
|
1634
|
+
# resp.output.s3_destination.key_prefix #=> String
|
1532
1635
|
# resp.role_arn #=> String
|
1533
1636
|
# resp.settings.face_search.collection_id #=> String
|
1534
1637
|
# resp.settings.face_search.face_match_threshold #=> Float
|
1638
|
+
# resp.settings.connected_home.labels #=> Array
|
1639
|
+
# resp.settings.connected_home.labels[0] #=> String
|
1640
|
+
# resp.settings.connected_home.min_confidence #=> Float
|
1641
|
+
# resp.notification_channel.sns_topic_arn #=> String
|
1642
|
+
# resp.kms_key_id #=> String
|
1643
|
+
# resp.regions_of_interest #=> Array
|
1644
|
+
# resp.regions_of_interest[0].bounding_box.width #=> Float
|
1645
|
+
# resp.regions_of_interest[0].bounding_box.height #=> Float
|
1646
|
+
# resp.regions_of_interest[0].bounding_box.left #=> Float
|
1647
|
+
# resp.regions_of_interest[0].bounding_box.top #=> Float
|
1648
|
+
# resp.regions_of_interest[0].polygon #=> Array
|
1649
|
+
# resp.regions_of_interest[0].polygon[0].x #=> Float
|
1650
|
+
# resp.regions_of_interest[0].polygon[0].y #=> Float
|
1651
|
+
# resp.data_sharing_preference.opt_in #=> Boolean
|
1535
1652
|
#
|
1536
1653
|
# @overload describe_stream_processor(params = {})
|
1537
1654
|
# @param [Hash] params ({})
|
@@ -1614,8 +1731,9 @@ module Aws::Rekognition
|
|
1614
1731
|
# using the S3Object property.
|
1615
1732
|
#
|
1616
1733
|
# For Amazon Rekognition to process an S3 object, the user must have
|
1617
|
-
# permission to access the S3 object. For more information, see
|
1618
|
-
#
|
1734
|
+
# permission to access the S3 object. For more information, see How
|
1735
|
+
# Amazon Rekognition works with IAM in the Amazon Rekognition Developer
|
1736
|
+
# Guide.
|
1619
1737
|
#
|
1620
1738
|
# @option params [Integer] :max_results
|
1621
1739
|
# Maximum number of results you want the service to return in the
|
@@ -1857,7 +1975,7 @@ module Aws::Rekognition
|
|
1857
1975
|
# events like wedding, graduation, and birthday party; and concepts like
|
1858
1976
|
# landscape, evening, and nature.
|
1859
1977
|
#
|
1860
|
-
# For an example, see Analyzing
|
1978
|
+
# For an example, see Analyzing images stored in an Amazon S3 bucket in
|
1861
1979
|
# the Amazon Rekognition Developer Guide.
|
1862
1980
|
#
|
1863
1981
|
# <note markdown="1"> `DetectLabels` does not support the detection of activities. However,
|
@@ -2254,7 +2372,7 @@ module Aws::Rekognition
|
|
2254
2372
|
# To be detected, text must be within +/- 90 degrees orientation of the
|
2255
2373
|
# horizontal axis.
|
2256
2374
|
#
|
2257
|
-
# For more information, see
|
2375
|
+
# For more information, see Detecting text in the Amazon Rekognition
|
2258
2376
|
# Developer Guide.
|
2259
2377
|
#
|
2260
2378
|
# @option params [required, Types::Image] :image
|
@@ -2301,6 +2419,12 @@ module Aws::Rekognition
|
|
2301
2419
|
# left: 1.0,
|
2302
2420
|
# top: 1.0,
|
2303
2421
|
# },
|
2422
|
+
# polygon: [
|
2423
|
+
# {
|
2424
|
+
# x: 1.0,
|
2425
|
+
# y: 1.0,
|
2426
|
+
# },
|
2427
|
+
# ],
|
2304
2428
|
# },
|
2305
2429
|
# ],
|
2306
2430
|
# },
|
@@ -2379,7 +2503,7 @@ module Aws::Rekognition
|
|
2379
2503
|
# an array of URLs. If there is no additional information about the
|
2380
2504
|
# celebrity, this list is empty.
|
2381
2505
|
#
|
2382
|
-
# For more information, see
|
2506
|
+
# For more information, see Getting information about a celebrity in the
|
2383
2507
|
# Amazon Rekognition Developer Guide.
|
2384
2508
|
#
|
2385
2509
|
# This operation requires permissions to perform the
|
@@ -2615,7 +2739,7 @@ module Aws::Rekognition
|
|
2615
2739
|
# and populate the `NextToken` request parameter with the value of
|
2616
2740
|
# `NextToken` returned from the previous call to `GetContentModeration`.
|
2617
2741
|
#
|
2618
|
-
# For more information, see
|
2742
|
+
# For more information, see moderating content in the Amazon Rekognition
|
2619
2743
|
# Developer Guide.
|
2620
2744
|
#
|
2621
2745
|
#
|
@@ -3242,7 +3366,7 @@ module Aws::Rekognition
|
|
3242
3366
|
# the `NextToken` request parameter with the token value returned from
|
3243
3367
|
# the previous call to `GetSegmentDetection`.
|
3244
3368
|
#
|
3245
|
-
# For more information, see Detecting
|
3369
|
+
# For more information, see Detecting video segments in stored video in
|
3246
3370
|
# the Amazon Rekognition Developer Guide.
|
3247
3371
|
#
|
3248
3372
|
# @option params [required, String] :job_id
|
@@ -3434,7 +3558,7 @@ module Aws::Rekognition
|
|
3434
3558
|
# search operations using the SearchFaces and SearchFacesByImage
|
3435
3559
|
# operations.
|
3436
3560
|
#
|
3437
|
-
# For more information, see Adding
|
3561
|
+
# For more information, see Adding faces to a collection in the Amazon
|
3438
3562
|
# Rekognition Developer Guide.
|
3439
3563
|
#
|
3440
3564
|
# To get the number of faces in a collection, call DescribeCollection.
|
@@ -3515,9 +3639,9 @@ module Aws::Rekognition
|
|
3515
3639
|
# `detectionAttributes` parameter), Amazon Rekognition returns detailed
|
3516
3640
|
# facial attributes, such as facial landmarks (for example, location of
|
3517
3641
|
# eye and mouth) and other facial attributes. If you provide the same
|
3518
|
-
# image, specify the same collection, use the same external ID
|
3519
|
-
# the
|
3520
|
-
#
|
3642
|
+
# image, specify the same collection, and use the same external ID in
|
3643
|
+
# the `IndexFaces` operation, Amazon Rekognition doesn't save duplicate
|
3644
|
+
# face metadata.
|
3521
3645
|
#
|
3522
3646
|
#
|
3523
3647
|
#
|
@@ -3858,7 +3982,7 @@ module Aws::Rekognition
|
|
3858
3982
|
# truncated, the response also provides a `NextToken` that you can use
|
3859
3983
|
# in the subsequent request to fetch the next set of collection IDs.
|
3860
3984
|
#
|
3861
|
-
# For an example, see Listing
|
3985
|
+
# For an example, see Listing collections in the Amazon Rekognition
|
3862
3986
|
# Developer Guide.
|
3863
3987
|
#
|
3864
3988
|
# This operation requires permissions to perform the
|
@@ -4292,7 +4416,7 @@ module Aws::Rekognition
|
|
4292
4416
|
# resp.next_token #=> String
|
4293
4417
|
# resp.stream_processors #=> Array
|
4294
4418
|
# resp.stream_processors[0].name #=> String
|
4295
|
-
# resp.stream_processors[0].status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING"
|
4419
|
+
# resp.stream_processors[0].status #=> String, one of "STOPPED", "STARTING", "RUNNING", "FAILED", "STOPPING", "UPDATING"
|
4296
4420
|
#
|
4297
4421
|
# @overload list_stream_processors(params = {})
|
4298
4422
|
# @param [Hash] params ({})
|
@@ -4334,7 +4458,7 @@ module Aws::Rekognition
|
|
4334
4458
|
end
|
4335
4459
|
|
4336
4460
|
# Returns an array of celebrities recognized in the input image. For
|
4337
|
-
# more information, see Recognizing
|
4461
|
+
# more information, see Recognizing celebrities in the Amazon
|
4338
4462
|
# Rekognition Developer Guide.
|
4339
4463
|
#
|
4340
4464
|
# `RecognizeCelebrities` returns the 64 largest faces in the image. It
|
@@ -4362,7 +4486,7 @@ module Aws::Rekognition
|
|
4362
4486
|
# to call Amazon Rekognition operations, passing image bytes is not
|
4363
4487
|
# supported. The image must be either a PNG or JPEG formatted file.
|
4364
4488
|
#
|
4365
|
-
# For an example, see Recognizing
|
4489
|
+
# For an example, see Recognizing celebrities in an image in the Amazon
|
4366
4490
|
# Rekognition Developer Guide.
|
4367
4491
|
#
|
4368
4492
|
# This operation requires permissions to perform the
|
@@ -4472,7 +4596,7 @@ module Aws::Rekognition
|
|
4472
4596
|
# `confidence` value for each face match, indicating the confidence that
|
4473
4597
|
# the specific face matches the input face.
|
4474
4598
|
#
|
4475
|
-
# For an example, see Searching for a
|
4599
|
+
# For an example, see Searching for a face using its face ID in the
|
4476
4600
|
# Amazon Rekognition Developer Guide.
|
4477
4601
|
#
|
4478
4602
|
# This operation requires permissions to perform the
|
@@ -4790,7 +4914,7 @@ module Aws::Rekognition
|
|
4790
4914
|
# identifier (`JobId`) from the initial call to
|
4791
4915
|
# `StartCelebrityRecognition`.
|
4792
4916
|
#
|
4793
|
-
# For more information, see Recognizing
|
4917
|
+
# For more information, see Recognizing celebrities in the Amazon
|
4794
4918
|
# Rekognition Developer Guide.
|
4795
4919
|
#
|
4796
4920
|
# @option params [required, Types::Video] :video
|
@@ -4866,7 +4990,7 @@ module Aws::Rekognition
|
|
4866
4990
|
# call GetContentModeration and pass the job identifier (`JobId`) from
|
4867
4991
|
# the initial call to `StartContentModeration`.
|
4868
4992
|
#
|
4869
|
-
# For more information, see
|
4993
|
+
# For more information, see Moderating content in the Amazon Rekognition
|
4870
4994
|
# Developer Guide.
|
4871
4995
|
#
|
4872
4996
|
#
|
@@ -4954,7 +5078,7 @@ module Aws::Rekognition
|
|
4954
5078
|
# pass the job identifier (`JobId`) from the initial call to
|
4955
5079
|
# `StartFaceDetection`.
|
4956
5080
|
#
|
4957
|
-
# For more information, see Detecting
|
5081
|
+
# For more information, see Detecting faces in a stored video in the
|
4958
5082
|
# Amazon Rekognition Developer Guide.
|
4959
5083
|
#
|
4960
5084
|
# @option params [required, Types::Video] :video
|
@@ -5035,7 +5159,11 @@ module Aws::Rekognition
|
|
5035
5159
|
# status value published to the Amazon SNS topic is `SUCCEEDED`. If so,
|
5036
5160
|
# call GetFaceSearch and pass the job identifier (`JobId`) from the
|
5037
5161
|
# initial call to `StartFaceSearch`. For more information, see
|
5038
|
-
#
|
5162
|
+
# [Searching stored videos for faces][1].
|
5163
|
+
#
|
5164
|
+
#
|
5165
|
+
#
|
5166
|
+
# [1]: https://docs.aws.amazon.com/rekognition/latest/dg/procedure-person-search-videos.html
|
5039
5167
|
#
|
5040
5168
|
# @option params [required, Types::Video] :video
|
5041
5169
|
# The video you want to search. The video must be stored in an Amazon S3
|
@@ -5331,7 +5459,7 @@ module Aws::Rekognition
|
|
5331
5459
|
# `SUCCEEDED`. if so, call GetSegmentDetection and pass the job
|
5332
5460
|
# identifier (`JobId`) from the initial call to `StartSegmentDetection`.
|
5333
5461
|
#
|
5334
|
-
# For more information, see Detecting
|
5462
|
+
# For more information, see Detecting video segments in stored video in
|
5335
5463
|
# the Amazon Rekognition Developer Guide.
|
5336
5464
|
#
|
5337
5465
|
# @option params [required, Types::Video] :video
|
@@ -5417,17 +5545,55 @@ module Aws::Rekognition
|
|
5417
5545
|
# stream processor to start, use the value of the `Name` field specified
|
5418
5546
|
# in the call to `CreateStreamProcessor`.
|
5419
5547
|
#
|
5548
|
+
# If you are using a label detection stream processor to detect labels,
|
5549
|
+
# you need to provide a `Start selector` and a `Stop selector` to
|
5550
|
+
# determine the length of the stream processing time.
|
5551
|
+
#
|
5420
5552
|
# @option params [required, String] :name
|
5421
5553
|
# The name of the stream processor to start processing.
|
5422
5554
|
#
|
5423
|
-
# @
|
5555
|
+
# @option params [Types::StreamProcessingStartSelector] :start_selector
|
5556
|
+
# Specifies the starting point in the Kinesis stream to start
|
5557
|
+
# processing. You can use the producer timestamp or the fragment number.
|
5558
|
+
# For more information, see [Fragment][1].
|
5559
|
+
#
|
5560
|
+
# This is a required parameter for label detection stream processors and
|
5561
|
+
# should not be used to start a face search stream processor.
|
5562
|
+
#
|
5563
|
+
#
|
5564
|
+
#
|
5565
|
+
# [1]: https://docs.aws.amazon.com/kinesisvideostreams/latest/dg/API_reader_Fragment.html
|
5566
|
+
#
|
5567
|
+
# @option params [Types::StreamProcessingStopSelector] :stop_selector
|
5568
|
+
# Specifies when to stop processing the stream. You can specify a
|
5569
|
+
# maximum amount of time to process the video.
|
5570
|
+
#
|
5571
|
+
# This is a required parameter for label detection stream processors and
|
5572
|
+
# should not be used to start a face search stream processor.
|
5573
|
+
#
|
5574
|
+
# @return [Types::StartStreamProcessorResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
5575
|
+
#
|
5576
|
+
# * {Types::StartStreamProcessorResponse#session_id #session_id} => String
|
5424
5577
|
#
|
5425
5578
|
# @example Request syntax with placeholder values
|
5426
5579
|
#
|
5427
5580
|
# resp = client.start_stream_processor({
|
5428
5581
|
# name: "StreamProcessorName", # required
|
5582
|
+
# start_selector: {
|
5583
|
+
# kvs_stream_start_selector: {
|
5584
|
+
# producer_timestamp: 1,
|
5585
|
+
# fragment_number: "KinesisVideoStreamFragmentNumber",
|
5586
|
+
# },
|
5587
|
+
# },
|
5588
|
+
# stop_selector: {
|
5589
|
+
# max_duration_in_seconds: 1,
|
5590
|
+
# },
|
5429
5591
|
# })
|
5430
5592
|
#
|
5593
|
+
# @example Response structure
|
5594
|
+
#
|
5595
|
+
# resp.session_id #=> String
|
5596
|
+
#
|
5431
5597
|
# @overload start_stream_processor(params = {})
|
5432
5598
|
# @param [Hash] params ({})
|
5433
5599
|
def start_stream_processor(params = {}, options = {})
|
@@ -5465,15 +5631,17 @@ module Aws::Rekognition
|
|
5465
5631
|
# @option params [Types::NotificationChannel] :notification_channel
|
5466
5632
|
# The Amazon Simple Notification Service topic to which Amazon
|
5467
5633
|
# Rekognition publishes the completion status of a video analysis
|
5468
|
-
# operation. For more information, see
|
5469
|
-
# SNS topic must have a topic name
|
5470
|
-
# if you are using the
|
5471
|
-
# to access the topic.
|
5472
|
-
# multiple Amazon SNS
|
5634
|
+
# operation. For more information, see [Calling Amazon Rekognition Video
|
5635
|
+
# operations][1]. Note that the Amazon SNS topic must have a topic name
|
5636
|
+
# that begins with *AmazonRekognition* if you are using the
|
5637
|
+
# AmazonRekognitionServiceRole permissions policy to access the topic.
|
5638
|
+
# For more information, see [Giving access to multiple Amazon SNS
|
5639
|
+
# topics][2].
|
5473
5640
|
#
|
5474
5641
|
#
|
5475
5642
|
#
|
5476
|
-
# [1]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video
|
5643
|
+
# [1]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video.html
|
5644
|
+
# [2]: https://docs.aws.amazon.com/rekognition/latest/dg/api-video-roles.html#api-video-roles-all-topics
|
5477
5645
|
#
|
5478
5646
|
# @option params [String] :job_tag
|
5479
5647
|
# An identifier returned in the completion status published by your
|
@@ -5519,6 +5687,12 @@ module Aws::Rekognition
|
|
5519
5687
|
# left: 1.0,
|
5520
5688
|
# top: 1.0,
|
5521
5689
|
# },
|
5690
|
+
# polygon: [
|
5691
|
+
# {
|
5692
|
+
# x: 1.0,
|
5693
|
+
# y: 1.0,
|
5694
|
+
# },
|
5695
|
+
# ],
|
5522
5696
|
# },
|
5523
5697
|
# ],
|
5524
5698
|
# },
|
@@ -5707,6 +5881,72 @@ module Aws::Rekognition
|
|
5707
5881
|
req.send_request(options)
|
5708
5882
|
end
|
5709
5883
|
|
5884
|
+
# Allows you to update a stream processor. You can change some settings
|
5885
|
+
# and regions of interest and delete certain parameters.
|
5886
|
+
#
|
5887
|
+
# @option params [required, String] :name
|
5888
|
+
# Name of the stream processor that you want to update.
|
5889
|
+
#
|
5890
|
+
# @option params [Types::StreamProcessorSettingsForUpdate] :settings_for_update
|
5891
|
+
# The stream processor settings that you want to update. Label detection
|
5892
|
+
# settings can be updated to detect different labels with a different
|
5893
|
+
# minimum confidence.
|
5894
|
+
#
|
5895
|
+
# @option params [Array<Types::RegionOfInterest>] :regions_of_interest_for_update
|
5896
|
+
# Specifies locations in the frames where Amazon Rekognition checks for
|
5897
|
+
# objects or people. This is an optional parameter for label detection
|
5898
|
+
# stream processors.
|
5899
|
+
#
|
5900
|
+
# @option params [Types::StreamProcessorDataSharingPreference] :data_sharing_preference_for_update
|
5901
|
+
# Shows whether you are sharing data with Rekognition to improve model
|
5902
|
+
# performance. You can choose this option at the account level or on a
|
5903
|
+
# per-stream basis. Note that if you opt out at the account level this
|
5904
|
+
# setting is ignored on individual streams.
|
5905
|
+
#
|
5906
|
+
# @option params [Array<String>] :parameters_to_delete
|
5907
|
+
# A list of parameters you want to delete from the stream processor.
|
5908
|
+
#
|
5909
|
+
# @return [Struct] Returns an empty {Seahorse::Client::Response response}.
|
5910
|
+
#
|
5911
|
+
# @example Request syntax with placeholder values
|
5912
|
+
#
|
5913
|
+
# resp = client.update_stream_processor({
|
5914
|
+
# name: "StreamProcessorName", # required
|
5915
|
+
# settings_for_update: {
|
5916
|
+
# connected_home_for_update: {
|
5917
|
+
# labels: ["ConnectedHomeLabel"],
|
5918
|
+
# min_confidence: 1.0,
|
5919
|
+
# },
|
5920
|
+
# },
|
5921
|
+
# regions_of_interest_for_update: [
|
5922
|
+
# {
|
5923
|
+
# bounding_box: {
|
5924
|
+
# width: 1.0,
|
5925
|
+
# height: 1.0,
|
5926
|
+
# left: 1.0,
|
5927
|
+
# top: 1.0,
|
5928
|
+
# },
|
5929
|
+
# polygon: [
|
5930
|
+
# {
|
5931
|
+
# x: 1.0,
|
5932
|
+
# y: 1.0,
|
5933
|
+
# },
|
5934
|
+
# ],
|
5935
|
+
# },
|
5936
|
+
# ],
|
5937
|
+
# data_sharing_preference_for_update: {
|
5938
|
+
# opt_in: false, # required
|
5939
|
+
# },
|
5940
|
+
# parameters_to_delete: ["ConnectedHomeMinConfidence"], # accepts ConnectedHomeMinConfidence, RegionsOfInterest
|
5941
|
+
# })
|
5942
|
+
#
|
5943
|
+
# @overload update_stream_processor(params = {})
|
5944
|
+
# @param [Hash] params ({})
|
5945
|
+
def update_stream_processor(params = {}, options = {})
|
5946
|
+
req = build_request(:update_stream_processor, params)
|
5947
|
+
req.send_request(options)
|
5948
|
+
end
|
5949
|
+
|
5710
5950
|
# @!endgroup
|
5711
5951
|
|
5712
5952
|
# @param params ({})
|
@@ -5720,7 +5960,7 @@ module Aws::Rekognition
|
|
5720
5960
|
params: params,
|
5721
5961
|
config: config)
|
5722
5962
|
context[:gem_name] = 'aws-sdk-rekognition'
|
5723
|
-
context[:gem_version] = '1.
|
5963
|
+
context[:gem_version] = '1.68.0'
|
5724
5964
|
Seahorse::Client::Request.new(handlers, context)
|
5725
5965
|
end
|
5726
5966
|
|