aws-sdk-rekognition 1.33.0 → 1.38.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 +5 -5
- data/lib/aws-sdk-rekognition.rb +7 -4
- data/lib/aws-sdk-rekognition/client.rb +384 -21
- data/lib/aws-sdk-rekognition/client_api.rb +178 -0
- data/lib/aws-sdk-rekognition/errors.rb +198 -0
- data/lib/aws-sdk-rekognition/resource.rb +1 -0
- data/lib/aws-sdk-rekognition/types.rb +504 -3
- data/lib/aws-sdk-rekognition/waiters.rb +62 -0
- metadata +3 -3
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
|
-
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 948f202d8e2305804198ef15ede2efa1bfbe67df334ec422cbb139a76325f6ae
|
4
|
+
data.tar.gz: ff8524bf4db82dea8903e7a4238b033755160c730cdc25dc90fb435756356040
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5f184df719ee4eb070df8db187c55c5622e1ae945eb89d937b7bee73fb23c5a5349a15ce8e5efc60b174ebf48fa34a91a9589b5f5d637de360c09a07fbc1f753
|
7
|
+
data.tar.gz: e100e987da1664f72acb95b8dabe7deb543dbf4f95db823cf13f2a8d45498ffcf37759cacefe786c539e692645b7873001ed6ada9e03dd2bde5b73f4dacd77c0
|
data/lib/aws-sdk-rekognition.rb
CHANGED
@@ -25,17 +25,20 @@ require_relative 'aws-sdk-rekognition/customizations'
|
|
25
25
|
# methods each accept a hash of request parameters and return a response
|
26
26
|
# structure.
|
27
27
|
#
|
28
|
+
# rekognition = Aws::Rekognition::Client.new
|
29
|
+
# resp = rekognition.compare_faces(params)
|
30
|
+
#
|
28
31
|
# See {Client} for more information.
|
29
32
|
#
|
30
33
|
# # Errors
|
31
34
|
#
|
32
|
-
# Errors returned from Amazon Rekognition
|
33
|
-
# extend {Errors::ServiceError}.
|
35
|
+
# Errors returned from Amazon Rekognition are defined in the
|
36
|
+
# {Errors} module and all extend {Errors::ServiceError}.
|
34
37
|
#
|
35
38
|
# begin
|
36
39
|
# # do stuff
|
37
40
|
# rescue Aws::Rekognition::Errors::ServiceError
|
38
|
-
# # rescues all
|
41
|
+
# # rescues all Amazon Rekognition API errors
|
39
42
|
# end
|
40
43
|
#
|
41
44
|
# See {Errors} for more information.
|
@@ -43,6 +46,6 @@ require_relative 'aws-sdk-rekognition/customizations'
|
|
43
46
|
# @service
|
44
47
|
module Aws::Rekognition
|
45
48
|
|
46
|
-
GEM_VERSION = '1.
|
49
|
+
GEM_VERSION = '1.38.0'
|
47
50
|
|
48
51
|
end
|
@@ -30,6 +30,18 @@ require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
|
30
30
|
Aws::Plugins::GlobalConfiguration.add_identifier(:rekognition)
|
31
31
|
|
32
32
|
module Aws::Rekognition
|
33
|
+
# An API client for Rekognition. To construct a client, you need to configure a `:region` and `:credentials`.
|
34
|
+
#
|
35
|
+
# client = Aws::Rekognition::Client.new(
|
36
|
+
# region: region_name,
|
37
|
+
# credentials: credentials,
|
38
|
+
# # ...
|
39
|
+
# )
|
40
|
+
#
|
41
|
+
# For details on configuring region and credentials see
|
42
|
+
# the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
|
43
|
+
#
|
44
|
+
# See {#initialize} for a full list of supported configuration options.
|
33
45
|
class Client < Seahorse::Client::Base
|
34
46
|
|
35
47
|
include Aws::ClientStubs
|
@@ -93,7 +105,7 @@ module Aws::Rekognition
|
|
93
105
|
# @option options [required, String] :region
|
94
106
|
# The AWS region to connect to. The configured `:region` is
|
95
107
|
# used to determine the service `:endpoint`. When not passed,
|
96
|
-
# a default `:region` is
|
108
|
+
# a default `:region` is searched for in the following locations:
|
97
109
|
#
|
98
110
|
# * `Aws.config[:region]`
|
99
111
|
# * `ENV['AWS_REGION']`
|
@@ -108,6 +120,12 @@ module Aws::Rekognition
|
|
108
120
|
# When set to `true`, a thread polling for endpoints will be running in
|
109
121
|
# the background every 60 secs (default). Defaults to `false`.
|
110
122
|
#
|
123
|
+
# @option options [Boolean] :adaptive_retry_wait_to_fill (true)
|
124
|
+
# Used only in `adaptive` retry mode. When true, the request will sleep
|
125
|
+
# until there is sufficent client side capacity to retry the request.
|
126
|
+
# When false, the request will raise a `RetryCapacityNotAvailableError` and will
|
127
|
+
# not retry instead of sleeping.
|
128
|
+
#
|
111
129
|
# @option options [Boolean] :client_side_monitoring (false)
|
112
130
|
# When `true`, client-side metrics will be collected for all API requests from
|
113
131
|
# this client.
|
@@ -132,6 +150,10 @@ module Aws::Rekognition
|
|
132
150
|
# When `true`, an attempt is made to coerce request parameters into
|
133
151
|
# the required types.
|
134
152
|
#
|
153
|
+
# @option options [Boolean] :correct_clock_skew (true)
|
154
|
+
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
155
|
+
# a clock skew correction and retry requests with skewed client clocks.
|
156
|
+
#
|
135
157
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
136
158
|
# Set to true to disable SDK automatically adding host prefix
|
137
159
|
# to default service endpoint when available.
|
@@ -139,7 +161,7 @@ module Aws::Rekognition
|
|
139
161
|
# @option options [String] :endpoint
|
140
162
|
# The client endpoint is normally constructed from the `:region`
|
141
163
|
# option. You should only configure an `:endpoint` when connecting
|
142
|
-
# to test endpoints. This should be
|
164
|
+
# to test endpoints. This should be a valid HTTP(S) URI.
|
143
165
|
#
|
144
166
|
# @option options [Integer] :endpoint_cache_max_entries (1000)
|
145
167
|
# Used for the maximum size limit of the LRU cache storing endpoints data
|
@@ -154,7 +176,7 @@ module Aws::Rekognition
|
|
154
176
|
# requests fetching endpoints information. Defaults to 60 sec.
|
155
177
|
#
|
156
178
|
# @option options [Boolean] :endpoint_discovery (false)
|
157
|
-
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
179
|
+
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
158
180
|
#
|
159
181
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
160
182
|
# The log formatter.
|
@@ -166,15 +188,29 @@ module Aws::Rekognition
|
|
166
188
|
# The Logger instance to send log messages to. If this option
|
167
189
|
# is not set, logging will be disabled.
|
168
190
|
#
|
191
|
+
# @option options [Integer] :max_attempts (3)
|
192
|
+
# An integer representing the maximum number attempts that will be made for
|
193
|
+
# a single request, including the initial attempt. For example,
|
194
|
+
# setting this value to 5 will result in a request being retried up to
|
195
|
+
# 4 times. Used in `standard` and `adaptive` retry modes.
|
196
|
+
#
|
169
197
|
# @option options [String] :profile ("default")
|
170
198
|
# Used when loading credentials from the shared credentials file
|
171
199
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
172
200
|
#
|
201
|
+
# @option options [Proc] :retry_backoff
|
202
|
+
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
203
|
+
# This option is only used in the `legacy` retry mode.
|
204
|
+
#
|
173
205
|
# @option options [Float] :retry_base_delay (0.3)
|
174
|
-
# The base delay in seconds used by the default backoff function.
|
206
|
+
# The base delay in seconds used by the default backoff function. This option
|
207
|
+
# is only used in the `legacy` retry mode.
|
175
208
|
#
|
176
209
|
# @option options [Symbol] :retry_jitter (:none)
|
177
|
-
# A delay randomiser function used by the default backoff function.
|
210
|
+
# A delay randomiser function used by the default backoff function.
|
211
|
+
# Some predefined functions can be referenced by name - :none, :equal, :full,
|
212
|
+
# otherwise a Proc that takes and returns a number. This option is only used
|
213
|
+
# in the `legacy` retry mode.
|
178
214
|
#
|
179
215
|
# @see https://www.awsarchitectureblog.com/2015/03/backoff.html
|
180
216
|
#
|
@@ -182,11 +218,30 @@ module Aws::Rekognition
|
|
182
218
|
# The maximum number of times to retry failed requests. Only
|
183
219
|
# ~ 500 level server errors and certain ~ 400 level client errors
|
184
220
|
# are retried. Generally, these are throttling errors, data
|
185
|
-
# checksum errors, networking errors, timeout errors
|
186
|
-
# errors from expired credentials.
|
221
|
+
# checksum errors, networking errors, timeout errors, auth errors,
|
222
|
+
# endpoint discovery, and errors from expired credentials.
|
223
|
+
# This option is only used in the `legacy` retry mode.
|
187
224
|
#
|
188
225
|
# @option options [Integer] :retry_max_delay (0)
|
189
|
-
# The maximum number of seconds to delay between retries (0 for no limit)
|
226
|
+
# The maximum number of seconds to delay between retries (0 for no limit)
|
227
|
+
# used by the default backoff function. This option is only used in the
|
228
|
+
# `legacy` retry mode.
|
229
|
+
#
|
230
|
+
# @option options [String] :retry_mode ("legacy")
|
231
|
+
# Specifies which retry algorithm to use. Values are:
|
232
|
+
#
|
233
|
+
# * `legacy` - The pre-existing retry behavior. This is default value if
|
234
|
+
# no retry mode is provided.
|
235
|
+
#
|
236
|
+
# * `standard` - A standardized set of retry rules across the AWS SDKs.
|
237
|
+
# This includes support for retry quotas, which limit the number of
|
238
|
+
# unsuccessful retries a client can make.
|
239
|
+
#
|
240
|
+
# * `adaptive` - An experimental retry mode that includes all the
|
241
|
+
# functionality of `standard` mode along with automatic client side
|
242
|
+
# throttling. This is a provisional mode that may change behavior
|
243
|
+
# in the future.
|
244
|
+
#
|
190
245
|
#
|
191
246
|
# @option options [String] :secret_access_key
|
192
247
|
#
|
@@ -219,16 +274,15 @@ module Aws::Rekognition
|
|
219
274
|
# requests through. Formatted like 'http://proxy.com:123'.
|
220
275
|
#
|
221
276
|
# @option options [Float] :http_open_timeout (15) The number of
|
222
|
-
# seconds to wait when opening a HTTP session before
|
277
|
+
# seconds to wait when opening a HTTP session before raising a
|
223
278
|
# `Timeout::Error`.
|
224
279
|
#
|
225
280
|
# @option options [Integer] :http_read_timeout (60) The default
|
226
281
|
# number of seconds to wait for response data. This value can
|
227
|
-
# safely be set
|
228
|
-
# per-request on the session yeidled by {#session_for}.
|
282
|
+
# safely be set per-request on the session.
|
229
283
|
#
|
230
284
|
# @option options [Float] :http_idle_timeout (5) The number of
|
231
|
-
# seconds a connection is allowed to sit
|
285
|
+
# seconds a connection is allowed to sit idle before it is
|
232
286
|
# considered stale. Stale connections are closed and removed
|
233
287
|
# from the pool before making a request.
|
234
288
|
#
|
@@ -237,7 +291,7 @@ module Aws::Rekognition
|
|
237
291
|
# request body. This option has no effect unless the request has
|
238
292
|
# "Expect" header set to "100-continue". Defaults to `nil` which
|
239
293
|
# disables this behaviour. This value can safely be set per
|
240
|
-
# request on the session
|
294
|
+
# request on the session.
|
241
295
|
#
|
242
296
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
243
297
|
# HTTP debug output will be sent to the `:logger`.
|
@@ -854,6 +908,73 @@ module Aws::Rekognition
|
|
854
908
|
req.send_request(options)
|
855
909
|
end
|
856
910
|
|
911
|
+
# Deletes an Amazon Rekognition Custom Labels project. To delete a
|
912
|
+
# project you must first delete all versions of the model associated
|
913
|
+
# with the project. To delete a version of a model, see
|
914
|
+
# DeleteProjectVersion.
|
915
|
+
#
|
916
|
+
# This operation requires permissions to perform the
|
917
|
+
# `rekognition:DeleteProject` action.
|
918
|
+
#
|
919
|
+
# @option params [required, String] :project_arn
|
920
|
+
# The Amazon Resource Name (ARN) of the project that you want to delete.
|
921
|
+
#
|
922
|
+
# @return [Types::DeleteProjectResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
923
|
+
#
|
924
|
+
# * {Types::DeleteProjectResponse#status #status} => String
|
925
|
+
#
|
926
|
+
# @example Request syntax with placeholder values
|
927
|
+
#
|
928
|
+
# resp = client.delete_project({
|
929
|
+
# project_arn: "ProjectArn", # required
|
930
|
+
# })
|
931
|
+
#
|
932
|
+
# @example Response structure
|
933
|
+
#
|
934
|
+
# resp.status #=> String, one of "CREATING", "CREATED", "DELETING"
|
935
|
+
#
|
936
|
+
# @overload delete_project(params = {})
|
937
|
+
# @param [Hash] params ({})
|
938
|
+
def delete_project(params = {}, options = {})
|
939
|
+
req = build_request(:delete_project, params)
|
940
|
+
req.send_request(options)
|
941
|
+
end
|
942
|
+
|
943
|
+
# Deletes a version of a model.
|
944
|
+
#
|
945
|
+
# You must first stop the model before you can delete it. To check if a
|
946
|
+
# model is running, use the `Status` field returned from
|
947
|
+
# DescribeProjectVersions. To stop a running model call
|
948
|
+
# StopProjectVersion.
|
949
|
+
#
|
950
|
+
# This operation requires permissions to perform the
|
951
|
+
# `rekognition:DeleteProjectVersion` action.
|
952
|
+
#
|
953
|
+
# @option params [required, String] :project_version_arn
|
954
|
+
# The Amazon Resource Name (ARN) of the model version that you want to
|
955
|
+
# delete.
|
956
|
+
#
|
957
|
+
# @return [Types::DeleteProjectVersionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
958
|
+
#
|
959
|
+
# * {Types::DeleteProjectVersionResponse#status #status} => String
|
960
|
+
#
|
961
|
+
# @example Request syntax with placeholder values
|
962
|
+
#
|
963
|
+
# resp = client.delete_project_version({
|
964
|
+
# project_version_arn: "ProjectVersionArn", # required
|
965
|
+
# })
|
966
|
+
#
|
967
|
+
# @example Response structure
|
968
|
+
#
|
969
|
+
# resp.status #=> String, one of "TRAINING_IN_PROGRESS", "TRAINING_COMPLETED", "TRAINING_FAILED", "STARTING", "RUNNING", "FAILED", "STOPPING", "STOPPED", "DELETING"
|
970
|
+
#
|
971
|
+
# @overload delete_project_version(params = {})
|
972
|
+
# @param [Hash] params ({})
|
973
|
+
def delete_project_version(params = {}, options = {})
|
974
|
+
req = build_request(:delete_project_version, params)
|
975
|
+
req.send_request(options)
|
976
|
+
end
|
977
|
+
|
857
978
|
# Deletes the stream processor identified by `Name`. You assign the
|
858
979
|
# value for `Name` when you create the stream processor with
|
859
980
|
# CreateStreamProcessor. You might not be able to use the same name for
|
@@ -950,6 +1071,8 @@ module Aws::Rekognition
|
|
950
1071
|
# * {Types::DescribeProjectVersionsResponse#project_version_descriptions #project_version_descriptions} => Array<Types::ProjectVersionDescription>
|
951
1072
|
# * {Types::DescribeProjectVersionsResponse#next_token #next_token} => String
|
952
1073
|
#
|
1074
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1075
|
+
#
|
953
1076
|
# @example Request syntax with placeholder values
|
954
1077
|
#
|
955
1078
|
# resp = client.describe_project_versions({
|
@@ -995,6 +1118,12 @@ module Aws::Rekognition
|
|
995
1118
|
# resp.project_version_descriptions[0].evaluation_result.summary.s3_object.version #=> String
|
996
1119
|
# resp.next_token #=> String
|
997
1120
|
#
|
1121
|
+
#
|
1122
|
+
# The following waiters are defined for this operation (see {Client#wait_until} for detailed usage):
|
1123
|
+
#
|
1124
|
+
# * project_version_running
|
1125
|
+
# * project_version_training_completed
|
1126
|
+
#
|
998
1127
|
# @overload describe_project_versions(params = {})
|
999
1128
|
# @param [Hash] params ({})
|
1000
1129
|
def describe_project_versions(params = {}, options = {})
|
@@ -1025,6 +1154,8 @@ module Aws::Rekognition
|
|
1025
1154
|
# * {Types::DescribeProjectsResponse#project_descriptions #project_descriptions} => Array<Types::ProjectDescription>
|
1026
1155
|
# * {Types::DescribeProjectsResponse#next_token #next_token} => String
|
1027
1156
|
#
|
1157
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
1158
|
+
#
|
1028
1159
|
# @example Request syntax with placeholder values
|
1029
1160
|
#
|
1030
1161
|
# resp = client.describe_projects({
|
@@ -1230,9 +1361,9 @@ module Aws::Rekognition
|
|
1230
1361
|
# faces or might detect faces with lower confidence.
|
1231
1362
|
#
|
1232
1363
|
# You pass the input image either as base64-encoded image bytes or as a
|
1233
|
-
# reference to an image in an Amazon S3 bucket. If you use the
|
1234
|
-
# Amazon Rekognition operations, passing image bytes is not
|
1235
|
-
# The image must be either a PNG or JPEG formatted file.
|
1364
|
+
# reference to an image in an Amazon S3 bucket. If you use the AWS CLI
|
1365
|
+
# to call Amazon Rekognition operations, passing image bytes is not
|
1366
|
+
# supported. The image must be either a PNG or JPEG formatted file.
|
1236
1367
|
#
|
1237
1368
|
# <note markdown="1"> This is a stateless API operation. That is, the operation does not
|
1238
1369
|
# persist any data.
|
@@ -1704,9 +1835,14 @@ module Aws::Rekognition
|
|
1704
1835
|
# more information, see Images in the Amazon Rekognition developer
|
1705
1836
|
# guide.
|
1706
1837
|
#
|
1838
|
+
# @option params [Types::DetectTextFilters] :filters
|
1839
|
+
# Optional parameters that let you set the criteria that the text must
|
1840
|
+
# meet to be included in your response.
|
1841
|
+
#
|
1707
1842
|
# @return [Types::DetectTextResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1708
1843
|
#
|
1709
1844
|
# * {Types::DetectTextResponse#text_detections #text_detections} => Array<Types::TextDetection>
|
1845
|
+
# * {Types::DetectTextResponse#text_model_version #text_model_version} => String
|
1710
1846
|
#
|
1711
1847
|
# @example Request syntax with placeholder values
|
1712
1848
|
#
|
@@ -1719,6 +1855,23 @@ module Aws::Rekognition
|
|
1719
1855
|
# version: "S3ObjectVersion",
|
1720
1856
|
# },
|
1721
1857
|
# },
|
1858
|
+
# filters: {
|
1859
|
+
# word_filter: {
|
1860
|
+
# min_confidence: 1.0,
|
1861
|
+
# min_bounding_box_height: 1.0,
|
1862
|
+
# min_bounding_box_width: 1.0,
|
1863
|
+
# },
|
1864
|
+
# regions_of_interest: [
|
1865
|
+
# {
|
1866
|
+
# bounding_box: {
|
1867
|
+
# width: 1.0,
|
1868
|
+
# height: 1.0,
|
1869
|
+
# left: 1.0,
|
1870
|
+
# top: 1.0,
|
1871
|
+
# },
|
1872
|
+
# },
|
1873
|
+
# ],
|
1874
|
+
# },
|
1722
1875
|
# })
|
1723
1876
|
#
|
1724
1877
|
# @example Response structure
|
@@ -1736,6 +1889,7 @@ module Aws::Rekognition
|
|
1736
1889
|
# resp.text_detections[0].geometry.polygon #=> Array
|
1737
1890
|
# resp.text_detections[0].geometry.polygon[0].x #=> Float
|
1738
1891
|
# resp.text_detections[0].geometry.polygon[0].y #=> Float
|
1892
|
+
# resp.text_model_version #=> String
|
1739
1893
|
#
|
1740
1894
|
# @overload detect_text(params = {})
|
1741
1895
|
# @param [Hash] params ({})
|
@@ -1863,6 +2017,8 @@ module Aws::Rekognition
|
|
1863
2017
|
# * {Types::GetCelebrityRecognitionResponse#next_token #next_token} => String
|
1864
2018
|
# * {Types::GetCelebrityRecognitionResponse#celebrities #celebrities} => Array<Types::CelebrityRecognition>
|
1865
2019
|
#
|
2020
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2021
|
+
#
|
1866
2022
|
# @example Request syntax with placeholder values
|
1867
2023
|
#
|
1868
2024
|
# resp = client.get_celebrity_recognition({
|
@@ -2006,6 +2162,8 @@ module Aws::Rekognition
|
|
2006
2162
|
# * {Types::GetContentModerationResponse#next_token #next_token} => String
|
2007
2163
|
# * {Types::GetContentModerationResponse#moderation_model_version #moderation_model_version} => String
|
2008
2164
|
#
|
2165
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2166
|
+
#
|
2009
2167
|
# @example Request syntax with placeholder values
|
2010
2168
|
#
|
2011
2169
|
# resp = client.get_content_moderation({
|
@@ -2088,6 +2246,8 @@ module Aws::Rekognition
|
|
2088
2246
|
# * {Types::GetFaceDetectionResponse#next_token #next_token} => String
|
2089
2247
|
# * {Types::GetFaceDetectionResponse#faces #faces} => Array<Types::FaceDetection>
|
2090
2248
|
#
|
2249
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2250
|
+
#
|
2091
2251
|
# @example Request syntax with placeholder values
|
2092
2252
|
#
|
2093
2253
|
# resp = client.get_face_detection({
|
@@ -2217,6 +2377,8 @@ module Aws::Rekognition
|
|
2217
2377
|
# * {Types::GetFaceSearchResponse#video_metadata #video_metadata} => Types::VideoMetadata
|
2218
2378
|
# * {Types::GetFaceSearchResponse#persons #persons} => Array<Types::PersonMatch>
|
2219
2379
|
#
|
2380
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2381
|
+
#
|
2220
2382
|
# @example Request syntax with placeholder values
|
2221
2383
|
#
|
2222
2384
|
# resp = client.get_face_search({
|
@@ -2363,6 +2525,8 @@ module Aws::Rekognition
|
|
2363
2525
|
# * {Types::GetLabelDetectionResponse#labels #labels} => Array<Types::LabelDetection>
|
2364
2526
|
# * {Types::GetLabelDetectionResponse#label_model_version #label_model_version} => String
|
2365
2527
|
#
|
2528
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2529
|
+
#
|
2366
2530
|
# @example Request syntax with placeholder values
|
2367
2531
|
#
|
2368
2532
|
# resp = client.get_label_detection({
|
@@ -2474,6 +2638,8 @@ module Aws::Rekognition
|
|
2474
2638
|
# * {Types::GetPersonTrackingResponse#next_token #next_token} => String
|
2475
2639
|
# * {Types::GetPersonTrackingResponse#persons #persons} => Array<Types::PersonDetection>
|
2476
2640
|
#
|
2641
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2642
|
+
#
|
2477
2643
|
# @example Request syntax with placeholder values
|
2478
2644
|
#
|
2479
2645
|
# resp = client.get_person_tracking({
|
@@ -2544,6 +2710,105 @@ module Aws::Rekognition
|
|
2544
2710
|
req.send_request(options)
|
2545
2711
|
end
|
2546
2712
|
|
2713
|
+
# Gets the text detection results of a Amazon Rekognition Video analysis
|
2714
|
+
# started by StartTextDetection.
|
2715
|
+
#
|
2716
|
+
# Text detection with Amazon Rekognition Video is an asynchronous
|
2717
|
+
# operation. You start text detection by calling StartTextDetection
|
2718
|
+
# which returns a job identifier (`JobId`) When the text detection
|
2719
|
+
# operation finishes, Amazon Rekognition publishes a completion status
|
2720
|
+
# to the Amazon Simple Notification Service topic registered in the
|
2721
|
+
# initial call to `StartTextDetection`. To get the results of the text
|
2722
|
+
# detection operation, first check that the status value published to
|
2723
|
+
# the Amazon SNS topic is `SUCCEEDED`. if so, call `GetTextDetection`
|
2724
|
+
# and pass the job identifier (`JobId`) from the initial call of
|
2725
|
+
# `StartLabelDetection`.
|
2726
|
+
#
|
2727
|
+
# `GetTextDetection` returns an array of detected text
|
2728
|
+
# (`TextDetections`) sorted by the time the text was detected, up to 50
|
2729
|
+
# words per frame of video.
|
2730
|
+
#
|
2731
|
+
# Each element of the array includes the detected text, the precentage
|
2732
|
+
# confidence in the acuracy of the detected text, the time the text was
|
2733
|
+
# detected, bounding box information for where the text was located, and
|
2734
|
+
# unique identifiers for words and their lines.
|
2735
|
+
#
|
2736
|
+
# Use MaxResults parameter to limit the number of text detections
|
2737
|
+
# returned. If there are more results than specified in `MaxResults`,
|
2738
|
+
# the value of `NextToken` in the operation response contains a
|
2739
|
+
# pagination token for getting the next set of results. To get the next
|
2740
|
+
# page of results, call `GetTextDetection` and populate the `NextToken`
|
2741
|
+
# request parameter with the token value returned from the previous call
|
2742
|
+
# to `GetTextDetection`.
|
2743
|
+
#
|
2744
|
+
# @option params [required, String] :job_id
|
2745
|
+
# Job identifier for the label detection operation for which you want
|
2746
|
+
# results returned. You get the job identifer from an initial call to
|
2747
|
+
# `StartTextDetection`.
|
2748
|
+
#
|
2749
|
+
# @option params [Integer] :max_results
|
2750
|
+
# Maximum number of results to return per paginated call. The largest
|
2751
|
+
# value you can specify is 1000.
|
2752
|
+
#
|
2753
|
+
# @option params [String] :next_token
|
2754
|
+
# If the previous response was incomplete (because there are more labels
|
2755
|
+
# to retrieve), Amazon Rekognition Video returns a pagination token in
|
2756
|
+
# the response. You can use this pagination token to retrieve the next
|
2757
|
+
# set of text.
|
2758
|
+
#
|
2759
|
+
# @return [Types::GetTextDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
2760
|
+
#
|
2761
|
+
# * {Types::GetTextDetectionResponse#job_status #job_status} => String
|
2762
|
+
# * {Types::GetTextDetectionResponse#status_message #status_message} => String
|
2763
|
+
# * {Types::GetTextDetectionResponse#video_metadata #video_metadata} => Types::VideoMetadata
|
2764
|
+
# * {Types::GetTextDetectionResponse#text_detections #text_detections} => Array<Types::TextDetectionResult>
|
2765
|
+
# * {Types::GetTextDetectionResponse#next_token #next_token} => String
|
2766
|
+
# * {Types::GetTextDetectionResponse#text_model_version #text_model_version} => String
|
2767
|
+
#
|
2768
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
2769
|
+
#
|
2770
|
+
# @example Request syntax with placeholder values
|
2771
|
+
#
|
2772
|
+
# resp = client.get_text_detection({
|
2773
|
+
# job_id: "JobId", # required
|
2774
|
+
# max_results: 1,
|
2775
|
+
# next_token: "PaginationToken",
|
2776
|
+
# })
|
2777
|
+
#
|
2778
|
+
# @example Response structure
|
2779
|
+
#
|
2780
|
+
# resp.job_status #=> String, one of "IN_PROGRESS", "SUCCEEDED", "FAILED"
|
2781
|
+
# resp.status_message #=> String
|
2782
|
+
# resp.video_metadata.codec #=> String
|
2783
|
+
# resp.video_metadata.duration_millis #=> Integer
|
2784
|
+
# resp.video_metadata.format #=> String
|
2785
|
+
# resp.video_metadata.frame_rate #=> Float
|
2786
|
+
# resp.video_metadata.frame_height #=> Integer
|
2787
|
+
# resp.video_metadata.frame_width #=> Integer
|
2788
|
+
# resp.text_detections #=> Array
|
2789
|
+
# resp.text_detections[0].timestamp #=> Integer
|
2790
|
+
# resp.text_detections[0].text_detection.detected_text #=> String
|
2791
|
+
# resp.text_detections[0].text_detection.type #=> String, one of "LINE", "WORD"
|
2792
|
+
# resp.text_detections[0].text_detection.id #=> Integer
|
2793
|
+
# resp.text_detections[0].text_detection.parent_id #=> Integer
|
2794
|
+
# resp.text_detections[0].text_detection.confidence #=> Float
|
2795
|
+
# resp.text_detections[0].text_detection.geometry.bounding_box.width #=> Float
|
2796
|
+
# resp.text_detections[0].text_detection.geometry.bounding_box.height #=> Float
|
2797
|
+
# resp.text_detections[0].text_detection.geometry.bounding_box.left #=> Float
|
2798
|
+
# resp.text_detections[0].text_detection.geometry.bounding_box.top #=> Float
|
2799
|
+
# resp.text_detections[0].text_detection.geometry.polygon #=> Array
|
2800
|
+
# resp.text_detections[0].text_detection.geometry.polygon[0].x #=> Float
|
2801
|
+
# resp.text_detections[0].text_detection.geometry.polygon[0].y #=> Float
|
2802
|
+
# resp.next_token #=> String
|
2803
|
+
# resp.text_model_version #=> String
|
2804
|
+
#
|
2805
|
+
# @overload get_text_detection(params = {})
|
2806
|
+
# @param [Hash] params ({})
|
2807
|
+
def get_text_detection(params = {}, options = {})
|
2808
|
+
req = build_request(:get_text_detection, params)
|
2809
|
+
req.send_request(options)
|
2810
|
+
end
|
2811
|
+
|
2547
2812
|
# Detects faces in the input image and adds them to the specified
|
2548
2813
|
# collection.
|
2549
2814
|
#
|
@@ -2996,6 +3261,8 @@ module Aws::Rekognition
|
|
2996
3261
|
# * {Types::ListCollectionsResponse#next_token #next_token} => String
|
2997
3262
|
# * {Types::ListCollectionsResponse#face_model_versions #face_model_versions} => Array<String>
|
2998
3263
|
#
|
3264
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3265
|
+
#
|
2999
3266
|
#
|
3000
3267
|
# @example Example: To list the collections
|
3001
3268
|
#
|
@@ -3060,6 +3327,8 @@ module Aws::Rekognition
|
|
3060
3327
|
# * {Types::ListFacesResponse#next_token #next_token} => String
|
3061
3328
|
# * {Types::ListFacesResponse#face_model_version #face_model_version} => String
|
3062
3329
|
#
|
3330
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3331
|
+
#
|
3063
3332
|
#
|
3064
3333
|
# @example Example: To list the faces in a collection
|
3065
3334
|
#
|
@@ -3244,6 +3513,8 @@ module Aws::Rekognition
|
|
3244
3513
|
# * {Types::ListStreamProcessorsResponse#next_token #next_token} => String
|
3245
3514
|
# * {Types::ListStreamProcessorsResponse#stream_processors #stream_processors} => Array<Types::StreamProcessor>
|
3246
3515
|
#
|
3516
|
+
# The returned {Seahorse::Client::Response response} is a pageable response and is Enumerable. For details on usage see {Aws::PageableResponse PageableResponse}.
|
3517
|
+
#
|
3247
3518
|
# @example Request syntax with placeholder values
|
3248
3519
|
#
|
3249
3520
|
# resp = client.list_stream_processors({
|
@@ -4228,6 +4499,98 @@ module Aws::Rekognition
|
|
4228
4499
|
req.send_request(options)
|
4229
4500
|
end
|
4230
4501
|
|
4502
|
+
# Starts asynchronous detection of text in a stored video.
|
4503
|
+
#
|
4504
|
+
# Amazon Rekognition Video can detect text in a video stored in an
|
4505
|
+
# Amazon S3 bucket. Use Video to specify the bucket name and the
|
4506
|
+
# filename of the video. `StartTextDetection` returns a job identifier
|
4507
|
+
# (`JobId`) which you use to get the results of the operation. When text
|
4508
|
+
# detection is finished, Amazon Rekognition Video publishes a completion
|
4509
|
+
# status to the Amazon Simple Notification Service topic that you
|
4510
|
+
# specify in `NotificationChannel`.
|
4511
|
+
#
|
4512
|
+
# To get the results of the text detection operation, first check that
|
4513
|
+
# the status value published to the Amazon SNS topic is `SUCCEEDED`. if
|
4514
|
+
# so, call GetTextDetection and pass the job identifier (`JobId`) from
|
4515
|
+
# the initial call to `StartTextDetection`.
|
4516
|
+
#
|
4517
|
+
# @option params [required, Types::Video] :video
|
4518
|
+
# Video file stored in an Amazon S3 bucket. Amazon Rekognition video
|
4519
|
+
# start operations such as StartLabelDetection use `Video` to specify a
|
4520
|
+
# video for analysis. The supported file formats are .mp4, .mov and
|
4521
|
+
# .avi.
|
4522
|
+
#
|
4523
|
+
# @option params [String] :client_request_token
|
4524
|
+
# Idempotent token used to identify the start request. If you use the
|
4525
|
+
# same token with multiple `StartTextDetection` requests, the same
|
4526
|
+
# `JobId` is returned. Use `ClientRequestToken` to prevent the same job
|
4527
|
+
# from being accidentaly started more than once.
|
4528
|
+
#
|
4529
|
+
# @option params [Types::NotificationChannel] :notification_channel
|
4530
|
+
# The Amazon Simple Notification Service topic to which Amazon
|
4531
|
+
# Rekognition publishes the completion status of a video analysis
|
4532
|
+
# operation. For more information, see api-video.
|
4533
|
+
#
|
4534
|
+
# @option params [String] :job_tag
|
4535
|
+
# An identifier returned in the completion status published by your
|
4536
|
+
# Amazon Simple Notification Service topic. For example, you can use
|
4537
|
+
# `JobTag` to group related jobs and identify them in the completion
|
4538
|
+
# notification.
|
4539
|
+
#
|
4540
|
+
# @option params [Types::StartTextDetectionFilters] :filters
|
4541
|
+
# Optional parameters that let you set criteria the text must meet to be
|
4542
|
+
# included in your response.
|
4543
|
+
#
|
4544
|
+
# @return [Types::StartTextDetectionResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
4545
|
+
#
|
4546
|
+
# * {Types::StartTextDetectionResponse#job_id #job_id} => String
|
4547
|
+
#
|
4548
|
+
# @example Request syntax with placeholder values
|
4549
|
+
#
|
4550
|
+
# resp = client.start_text_detection({
|
4551
|
+
# video: { # required
|
4552
|
+
# s3_object: {
|
4553
|
+
# bucket: "S3Bucket",
|
4554
|
+
# name: "S3ObjectName",
|
4555
|
+
# version: "S3ObjectVersion",
|
4556
|
+
# },
|
4557
|
+
# },
|
4558
|
+
# client_request_token: "ClientRequestToken",
|
4559
|
+
# notification_channel: {
|
4560
|
+
# sns_topic_arn: "SNSTopicArn", # required
|
4561
|
+
# role_arn: "RoleArn", # required
|
4562
|
+
# },
|
4563
|
+
# job_tag: "JobTag",
|
4564
|
+
# filters: {
|
4565
|
+
# word_filter: {
|
4566
|
+
# min_confidence: 1.0,
|
4567
|
+
# min_bounding_box_height: 1.0,
|
4568
|
+
# min_bounding_box_width: 1.0,
|
4569
|
+
# },
|
4570
|
+
# regions_of_interest: [
|
4571
|
+
# {
|
4572
|
+
# bounding_box: {
|
4573
|
+
# width: 1.0,
|
4574
|
+
# height: 1.0,
|
4575
|
+
# left: 1.0,
|
4576
|
+
# top: 1.0,
|
4577
|
+
# },
|
4578
|
+
# },
|
4579
|
+
# ],
|
4580
|
+
# },
|
4581
|
+
# })
|
4582
|
+
#
|
4583
|
+
# @example Response structure
|
4584
|
+
#
|
4585
|
+
# resp.job_id #=> String
|
4586
|
+
#
|
4587
|
+
# @overload start_text_detection(params = {})
|
4588
|
+
# @param [Hash] params ({})
|
4589
|
+
def start_text_detection(params = {}, options = {})
|
4590
|
+
req = build_request(:start_text_detection, params)
|
4591
|
+
req.send_request(options)
|
4592
|
+
end
|
4593
|
+
|
4231
4594
|
# Stops a running model. The operation might take a while to complete.
|
4232
4595
|
# To check the current status, call DescribeProjectVersions.
|
4233
4596
|
#
|
@@ -4293,7 +4656,7 @@ module Aws::Rekognition
|
|
4293
4656
|
params: params,
|
4294
4657
|
config: config)
|
4295
4658
|
context[:gem_name] = 'aws-sdk-rekognition'
|
4296
|
-
context[:gem_version] = '1.
|
4659
|
+
context[:gem_version] = '1.38.0'
|
4297
4660
|
Seahorse::Client::Request.new(handlers, context)
|
4298
4661
|
end
|
4299
4662
|
|
@@ -4359,10 +4722,10 @@ module Aws::Rekognition
|
|
4359
4722
|
# The following table lists the valid waiter names, the operations they call,
|
4360
4723
|
# and the default `:delay` and `:max_attempts` values.
|
4361
4724
|
#
|
4362
|
-
# | waiter_name | params
|
4363
|
-
# | ---------------------------------- |
|
4364
|
-
# | project_version_running | {#describe_project_versions} | 30 | 40 |
|
4365
|
-
# | project_version_training_completed | {#describe_project_versions} | 120 | 360 |
|
4725
|
+
# | waiter_name | params | :delay | :max_attempts |
|
4726
|
+
# | ---------------------------------- | ---------------------------------- | -------- | ------------- |
|
4727
|
+
# | project_version_running | {Client#describe_project_versions} | 30 | 40 |
|
4728
|
+
# | project_version_training_completed | {Client#describe_project_versions} | 120 | 360 |
|
4366
4729
|
#
|
4367
4730
|
# @raise [Errors::FailureStateError] Raised when the waiter terminates
|
4368
4731
|
# because the waiter has entered a state that it will not transition
|