aws-sdk-rekognition 1.92.0 → 1.94.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/CHANGELOG.md +10 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-rekognition/client.rb +4 -1
- data/lib/aws-sdk-rekognition/client_api.rb +1 -0
- data/lib/aws-sdk-rekognition/plugins/endpoints.rb +1 -0
- data/lib/aws-sdk-rekognition/types.rb +14 -2
- data/lib/aws-sdk-rekognition.rb +1 -1
- data/sig/client.rbs +1537 -0
- data/sig/errors.rbs +65 -0
- data/sig/resource.rbs +80 -0
- data/sig/types.rbs +2136 -0
- data/sig/waiters.rbs +39 -0
- metadata +9 -4
data/sig/client.rbs
ADDED
@@ -0,0 +1,1537 @@
|
|
1
|
+
# WARNING ABOUT GENERATED CODE
|
2
|
+
#
|
3
|
+
# This file is generated. See the contributing guide for more information:
|
4
|
+
# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
|
5
|
+
#
|
6
|
+
# WARNING ABOUT GENERATED CODE
|
7
|
+
|
8
|
+
module Aws
|
9
|
+
module Rekognition
|
10
|
+
class Client < ::Seahorse::Client::Base
|
11
|
+
include ::Aws::ClientStubs
|
12
|
+
|
13
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#initialize-instance_method
|
14
|
+
def self.new: (
|
15
|
+
?credentials: untyped,
|
16
|
+
?region: String,
|
17
|
+
?access_key_id: String,
|
18
|
+
?active_endpoint_cache: bool,
|
19
|
+
?adaptive_retry_wait_to_fill: bool,
|
20
|
+
?client_side_monitoring: bool,
|
21
|
+
?client_side_monitoring_client_id: String,
|
22
|
+
?client_side_monitoring_host: String,
|
23
|
+
?client_side_monitoring_port: Integer,
|
24
|
+
?client_side_monitoring_publisher: untyped,
|
25
|
+
?convert_params: bool,
|
26
|
+
?correct_clock_skew: bool,
|
27
|
+
?defaults_mode: String,
|
28
|
+
?disable_host_prefix_injection: bool,
|
29
|
+
?disable_request_compression: bool,
|
30
|
+
?endpoint: String,
|
31
|
+
?endpoint_cache_max_entries: Integer,
|
32
|
+
?endpoint_cache_max_threads: Integer,
|
33
|
+
?endpoint_cache_poll_interval: Integer,
|
34
|
+
?endpoint_discovery: bool,
|
35
|
+
?ignore_configured_endpoint_urls: bool,
|
36
|
+
?log_formatter: untyped,
|
37
|
+
?log_level: Symbol,
|
38
|
+
?logger: untyped,
|
39
|
+
?max_attempts: Integer,
|
40
|
+
?profile: String,
|
41
|
+
?request_min_compression_size_bytes: Integer,
|
42
|
+
?retry_backoff: Proc,
|
43
|
+
?retry_base_delay: Float,
|
44
|
+
?retry_jitter: (:none | :equal | :full | ^(Integer) -> Integer),
|
45
|
+
?retry_limit: Integer,
|
46
|
+
?retry_max_delay: Integer,
|
47
|
+
?retry_mode: ("legacy" | "standard" | "adaptive"),
|
48
|
+
?sdk_ua_app_id: String,
|
49
|
+
?secret_access_key: String,
|
50
|
+
?session_token: String,
|
51
|
+
?simple_json: bool,
|
52
|
+
?stub_responses: untyped,
|
53
|
+
?token_provider: untyped,
|
54
|
+
?use_dualstack_endpoint: bool,
|
55
|
+
?use_fips_endpoint: bool,
|
56
|
+
?validate_params: bool,
|
57
|
+
?endpoint_provider: untyped,
|
58
|
+
?http_proxy: String,
|
59
|
+
?http_open_timeout: (Float | Integer),
|
60
|
+
?http_read_timeout: (Float | Integer),
|
61
|
+
?http_idle_timeout: (Float | Integer),
|
62
|
+
?http_continue_timeout: (Float | Integer),
|
63
|
+
?ssl_timeout: (Float | Integer | nil),
|
64
|
+
?http_wire_trace: bool,
|
65
|
+
?ssl_verify_peer: bool,
|
66
|
+
?ssl_ca_bundle: String,
|
67
|
+
?ssl_ca_directory: String,
|
68
|
+
?ssl_ca_store: String,
|
69
|
+
?on_chunk_received: Proc,
|
70
|
+
?on_chunk_sent: Proc,
|
71
|
+
?raise_response_errors: bool
|
72
|
+
) -> instance
|
73
|
+
| (?Hash[Symbol, untyped]) -> instance
|
74
|
+
|
75
|
+
|
76
|
+
interface _AssociateFacesResponseSuccess
|
77
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::AssociateFacesResponse]
|
78
|
+
def associated_faces: () -> ::Array[Types::AssociatedFace]
|
79
|
+
def unsuccessful_face_associations: () -> ::Array[Types::UnsuccessfulFaceAssociation]
|
80
|
+
def user_status: () -> ("ACTIVE" | "UPDATING" | "CREATING" | "CREATED")
|
81
|
+
end
|
82
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#associate_faces-instance_method
|
83
|
+
def associate_faces: (
|
84
|
+
collection_id: ::String,
|
85
|
+
user_id: ::String,
|
86
|
+
face_ids: Array[::String],
|
87
|
+
?user_match_threshold: ::Float,
|
88
|
+
?client_request_token: ::String
|
89
|
+
) -> _AssociateFacesResponseSuccess
|
90
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _AssociateFacesResponseSuccess
|
91
|
+
|
92
|
+
interface _CompareFacesResponseSuccess
|
93
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CompareFacesResponse]
|
94
|
+
def source_image_face: () -> Types::ComparedSourceImageFace
|
95
|
+
def face_matches: () -> ::Array[Types::CompareFacesMatch]
|
96
|
+
def unmatched_faces: () -> ::Array[Types::ComparedFace]
|
97
|
+
def source_image_orientation_correction: () -> ("ROTATE_0" | "ROTATE_90" | "ROTATE_180" | "ROTATE_270")
|
98
|
+
def target_image_orientation_correction: () -> ("ROTATE_0" | "ROTATE_90" | "ROTATE_180" | "ROTATE_270")
|
99
|
+
end
|
100
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#compare_faces-instance_method
|
101
|
+
def compare_faces: (
|
102
|
+
source_image: {
|
103
|
+
bytes: ::String?,
|
104
|
+
s3_object: {
|
105
|
+
bucket: ::String?,
|
106
|
+
name: ::String?,
|
107
|
+
version: ::String?
|
108
|
+
}?
|
109
|
+
},
|
110
|
+
target_image: {
|
111
|
+
bytes: ::String?,
|
112
|
+
s3_object: {
|
113
|
+
bucket: ::String?,
|
114
|
+
name: ::String?,
|
115
|
+
version: ::String?
|
116
|
+
}?
|
117
|
+
},
|
118
|
+
?similarity_threshold: ::Float,
|
119
|
+
?quality_filter: ("NONE" | "AUTO" | "LOW" | "MEDIUM" | "HIGH")
|
120
|
+
) -> _CompareFacesResponseSuccess
|
121
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CompareFacesResponseSuccess
|
122
|
+
|
123
|
+
interface _CopyProjectVersionResponseSuccess
|
124
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CopyProjectVersionResponse]
|
125
|
+
def project_version_arn: () -> ::String
|
126
|
+
end
|
127
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#copy_project_version-instance_method
|
128
|
+
def copy_project_version: (
|
129
|
+
source_project_arn: ::String,
|
130
|
+
source_project_version_arn: ::String,
|
131
|
+
destination_project_arn: ::String,
|
132
|
+
version_name: ::String,
|
133
|
+
output_config: {
|
134
|
+
s3_bucket: ::String?,
|
135
|
+
s3_key_prefix: ::String?
|
136
|
+
},
|
137
|
+
?tags: Hash[::String, ::String],
|
138
|
+
?kms_key_id: ::String
|
139
|
+
) -> _CopyProjectVersionResponseSuccess
|
140
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CopyProjectVersionResponseSuccess
|
141
|
+
|
142
|
+
interface _CreateCollectionResponseSuccess
|
143
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateCollectionResponse]
|
144
|
+
def status_code: () -> ::Integer
|
145
|
+
def collection_arn: () -> ::String
|
146
|
+
def face_model_version: () -> ::String
|
147
|
+
end
|
148
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#create_collection-instance_method
|
149
|
+
def create_collection: (
|
150
|
+
collection_id: ::String,
|
151
|
+
?tags: Hash[::String, ::String]
|
152
|
+
) -> _CreateCollectionResponseSuccess
|
153
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateCollectionResponseSuccess
|
154
|
+
|
155
|
+
interface _CreateDatasetResponseSuccess
|
156
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateDatasetResponse]
|
157
|
+
def dataset_arn: () -> ::String
|
158
|
+
end
|
159
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#create_dataset-instance_method
|
160
|
+
def create_dataset: (
|
161
|
+
?dataset_source: {
|
162
|
+
ground_truth_manifest: {
|
163
|
+
s3_object: {
|
164
|
+
bucket: ::String?,
|
165
|
+
name: ::String?,
|
166
|
+
version: ::String?
|
167
|
+
}?
|
168
|
+
}?,
|
169
|
+
dataset_arn: ::String?
|
170
|
+
},
|
171
|
+
dataset_type: ("TRAIN" | "TEST"),
|
172
|
+
project_arn: ::String
|
173
|
+
) -> _CreateDatasetResponseSuccess
|
174
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateDatasetResponseSuccess
|
175
|
+
|
176
|
+
interface _CreateFaceLivenessSessionResponseSuccess
|
177
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateFaceLivenessSessionResponse]
|
178
|
+
def session_id: () -> ::String
|
179
|
+
end
|
180
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#create_face_liveness_session-instance_method
|
181
|
+
def create_face_liveness_session: (
|
182
|
+
?kms_key_id: ::String,
|
183
|
+
?settings: {
|
184
|
+
output_config: {
|
185
|
+
s3_bucket: ::String,
|
186
|
+
s3_key_prefix: ::String?
|
187
|
+
}?,
|
188
|
+
audit_images_limit: ::Integer?
|
189
|
+
},
|
190
|
+
?client_request_token: ::String
|
191
|
+
) -> _CreateFaceLivenessSessionResponseSuccess
|
192
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateFaceLivenessSessionResponseSuccess
|
193
|
+
|
194
|
+
interface _CreateProjectResponseSuccess
|
195
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateProjectResponse]
|
196
|
+
def project_arn: () -> ::String
|
197
|
+
end
|
198
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#create_project-instance_method
|
199
|
+
def create_project: (
|
200
|
+
project_name: ::String,
|
201
|
+
?feature: ("CONTENT_MODERATION" | "CUSTOM_LABELS"),
|
202
|
+
?auto_update: ("ENABLED" | "DISABLED")
|
203
|
+
) -> _CreateProjectResponseSuccess
|
204
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateProjectResponseSuccess
|
205
|
+
|
206
|
+
interface _CreateProjectVersionResponseSuccess
|
207
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateProjectVersionResponse]
|
208
|
+
def project_version_arn: () -> ::String
|
209
|
+
end
|
210
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#create_project_version-instance_method
|
211
|
+
def create_project_version: (
|
212
|
+
project_arn: ::String,
|
213
|
+
version_name: ::String,
|
214
|
+
output_config: {
|
215
|
+
s3_bucket: ::String?,
|
216
|
+
s3_key_prefix: ::String?
|
217
|
+
},
|
218
|
+
?training_data: {
|
219
|
+
assets: Array[
|
220
|
+
{
|
221
|
+
ground_truth_manifest: {
|
222
|
+
s3_object: {
|
223
|
+
bucket: ::String?,
|
224
|
+
name: ::String?,
|
225
|
+
version: ::String?
|
226
|
+
}?
|
227
|
+
}?
|
228
|
+
},
|
229
|
+
]?
|
230
|
+
},
|
231
|
+
?testing_data: {
|
232
|
+
assets: Array[
|
233
|
+
{
|
234
|
+
ground_truth_manifest: {
|
235
|
+
s3_object: {
|
236
|
+
bucket: ::String?,
|
237
|
+
name: ::String?,
|
238
|
+
version: ::String?
|
239
|
+
}?
|
240
|
+
}?
|
241
|
+
},
|
242
|
+
]?,
|
243
|
+
auto_create: bool?
|
244
|
+
},
|
245
|
+
?tags: Hash[::String, ::String],
|
246
|
+
?kms_key_id: ::String,
|
247
|
+
?version_description: ::String,
|
248
|
+
?feature_config: {
|
249
|
+
content_moderation: {
|
250
|
+
confidence_threshold: ::Float?
|
251
|
+
}?
|
252
|
+
}
|
253
|
+
) -> _CreateProjectVersionResponseSuccess
|
254
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateProjectVersionResponseSuccess
|
255
|
+
|
256
|
+
interface _CreateStreamProcessorResponseSuccess
|
257
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateStreamProcessorResponse]
|
258
|
+
def stream_processor_arn: () -> ::String
|
259
|
+
end
|
260
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#create_stream_processor-instance_method
|
261
|
+
def create_stream_processor: (
|
262
|
+
input: {
|
263
|
+
kinesis_video_stream: {
|
264
|
+
arn: ::String?
|
265
|
+
}?
|
266
|
+
},
|
267
|
+
output: {
|
268
|
+
kinesis_data_stream: {
|
269
|
+
arn: ::String?
|
270
|
+
}?,
|
271
|
+
s3_destination: {
|
272
|
+
bucket: ::String?,
|
273
|
+
key_prefix: ::String?
|
274
|
+
}?
|
275
|
+
},
|
276
|
+
name: ::String,
|
277
|
+
settings: {
|
278
|
+
face_search: {
|
279
|
+
collection_id: ::String?,
|
280
|
+
face_match_threshold: ::Float?
|
281
|
+
}?,
|
282
|
+
connected_home: {
|
283
|
+
labels: Array[::String],
|
284
|
+
min_confidence: ::Float?
|
285
|
+
}?
|
286
|
+
},
|
287
|
+
role_arn: ::String,
|
288
|
+
?tags: Hash[::String, ::String],
|
289
|
+
?notification_channel: {
|
290
|
+
sns_topic_arn: ::String
|
291
|
+
},
|
292
|
+
?kms_key_id: ::String,
|
293
|
+
?regions_of_interest: Array[
|
294
|
+
{
|
295
|
+
bounding_box: {
|
296
|
+
width: ::Float?,
|
297
|
+
height: ::Float?,
|
298
|
+
left: ::Float?,
|
299
|
+
top: ::Float?
|
300
|
+
}?,
|
301
|
+
polygon: Array[
|
302
|
+
{
|
303
|
+
x: ::Float?,
|
304
|
+
y: ::Float?
|
305
|
+
},
|
306
|
+
]?
|
307
|
+
},
|
308
|
+
],
|
309
|
+
?data_sharing_preference: {
|
310
|
+
opt_in: bool
|
311
|
+
}
|
312
|
+
) -> _CreateStreamProcessorResponseSuccess
|
313
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateStreamProcessorResponseSuccess
|
314
|
+
|
315
|
+
interface _CreateUserResponseSuccess
|
316
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::CreateUserResponse]
|
317
|
+
end
|
318
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#create_user-instance_method
|
319
|
+
def create_user: (
|
320
|
+
collection_id: ::String,
|
321
|
+
user_id: ::String,
|
322
|
+
?client_request_token: ::String
|
323
|
+
) -> _CreateUserResponseSuccess
|
324
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _CreateUserResponseSuccess
|
325
|
+
|
326
|
+
interface _DeleteCollectionResponseSuccess
|
327
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteCollectionResponse]
|
328
|
+
def status_code: () -> ::Integer
|
329
|
+
end
|
330
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_collection-instance_method
|
331
|
+
def delete_collection: (
|
332
|
+
collection_id: ::String
|
333
|
+
) -> _DeleteCollectionResponseSuccess
|
334
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteCollectionResponseSuccess
|
335
|
+
|
336
|
+
interface _DeleteDatasetResponseSuccess
|
337
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteDatasetResponse]
|
338
|
+
end
|
339
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_dataset-instance_method
|
340
|
+
def delete_dataset: (
|
341
|
+
dataset_arn: ::String
|
342
|
+
) -> _DeleteDatasetResponseSuccess
|
343
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteDatasetResponseSuccess
|
344
|
+
|
345
|
+
interface _DeleteFacesResponseSuccess
|
346
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteFacesResponse]
|
347
|
+
def deleted_faces: () -> ::Array[::String]
|
348
|
+
def unsuccessful_face_deletions: () -> ::Array[Types::UnsuccessfulFaceDeletion]
|
349
|
+
end
|
350
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_faces-instance_method
|
351
|
+
def delete_faces: (
|
352
|
+
collection_id: ::String,
|
353
|
+
face_ids: Array[::String]
|
354
|
+
) -> _DeleteFacesResponseSuccess
|
355
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteFacesResponseSuccess
|
356
|
+
|
357
|
+
interface _DeleteProjectResponseSuccess
|
358
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteProjectResponse]
|
359
|
+
def status: () -> ("CREATING" | "CREATED" | "DELETING")
|
360
|
+
end
|
361
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_project-instance_method
|
362
|
+
def delete_project: (
|
363
|
+
project_arn: ::String
|
364
|
+
) -> _DeleteProjectResponseSuccess
|
365
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteProjectResponseSuccess
|
366
|
+
|
367
|
+
interface _DeleteProjectPolicyResponseSuccess
|
368
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteProjectPolicyResponse]
|
369
|
+
end
|
370
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_project_policy-instance_method
|
371
|
+
def delete_project_policy: (
|
372
|
+
project_arn: ::String,
|
373
|
+
policy_name: ::String,
|
374
|
+
?policy_revision_id: ::String
|
375
|
+
) -> _DeleteProjectPolicyResponseSuccess
|
376
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteProjectPolicyResponseSuccess
|
377
|
+
|
378
|
+
interface _DeleteProjectVersionResponseSuccess
|
379
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteProjectVersionResponse]
|
380
|
+
def status: () -> ("TRAINING_IN_PROGRESS" | "TRAINING_COMPLETED" | "TRAINING_FAILED" | "STARTING" | "RUNNING" | "FAILED" | "STOPPING" | "STOPPED" | "DELETING" | "COPYING_IN_PROGRESS" | "COPYING_COMPLETED" | "COPYING_FAILED" | "DEPRECATED" | "EXPIRED")
|
381
|
+
end
|
382
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_project_version-instance_method
|
383
|
+
def delete_project_version: (
|
384
|
+
project_version_arn: ::String
|
385
|
+
) -> _DeleteProjectVersionResponseSuccess
|
386
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteProjectVersionResponseSuccess
|
387
|
+
|
388
|
+
interface _DeleteStreamProcessorResponseSuccess
|
389
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteStreamProcessorResponse]
|
390
|
+
end
|
391
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_stream_processor-instance_method
|
392
|
+
def delete_stream_processor: (
|
393
|
+
name: ::String
|
394
|
+
) -> _DeleteStreamProcessorResponseSuccess
|
395
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteStreamProcessorResponseSuccess
|
396
|
+
|
397
|
+
interface _DeleteUserResponseSuccess
|
398
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DeleteUserResponse]
|
399
|
+
end
|
400
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#delete_user-instance_method
|
401
|
+
def delete_user: (
|
402
|
+
collection_id: ::String,
|
403
|
+
user_id: ::String,
|
404
|
+
?client_request_token: ::String
|
405
|
+
) -> _DeleteUserResponseSuccess
|
406
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DeleteUserResponseSuccess
|
407
|
+
|
408
|
+
interface _DescribeCollectionResponseSuccess
|
409
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeCollectionResponse]
|
410
|
+
def face_count: () -> ::Integer
|
411
|
+
def face_model_version: () -> ::String
|
412
|
+
def collection_arn: () -> ::String
|
413
|
+
def creation_timestamp: () -> ::Time
|
414
|
+
def user_count: () -> ::Integer
|
415
|
+
end
|
416
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#describe_collection-instance_method
|
417
|
+
def describe_collection: (
|
418
|
+
collection_id: ::String
|
419
|
+
) -> _DescribeCollectionResponseSuccess
|
420
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeCollectionResponseSuccess
|
421
|
+
|
422
|
+
interface _DescribeDatasetResponseSuccess
|
423
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeDatasetResponse]
|
424
|
+
def dataset_description: () -> Types::DatasetDescription
|
425
|
+
end
|
426
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#describe_dataset-instance_method
|
427
|
+
def describe_dataset: (
|
428
|
+
dataset_arn: ::String
|
429
|
+
) -> _DescribeDatasetResponseSuccess
|
430
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeDatasetResponseSuccess
|
431
|
+
|
432
|
+
interface _DescribeProjectVersionsResponseSuccess
|
433
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeProjectVersionsResponse]
|
434
|
+
def project_version_descriptions: () -> ::Array[Types::ProjectVersionDescription]
|
435
|
+
def next_token: () -> ::String
|
436
|
+
end
|
437
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#describe_project_versions-instance_method
|
438
|
+
def describe_project_versions: (
|
439
|
+
project_arn: ::String,
|
440
|
+
?version_names: Array[::String],
|
441
|
+
?next_token: ::String,
|
442
|
+
?max_results: ::Integer
|
443
|
+
) -> _DescribeProjectVersionsResponseSuccess
|
444
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeProjectVersionsResponseSuccess
|
445
|
+
|
446
|
+
interface _DescribeProjectsResponseSuccess
|
447
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeProjectsResponse]
|
448
|
+
def project_descriptions: () -> ::Array[Types::ProjectDescription]
|
449
|
+
def next_token: () -> ::String
|
450
|
+
end
|
451
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#describe_projects-instance_method
|
452
|
+
def describe_projects: (
|
453
|
+
?next_token: ::String,
|
454
|
+
?max_results: ::Integer,
|
455
|
+
?project_names: Array[::String],
|
456
|
+
?features: Array[("CONTENT_MODERATION" | "CUSTOM_LABELS")]
|
457
|
+
) -> _DescribeProjectsResponseSuccess
|
458
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeProjectsResponseSuccess
|
459
|
+
|
460
|
+
interface _DescribeStreamProcessorResponseSuccess
|
461
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DescribeStreamProcessorResponse]
|
462
|
+
def name: () -> ::String
|
463
|
+
def stream_processor_arn: () -> ::String
|
464
|
+
def status: () -> ("STOPPED" | "STARTING" | "RUNNING" | "FAILED" | "STOPPING" | "UPDATING")
|
465
|
+
def status_message: () -> ::String
|
466
|
+
def creation_timestamp: () -> ::Time
|
467
|
+
def last_update_timestamp: () -> ::Time
|
468
|
+
def input: () -> Types::StreamProcessorInput
|
469
|
+
def output: () -> Types::StreamProcessorOutput
|
470
|
+
def role_arn: () -> ::String
|
471
|
+
def settings: () -> Types::StreamProcessorSettings
|
472
|
+
def notification_channel: () -> Types::StreamProcessorNotificationChannel
|
473
|
+
def kms_key_id: () -> ::String
|
474
|
+
def regions_of_interest: () -> ::Array[Types::RegionOfInterest]
|
475
|
+
def data_sharing_preference: () -> Types::StreamProcessorDataSharingPreference
|
476
|
+
end
|
477
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#describe_stream_processor-instance_method
|
478
|
+
def describe_stream_processor: (
|
479
|
+
name: ::String
|
480
|
+
) -> _DescribeStreamProcessorResponseSuccess
|
481
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DescribeStreamProcessorResponseSuccess
|
482
|
+
|
483
|
+
interface _DetectCustomLabelsResponseSuccess
|
484
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DetectCustomLabelsResponse]
|
485
|
+
def custom_labels: () -> ::Array[Types::CustomLabel]
|
486
|
+
end
|
487
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#detect_custom_labels-instance_method
|
488
|
+
def detect_custom_labels: (
|
489
|
+
project_version_arn: ::String,
|
490
|
+
image: {
|
491
|
+
bytes: ::String?,
|
492
|
+
s3_object: {
|
493
|
+
bucket: ::String?,
|
494
|
+
name: ::String?,
|
495
|
+
version: ::String?
|
496
|
+
}?
|
497
|
+
},
|
498
|
+
?max_results: ::Integer,
|
499
|
+
?min_confidence: ::Float
|
500
|
+
) -> _DetectCustomLabelsResponseSuccess
|
501
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DetectCustomLabelsResponseSuccess
|
502
|
+
|
503
|
+
interface _DetectFacesResponseSuccess
|
504
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DetectFacesResponse]
|
505
|
+
def face_details: () -> ::Array[Types::FaceDetail]
|
506
|
+
def orientation_correction: () -> ("ROTATE_0" | "ROTATE_90" | "ROTATE_180" | "ROTATE_270")
|
507
|
+
end
|
508
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#detect_faces-instance_method
|
509
|
+
def detect_faces: (
|
510
|
+
image: {
|
511
|
+
bytes: ::String?,
|
512
|
+
s3_object: {
|
513
|
+
bucket: ::String?,
|
514
|
+
name: ::String?,
|
515
|
+
version: ::String?
|
516
|
+
}?
|
517
|
+
},
|
518
|
+
?attributes: Array[("DEFAULT" | "ALL" | "AGE_RANGE" | "BEARD" | "EMOTIONS" | "EYE_DIRECTION" | "EYEGLASSES" | "EYES_OPEN" | "GENDER" | "MOUTH_OPEN" | "MUSTACHE" | "FACE_OCCLUDED" | "SMILE" | "SUNGLASSES")]
|
519
|
+
) -> _DetectFacesResponseSuccess
|
520
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DetectFacesResponseSuccess
|
521
|
+
|
522
|
+
interface _DetectLabelsResponseSuccess
|
523
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DetectLabelsResponse]
|
524
|
+
def labels: () -> ::Array[Types::Label]
|
525
|
+
def orientation_correction: () -> ("ROTATE_0" | "ROTATE_90" | "ROTATE_180" | "ROTATE_270")
|
526
|
+
def label_model_version: () -> ::String
|
527
|
+
def image_properties: () -> Types::DetectLabelsImageProperties
|
528
|
+
end
|
529
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#detect_labels-instance_method
|
530
|
+
def detect_labels: (
|
531
|
+
image: {
|
532
|
+
bytes: ::String?,
|
533
|
+
s3_object: {
|
534
|
+
bucket: ::String?,
|
535
|
+
name: ::String?,
|
536
|
+
version: ::String?
|
537
|
+
}?
|
538
|
+
},
|
539
|
+
?max_labels: ::Integer,
|
540
|
+
?min_confidence: ::Float,
|
541
|
+
?features: Array[("GENERAL_LABELS" | "IMAGE_PROPERTIES")],
|
542
|
+
?settings: {
|
543
|
+
general_labels: {
|
544
|
+
label_inclusion_filters: Array[::String]?,
|
545
|
+
label_exclusion_filters: Array[::String]?,
|
546
|
+
label_category_inclusion_filters: Array[::String]?,
|
547
|
+
label_category_exclusion_filters: Array[::String]?
|
548
|
+
}?,
|
549
|
+
image_properties: {
|
550
|
+
max_dominant_colors: ::Integer?
|
551
|
+
}?
|
552
|
+
}
|
553
|
+
) -> _DetectLabelsResponseSuccess
|
554
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DetectLabelsResponseSuccess
|
555
|
+
|
556
|
+
interface _DetectModerationLabelsResponseSuccess
|
557
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DetectModerationLabelsResponse]
|
558
|
+
def moderation_labels: () -> ::Array[Types::ModerationLabel]
|
559
|
+
def moderation_model_version: () -> ::String
|
560
|
+
def human_loop_activation_output: () -> Types::HumanLoopActivationOutput
|
561
|
+
def project_version: () -> ::String
|
562
|
+
def content_types: () -> ::Array[Types::ContentType]
|
563
|
+
end
|
564
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#detect_moderation_labels-instance_method
|
565
|
+
def detect_moderation_labels: (
|
566
|
+
image: {
|
567
|
+
bytes: ::String?,
|
568
|
+
s3_object: {
|
569
|
+
bucket: ::String?,
|
570
|
+
name: ::String?,
|
571
|
+
version: ::String?
|
572
|
+
}?
|
573
|
+
},
|
574
|
+
?min_confidence: ::Float,
|
575
|
+
?human_loop_config: {
|
576
|
+
human_loop_name: ::String,
|
577
|
+
flow_definition_arn: ::String,
|
578
|
+
data_attributes: {
|
579
|
+
content_classifiers: Array[("FreeOfPersonallyIdentifiableInformation" | "FreeOfAdultContent")]?
|
580
|
+
}?
|
581
|
+
},
|
582
|
+
?project_version: ::String
|
583
|
+
) -> _DetectModerationLabelsResponseSuccess
|
584
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DetectModerationLabelsResponseSuccess
|
585
|
+
|
586
|
+
interface _DetectProtectiveEquipmentResponseSuccess
|
587
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DetectProtectiveEquipmentResponse]
|
588
|
+
def protective_equipment_model_version: () -> ::String
|
589
|
+
def persons: () -> ::Array[Types::ProtectiveEquipmentPerson]
|
590
|
+
def summary: () -> Types::ProtectiveEquipmentSummary
|
591
|
+
end
|
592
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#detect_protective_equipment-instance_method
|
593
|
+
def detect_protective_equipment: (
|
594
|
+
image: {
|
595
|
+
bytes: ::String?,
|
596
|
+
s3_object: {
|
597
|
+
bucket: ::String?,
|
598
|
+
name: ::String?,
|
599
|
+
version: ::String?
|
600
|
+
}?
|
601
|
+
},
|
602
|
+
?summarization_attributes: {
|
603
|
+
min_confidence: ::Float,
|
604
|
+
required_equipment_types: Array[("FACE_COVER" | "HAND_COVER" | "HEAD_COVER")]
|
605
|
+
}
|
606
|
+
) -> _DetectProtectiveEquipmentResponseSuccess
|
607
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DetectProtectiveEquipmentResponseSuccess
|
608
|
+
|
609
|
+
interface _DetectTextResponseSuccess
|
610
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DetectTextResponse]
|
611
|
+
def text_detections: () -> ::Array[Types::TextDetection]
|
612
|
+
def text_model_version: () -> ::String
|
613
|
+
end
|
614
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#detect_text-instance_method
|
615
|
+
def detect_text: (
|
616
|
+
image: {
|
617
|
+
bytes: ::String?,
|
618
|
+
s3_object: {
|
619
|
+
bucket: ::String?,
|
620
|
+
name: ::String?,
|
621
|
+
version: ::String?
|
622
|
+
}?
|
623
|
+
},
|
624
|
+
?filters: {
|
625
|
+
word_filter: {
|
626
|
+
min_confidence: ::Float?,
|
627
|
+
min_bounding_box_height: ::Float?,
|
628
|
+
min_bounding_box_width: ::Float?
|
629
|
+
}?,
|
630
|
+
regions_of_interest: Array[
|
631
|
+
{
|
632
|
+
bounding_box: {
|
633
|
+
width: ::Float?,
|
634
|
+
height: ::Float?,
|
635
|
+
left: ::Float?,
|
636
|
+
top: ::Float?
|
637
|
+
}?,
|
638
|
+
polygon: Array[
|
639
|
+
{
|
640
|
+
x: ::Float?,
|
641
|
+
y: ::Float?
|
642
|
+
},
|
643
|
+
]?
|
644
|
+
},
|
645
|
+
]?
|
646
|
+
}
|
647
|
+
) -> _DetectTextResponseSuccess
|
648
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DetectTextResponseSuccess
|
649
|
+
|
650
|
+
interface _DisassociateFacesResponseSuccess
|
651
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DisassociateFacesResponse]
|
652
|
+
def disassociated_faces: () -> ::Array[Types::DisassociatedFace]
|
653
|
+
def unsuccessful_face_disassociations: () -> ::Array[Types::UnsuccessfulFaceDisassociation]
|
654
|
+
def user_status: () -> ("ACTIVE" | "UPDATING" | "CREATING" | "CREATED")
|
655
|
+
end
|
656
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#disassociate_faces-instance_method
|
657
|
+
def disassociate_faces: (
|
658
|
+
collection_id: ::String,
|
659
|
+
user_id: ::String,
|
660
|
+
?client_request_token: ::String,
|
661
|
+
face_ids: Array[::String]
|
662
|
+
) -> _DisassociateFacesResponseSuccess
|
663
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DisassociateFacesResponseSuccess
|
664
|
+
|
665
|
+
interface _DistributeDatasetEntriesResponseSuccess
|
666
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::DistributeDatasetEntriesResponse]
|
667
|
+
end
|
668
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#distribute_dataset_entries-instance_method
|
669
|
+
def distribute_dataset_entries: (
|
670
|
+
datasets: Array[
|
671
|
+
{
|
672
|
+
arn: ::String
|
673
|
+
},
|
674
|
+
]
|
675
|
+
) -> _DistributeDatasetEntriesResponseSuccess
|
676
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _DistributeDatasetEntriesResponseSuccess
|
677
|
+
|
678
|
+
interface _GetCelebrityInfoResponseSuccess
|
679
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCelebrityInfoResponse]
|
680
|
+
def urls: () -> ::Array[::String]
|
681
|
+
def name: () -> ::String
|
682
|
+
def known_gender: () -> Types::KnownGender
|
683
|
+
end
|
684
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_celebrity_info-instance_method
|
685
|
+
def get_celebrity_info: (
|
686
|
+
id: ::String
|
687
|
+
) -> _GetCelebrityInfoResponseSuccess
|
688
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCelebrityInfoResponseSuccess
|
689
|
+
|
690
|
+
interface _GetCelebrityRecognitionResponseSuccess
|
691
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetCelebrityRecognitionResponse]
|
692
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
693
|
+
def status_message: () -> ::String
|
694
|
+
def video_metadata: () -> Types::VideoMetadata
|
695
|
+
def next_token: () -> ::String
|
696
|
+
def celebrities: () -> ::Array[Types::CelebrityRecognition]
|
697
|
+
def job_id: () -> ::String
|
698
|
+
def video: () -> Types::Video
|
699
|
+
def job_tag: () -> ::String
|
700
|
+
end
|
701
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_celebrity_recognition-instance_method
|
702
|
+
def get_celebrity_recognition: (
|
703
|
+
job_id: ::String,
|
704
|
+
?max_results: ::Integer,
|
705
|
+
?next_token: ::String,
|
706
|
+
?sort_by: ("ID" | "TIMESTAMP")
|
707
|
+
) -> _GetCelebrityRecognitionResponseSuccess
|
708
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetCelebrityRecognitionResponseSuccess
|
709
|
+
|
710
|
+
interface _GetContentModerationResponseSuccess
|
711
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetContentModerationResponse]
|
712
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
713
|
+
def status_message: () -> ::String
|
714
|
+
def video_metadata: () -> Types::VideoMetadata
|
715
|
+
def moderation_labels: () -> ::Array[Types::ContentModerationDetection]
|
716
|
+
def next_token: () -> ::String
|
717
|
+
def moderation_model_version: () -> ::String
|
718
|
+
def job_id: () -> ::String
|
719
|
+
def video: () -> Types::Video
|
720
|
+
def job_tag: () -> ::String
|
721
|
+
def get_request_metadata: () -> Types::GetContentModerationRequestMetadata
|
722
|
+
end
|
723
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_content_moderation-instance_method
|
724
|
+
def get_content_moderation: (
|
725
|
+
job_id: ::String,
|
726
|
+
?max_results: ::Integer,
|
727
|
+
?next_token: ::String,
|
728
|
+
?sort_by: ("NAME" | "TIMESTAMP"),
|
729
|
+
?aggregate_by: ("TIMESTAMPS" | "SEGMENTS")
|
730
|
+
) -> _GetContentModerationResponseSuccess
|
731
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetContentModerationResponseSuccess
|
732
|
+
|
733
|
+
interface _GetFaceDetectionResponseSuccess
|
734
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetFaceDetectionResponse]
|
735
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
736
|
+
def status_message: () -> ::String
|
737
|
+
def video_metadata: () -> Types::VideoMetadata
|
738
|
+
def next_token: () -> ::String
|
739
|
+
def faces: () -> ::Array[Types::FaceDetection]
|
740
|
+
def job_id: () -> ::String
|
741
|
+
def video: () -> Types::Video
|
742
|
+
def job_tag: () -> ::String
|
743
|
+
end
|
744
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_face_detection-instance_method
|
745
|
+
def get_face_detection: (
|
746
|
+
job_id: ::String,
|
747
|
+
?max_results: ::Integer,
|
748
|
+
?next_token: ::String
|
749
|
+
) -> _GetFaceDetectionResponseSuccess
|
750
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFaceDetectionResponseSuccess
|
751
|
+
|
752
|
+
interface _GetFaceLivenessSessionResultsResponseSuccess
|
753
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetFaceLivenessSessionResultsResponse]
|
754
|
+
def session_id: () -> ::String
|
755
|
+
def status: () -> ("CREATED" | "IN_PROGRESS" | "SUCCEEDED" | "FAILED" | "EXPIRED")
|
756
|
+
def confidence: () -> ::Float
|
757
|
+
def reference_image: () -> Types::AuditImage
|
758
|
+
def audit_images: () -> ::Array[Types::AuditImage]
|
759
|
+
end
|
760
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_face_liveness_session_results-instance_method
|
761
|
+
def get_face_liveness_session_results: (
|
762
|
+
session_id: ::String
|
763
|
+
) -> _GetFaceLivenessSessionResultsResponseSuccess
|
764
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFaceLivenessSessionResultsResponseSuccess
|
765
|
+
|
766
|
+
interface _GetFaceSearchResponseSuccess
|
767
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetFaceSearchResponse]
|
768
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
769
|
+
def status_message: () -> ::String
|
770
|
+
def next_token: () -> ::String
|
771
|
+
def video_metadata: () -> Types::VideoMetadata
|
772
|
+
def persons: () -> ::Array[Types::PersonMatch]
|
773
|
+
def job_id: () -> ::String
|
774
|
+
def video: () -> Types::Video
|
775
|
+
def job_tag: () -> ::String
|
776
|
+
end
|
777
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_face_search-instance_method
|
778
|
+
def get_face_search: (
|
779
|
+
job_id: ::String,
|
780
|
+
?max_results: ::Integer,
|
781
|
+
?next_token: ::String,
|
782
|
+
?sort_by: ("INDEX" | "TIMESTAMP")
|
783
|
+
) -> _GetFaceSearchResponseSuccess
|
784
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetFaceSearchResponseSuccess
|
785
|
+
|
786
|
+
interface _GetLabelDetectionResponseSuccess
|
787
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetLabelDetectionResponse]
|
788
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
789
|
+
def status_message: () -> ::String
|
790
|
+
def video_metadata: () -> Types::VideoMetadata
|
791
|
+
def next_token: () -> ::String
|
792
|
+
def labels: () -> ::Array[Types::LabelDetection]
|
793
|
+
def label_model_version: () -> ::String
|
794
|
+
def job_id: () -> ::String
|
795
|
+
def video: () -> Types::Video
|
796
|
+
def job_tag: () -> ::String
|
797
|
+
def get_request_metadata: () -> Types::GetLabelDetectionRequestMetadata
|
798
|
+
end
|
799
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_label_detection-instance_method
|
800
|
+
def get_label_detection: (
|
801
|
+
job_id: ::String,
|
802
|
+
?max_results: ::Integer,
|
803
|
+
?next_token: ::String,
|
804
|
+
?sort_by: ("NAME" | "TIMESTAMP"),
|
805
|
+
?aggregate_by: ("TIMESTAMPS" | "SEGMENTS")
|
806
|
+
) -> _GetLabelDetectionResponseSuccess
|
807
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetLabelDetectionResponseSuccess
|
808
|
+
|
809
|
+
interface _GetMediaAnalysisJobResponseSuccess
|
810
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetMediaAnalysisJobResponse]
|
811
|
+
def job_id: () -> ::String
|
812
|
+
def job_name: () -> ::String
|
813
|
+
def operations_config: () -> Types::MediaAnalysisOperationsConfig
|
814
|
+
def status: () -> ("CREATED" | "QUEUED" | "IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
815
|
+
def failure_details: () -> Types::MediaAnalysisJobFailureDetails
|
816
|
+
def creation_timestamp: () -> ::Time
|
817
|
+
def completion_timestamp: () -> ::Time
|
818
|
+
def input: () -> Types::MediaAnalysisInput
|
819
|
+
def output_config: () -> Types::MediaAnalysisOutputConfig
|
820
|
+
def kms_key_id: () -> ::String
|
821
|
+
def results: () -> Types::MediaAnalysisResults
|
822
|
+
def manifest_summary: () -> Types::MediaAnalysisManifestSummary
|
823
|
+
end
|
824
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_media_analysis_job-instance_method
|
825
|
+
def get_media_analysis_job: (
|
826
|
+
job_id: ::String
|
827
|
+
) -> _GetMediaAnalysisJobResponseSuccess
|
828
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetMediaAnalysisJobResponseSuccess
|
829
|
+
|
830
|
+
interface _GetPersonTrackingResponseSuccess
|
831
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetPersonTrackingResponse]
|
832
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
833
|
+
def status_message: () -> ::String
|
834
|
+
def video_metadata: () -> Types::VideoMetadata
|
835
|
+
def next_token: () -> ::String
|
836
|
+
def persons: () -> ::Array[Types::PersonDetection]
|
837
|
+
def job_id: () -> ::String
|
838
|
+
def video: () -> Types::Video
|
839
|
+
def job_tag: () -> ::String
|
840
|
+
end
|
841
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_person_tracking-instance_method
|
842
|
+
def get_person_tracking: (
|
843
|
+
job_id: ::String,
|
844
|
+
?max_results: ::Integer,
|
845
|
+
?next_token: ::String,
|
846
|
+
?sort_by: ("INDEX" | "TIMESTAMP")
|
847
|
+
) -> _GetPersonTrackingResponseSuccess
|
848
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetPersonTrackingResponseSuccess
|
849
|
+
|
850
|
+
interface _GetSegmentDetectionResponseSuccess
|
851
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetSegmentDetectionResponse]
|
852
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
853
|
+
def status_message: () -> ::String
|
854
|
+
def video_metadata: () -> ::Array[Types::VideoMetadata]
|
855
|
+
def audio_metadata: () -> ::Array[Types::AudioMetadata]
|
856
|
+
def next_token: () -> ::String
|
857
|
+
def segments: () -> ::Array[Types::SegmentDetection]
|
858
|
+
def selected_segment_types: () -> ::Array[Types::SegmentTypeInfo]
|
859
|
+
def job_id: () -> ::String
|
860
|
+
def video: () -> Types::Video
|
861
|
+
def job_tag: () -> ::String
|
862
|
+
end
|
863
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_segment_detection-instance_method
|
864
|
+
def get_segment_detection: (
|
865
|
+
job_id: ::String,
|
866
|
+
?max_results: ::Integer,
|
867
|
+
?next_token: ::String
|
868
|
+
) -> _GetSegmentDetectionResponseSuccess
|
869
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetSegmentDetectionResponseSuccess
|
870
|
+
|
871
|
+
interface _GetTextDetectionResponseSuccess
|
872
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::GetTextDetectionResponse]
|
873
|
+
def job_status: () -> ("IN_PROGRESS" | "SUCCEEDED" | "FAILED")
|
874
|
+
def status_message: () -> ::String
|
875
|
+
def video_metadata: () -> Types::VideoMetadata
|
876
|
+
def text_detections: () -> ::Array[Types::TextDetectionResult]
|
877
|
+
def next_token: () -> ::String
|
878
|
+
def text_model_version: () -> ::String
|
879
|
+
def job_id: () -> ::String
|
880
|
+
def video: () -> Types::Video
|
881
|
+
def job_tag: () -> ::String
|
882
|
+
end
|
883
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#get_text_detection-instance_method
|
884
|
+
def get_text_detection: (
|
885
|
+
job_id: ::String,
|
886
|
+
?max_results: ::Integer,
|
887
|
+
?next_token: ::String
|
888
|
+
) -> _GetTextDetectionResponseSuccess
|
889
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _GetTextDetectionResponseSuccess
|
890
|
+
|
891
|
+
interface _IndexFacesResponseSuccess
|
892
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::IndexFacesResponse]
|
893
|
+
def face_records: () -> ::Array[Types::FaceRecord]
|
894
|
+
def orientation_correction: () -> ("ROTATE_0" | "ROTATE_90" | "ROTATE_180" | "ROTATE_270")
|
895
|
+
def face_model_version: () -> ::String
|
896
|
+
def unindexed_faces: () -> ::Array[Types::UnindexedFace]
|
897
|
+
end
|
898
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#index_faces-instance_method
|
899
|
+
def index_faces: (
|
900
|
+
collection_id: ::String,
|
901
|
+
image: {
|
902
|
+
bytes: ::String?,
|
903
|
+
s3_object: {
|
904
|
+
bucket: ::String?,
|
905
|
+
name: ::String?,
|
906
|
+
version: ::String?
|
907
|
+
}?
|
908
|
+
},
|
909
|
+
?external_image_id: ::String,
|
910
|
+
?detection_attributes: Array[("DEFAULT" | "ALL" | "AGE_RANGE" | "BEARD" | "EMOTIONS" | "EYE_DIRECTION" | "EYEGLASSES" | "EYES_OPEN" | "GENDER" | "MOUTH_OPEN" | "MUSTACHE" | "FACE_OCCLUDED" | "SMILE" | "SUNGLASSES")],
|
911
|
+
?max_faces: ::Integer,
|
912
|
+
?quality_filter: ("NONE" | "AUTO" | "LOW" | "MEDIUM" | "HIGH")
|
913
|
+
) -> _IndexFacesResponseSuccess
|
914
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _IndexFacesResponseSuccess
|
915
|
+
|
916
|
+
interface _ListCollectionsResponseSuccess
|
917
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListCollectionsResponse]
|
918
|
+
def collection_ids: () -> ::Array[::String]
|
919
|
+
def next_token: () -> ::String
|
920
|
+
def face_model_versions: () -> ::Array[::String]
|
921
|
+
end
|
922
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_collections-instance_method
|
923
|
+
def list_collections: (
|
924
|
+
?next_token: ::String,
|
925
|
+
?max_results: ::Integer
|
926
|
+
) -> _ListCollectionsResponseSuccess
|
927
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListCollectionsResponseSuccess
|
928
|
+
|
929
|
+
interface _ListDatasetEntriesResponseSuccess
|
930
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListDatasetEntriesResponse]
|
931
|
+
def dataset_entries: () -> ::Array[::String]
|
932
|
+
def next_token: () -> ::String
|
933
|
+
end
|
934
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_dataset_entries-instance_method
|
935
|
+
def list_dataset_entries: (
|
936
|
+
dataset_arn: ::String,
|
937
|
+
?contains_labels: Array[::String],
|
938
|
+
?labeled: bool,
|
939
|
+
?source_ref_contains: ::String,
|
940
|
+
?has_errors: bool,
|
941
|
+
?next_token: ::String,
|
942
|
+
?max_results: ::Integer
|
943
|
+
) -> _ListDatasetEntriesResponseSuccess
|
944
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDatasetEntriesResponseSuccess
|
945
|
+
|
946
|
+
interface _ListDatasetLabelsResponseSuccess
|
947
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListDatasetLabelsResponse]
|
948
|
+
def dataset_label_descriptions: () -> ::Array[Types::DatasetLabelDescription]
|
949
|
+
def next_token: () -> ::String
|
950
|
+
end
|
951
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_dataset_labels-instance_method
|
952
|
+
def list_dataset_labels: (
|
953
|
+
dataset_arn: ::String,
|
954
|
+
?next_token: ::String,
|
955
|
+
?max_results: ::Integer
|
956
|
+
) -> _ListDatasetLabelsResponseSuccess
|
957
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListDatasetLabelsResponseSuccess
|
958
|
+
|
959
|
+
interface _ListFacesResponseSuccess
|
960
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListFacesResponse]
|
961
|
+
def faces: () -> ::Array[Types::Face]
|
962
|
+
def next_token: () -> ::String
|
963
|
+
def face_model_version: () -> ::String
|
964
|
+
end
|
965
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_faces-instance_method
|
966
|
+
def list_faces: (
|
967
|
+
collection_id: ::String,
|
968
|
+
?next_token: ::String,
|
969
|
+
?max_results: ::Integer,
|
970
|
+
?user_id: ::String,
|
971
|
+
?face_ids: Array[::String]
|
972
|
+
) -> _ListFacesResponseSuccess
|
973
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListFacesResponseSuccess
|
974
|
+
|
975
|
+
interface _ListMediaAnalysisJobsResponseSuccess
|
976
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListMediaAnalysisJobsResponse]
|
977
|
+
def next_token: () -> ::String
|
978
|
+
def media_analysis_jobs: () -> ::Array[Types::MediaAnalysisJobDescription]
|
979
|
+
end
|
980
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_media_analysis_jobs-instance_method
|
981
|
+
def list_media_analysis_jobs: (
|
982
|
+
?next_token: ::String,
|
983
|
+
?max_results: ::Integer
|
984
|
+
) -> _ListMediaAnalysisJobsResponseSuccess
|
985
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListMediaAnalysisJobsResponseSuccess
|
986
|
+
|
987
|
+
interface _ListProjectPoliciesResponseSuccess
|
988
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListProjectPoliciesResponse]
|
989
|
+
def project_policies: () -> ::Array[Types::ProjectPolicy]
|
990
|
+
def next_token: () -> ::String
|
991
|
+
end
|
992
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_project_policies-instance_method
|
993
|
+
def list_project_policies: (
|
994
|
+
project_arn: ::String,
|
995
|
+
?next_token: ::String,
|
996
|
+
?max_results: ::Integer
|
997
|
+
) -> _ListProjectPoliciesResponseSuccess
|
998
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListProjectPoliciesResponseSuccess
|
999
|
+
|
1000
|
+
interface _ListStreamProcessorsResponseSuccess
|
1001
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListStreamProcessorsResponse]
|
1002
|
+
def next_token: () -> ::String
|
1003
|
+
def stream_processors: () -> ::Array[Types::StreamProcessor]
|
1004
|
+
end
|
1005
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_stream_processors-instance_method
|
1006
|
+
def list_stream_processors: (
|
1007
|
+
?next_token: ::String,
|
1008
|
+
?max_results: ::Integer
|
1009
|
+
) -> _ListStreamProcessorsResponseSuccess
|
1010
|
+
| (?Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListStreamProcessorsResponseSuccess
|
1011
|
+
|
1012
|
+
interface _ListTagsForResourceResponseSuccess
|
1013
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListTagsForResourceResponse]
|
1014
|
+
def tags: () -> ::Hash[::String, ::String]
|
1015
|
+
end
|
1016
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_tags_for_resource-instance_method
|
1017
|
+
def list_tags_for_resource: (
|
1018
|
+
resource_arn: ::String
|
1019
|
+
) -> _ListTagsForResourceResponseSuccess
|
1020
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListTagsForResourceResponseSuccess
|
1021
|
+
|
1022
|
+
interface _ListUsersResponseSuccess
|
1023
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::ListUsersResponse]
|
1024
|
+
def users: () -> ::Array[Types::User]
|
1025
|
+
def next_token: () -> ::String
|
1026
|
+
end
|
1027
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#list_users-instance_method
|
1028
|
+
def list_users: (
|
1029
|
+
collection_id: ::String,
|
1030
|
+
?max_results: ::Integer,
|
1031
|
+
?next_token: ::String
|
1032
|
+
) -> _ListUsersResponseSuccess
|
1033
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _ListUsersResponseSuccess
|
1034
|
+
|
1035
|
+
interface _PutProjectPolicyResponseSuccess
|
1036
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::PutProjectPolicyResponse]
|
1037
|
+
def policy_revision_id: () -> ::String
|
1038
|
+
end
|
1039
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#put_project_policy-instance_method
|
1040
|
+
def put_project_policy: (
|
1041
|
+
project_arn: ::String,
|
1042
|
+
policy_name: ::String,
|
1043
|
+
?policy_revision_id: ::String,
|
1044
|
+
policy_document: ::String
|
1045
|
+
) -> _PutProjectPolicyResponseSuccess
|
1046
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _PutProjectPolicyResponseSuccess
|
1047
|
+
|
1048
|
+
interface _RecognizeCelebritiesResponseSuccess
|
1049
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::RecognizeCelebritiesResponse]
|
1050
|
+
def celebrity_faces: () -> ::Array[Types::Celebrity]
|
1051
|
+
def unrecognized_faces: () -> ::Array[Types::ComparedFace]
|
1052
|
+
def orientation_correction: () -> ("ROTATE_0" | "ROTATE_90" | "ROTATE_180" | "ROTATE_270")
|
1053
|
+
end
|
1054
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#recognize_celebrities-instance_method
|
1055
|
+
def recognize_celebrities: (
|
1056
|
+
image: {
|
1057
|
+
bytes: ::String?,
|
1058
|
+
s3_object: {
|
1059
|
+
bucket: ::String?,
|
1060
|
+
name: ::String?,
|
1061
|
+
version: ::String?
|
1062
|
+
}?
|
1063
|
+
}
|
1064
|
+
) -> _RecognizeCelebritiesResponseSuccess
|
1065
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _RecognizeCelebritiesResponseSuccess
|
1066
|
+
|
1067
|
+
interface _SearchFacesResponseSuccess
|
1068
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchFacesResponse]
|
1069
|
+
def searched_face_id: () -> ::String
|
1070
|
+
def face_matches: () -> ::Array[Types::FaceMatch]
|
1071
|
+
def face_model_version: () -> ::String
|
1072
|
+
end
|
1073
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#search_faces-instance_method
|
1074
|
+
def search_faces: (
|
1075
|
+
collection_id: ::String,
|
1076
|
+
face_id: ::String,
|
1077
|
+
?max_faces: ::Integer,
|
1078
|
+
?face_match_threshold: ::Float
|
1079
|
+
) -> _SearchFacesResponseSuccess
|
1080
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchFacesResponseSuccess
|
1081
|
+
|
1082
|
+
interface _SearchFacesByImageResponseSuccess
|
1083
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchFacesByImageResponse]
|
1084
|
+
def searched_face_bounding_box: () -> Types::BoundingBox
|
1085
|
+
def searched_face_confidence: () -> ::Float
|
1086
|
+
def face_matches: () -> ::Array[Types::FaceMatch]
|
1087
|
+
def face_model_version: () -> ::String
|
1088
|
+
end
|
1089
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#search_faces_by_image-instance_method
|
1090
|
+
def search_faces_by_image: (
|
1091
|
+
collection_id: ::String,
|
1092
|
+
image: {
|
1093
|
+
bytes: ::String?,
|
1094
|
+
s3_object: {
|
1095
|
+
bucket: ::String?,
|
1096
|
+
name: ::String?,
|
1097
|
+
version: ::String?
|
1098
|
+
}?
|
1099
|
+
},
|
1100
|
+
?max_faces: ::Integer,
|
1101
|
+
?face_match_threshold: ::Float,
|
1102
|
+
?quality_filter: ("NONE" | "AUTO" | "LOW" | "MEDIUM" | "HIGH")
|
1103
|
+
) -> _SearchFacesByImageResponseSuccess
|
1104
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchFacesByImageResponseSuccess
|
1105
|
+
|
1106
|
+
interface _SearchUsersResponseSuccess
|
1107
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchUsersResponse]
|
1108
|
+
def user_matches: () -> ::Array[Types::UserMatch]
|
1109
|
+
def face_model_version: () -> ::String
|
1110
|
+
def searched_face: () -> Types::SearchedFace
|
1111
|
+
def searched_user: () -> Types::SearchedUser
|
1112
|
+
end
|
1113
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#search_users-instance_method
|
1114
|
+
def search_users: (
|
1115
|
+
collection_id: ::String,
|
1116
|
+
?user_id: ::String,
|
1117
|
+
?face_id: ::String,
|
1118
|
+
?user_match_threshold: ::Float,
|
1119
|
+
?max_users: ::Integer
|
1120
|
+
) -> _SearchUsersResponseSuccess
|
1121
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchUsersResponseSuccess
|
1122
|
+
|
1123
|
+
interface _SearchUsersByImageResponseSuccess
|
1124
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::SearchUsersByImageResponse]
|
1125
|
+
def user_matches: () -> ::Array[Types::UserMatch]
|
1126
|
+
def face_model_version: () -> ::String
|
1127
|
+
def searched_face: () -> Types::SearchedFaceDetails
|
1128
|
+
def unsearched_faces: () -> ::Array[Types::UnsearchedFace]
|
1129
|
+
end
|
1130
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#search_users_by_image-instance_method
|
1131
|
+
def search_users_by_image: (
|
1132
|
+
collection_id: ::String,
|
1133
|
+
image: {
|
1134
|
+
bytes: ::String?,
|
1135
|
+
s3_object: {
|
1136
|
+
bucket: ::String?,
|
1137
|
+
name: ::String?,
|
1138
|
+
version: ::String?
|
1139
|
+
}?
|
1140
|
+
},
|
1141
|
+
?user_match_threshold: ::Float,
|
1142
|
+
?max_users: ::Integer,
|
1143
|
+
?quality_filter: ("NONE" | "AUTO" | "LOW" | "MEDIUM" | "HIGH")
|
1144
|
+
) -> _SearchUsersByImageResponseSuccess
|
1145
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _SearchUsersByImageResponseSuccess
|
1146
|
+
|
1147
|
+
interface _StartCelebrityRecognitionResponseSuccess
|
1148
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartCelebrityRecognitionResponse]
|
1149
|
+
def job_id: () -> ::String
|
1150
|
+
end
|
1151
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_celebrity_recognition-instance_method
|
1152
|
+
def start_celebrity_recognition: (
|
1153
|
+
video: {
|
1154
|
+
s3_object: {
|
1155
|
+
bucket: ::String?,
|
1156
|
+
name: ::String?,
|
1157
|
+
version: ::String?
|
1158
|
+
}?
|
1159
|
+
},
|
1160
|
+
?client_request_token: ::String,
|
1161
|
+
?notification_channel: {
|
1162
|
+
sns_topic_arn: ::String,
|
1163
|
+
role_arn: ::String
|
1164
|
+
},
|
1165
|
+
?job_tag: ::String
|
1166
|
+
) -> _StartCelebrityRecognitionResponseSuccess
|
1167
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartCelebrityRecognitionResponseSuccess
|
1168
|
+
|
1169
|
+
interface _StartContentModerationResponseSuccess
|
1170
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartContentModerationResponse]
|
1171
|
+
def job_id: () -> ::String
|
1172
|
+
end
|
1173
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_content_moderation-instance_method
|
1174
|
+
def start_content_moderation: (
|
1175
|
+
video: {
|
1176
|
+
s3_object: {
|
1177
|
+
bucket: ::String?,
|
1178
|
+
name: ::String?,
|
1179
|
+
version: ::String?
|
1180
|
+
}?
|
1181
|
+
},
|
1182
|
+
?min_confidence: ::Float,
|
1183
|
+
?client_request_token: ::String,
|
1184
|
+
?notification_channel: {
|
1185
|
+
sns_topic_arn: ::String,
|
1186
|
+
role_arn: ::String
|
1187
|
+
},
|
1188
|
+
?job_tag: ::String
|
1189
|
+
) -> _StartContentModerationResponseSuccess
|
1190
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartContentModerationResponseSuccess
|
1191
|
+
|
1192
|
+
interface _StartFaceDetectionResponseSuccess
|
1193
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartFaceDetectionResponse]
|
1194
|
+
def job_id: () -> ::String
|
1195
|
+
end
|
1196
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_face_detection-instance_method
|
1197
|
+
def start_face_detection: (
|
1198
|
+
video: {
|
1199
|
+
s3_object: {
|
1200
|
+
bucket: ::String?,
|
1201
|
+
name: ::String?,
|
1202
|
+
version: ::String?
|
1203
|
+
}?
|
1204
|
+
},
|
1205
|
+
?client_request_token: ::String,
|
1206
|
+
?notification_channel: {
|
1207
|
+
sns_topic_arn: ::String,
|
1208
|
+
role_arn: ::String
|
1209
|
+
},
|
1210
|
+
?face_attributes: ("DEFAULT" | "ALL"),
|
1211
|
+
?job_tag: ::String
|
1212
|
+
) -> _StartFaceDetectionResponseSuccess
|
1213
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartFaceDetectionResponseSuccess
|
1214
|
+
|
1215
|
+
interface _StartFaceSearchResponseSuccess
|
1216
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartFaceSearchResponse]
|
1217
|
+
def job_id: () -> ::String
|
1218
|
+
end
|
1219
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_face_search-instance_method
|
1220
|
+
def start_face_search: (
|
1221
|
+
video: {
|
1222
|
+
s3_object: {
|
1223
|
+
bucket: ::String?,
|
1224
|
+
name: ::String?,
|
1225
|
+
version: ::String?
|
1226
|
+
}?
|
1227
|
+
},
|
1228
|
+
?client_request_token: ::String,
|
1229
|
+
?face_match_threshold: ::Float,
|
1230
|
+
collection_id: ::String,
|
1231
|
+
?notification_channel: {
|
1232
|
+
sns_topic_arn: ::String,
|
1233
|
+
role_arn: ::String
|
1234
|
+
},
|
1235
|
+
?job_tag: ::String
|
1236
|
+
) -> _StartFaceSearchResponseSuccess
|
1237
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartFaceSearchResponseSuccess
|
1238
|
+
|
1239
|
+
interface _StartLabelDetectionResponseSuccess
|
1240
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartLabelDetectionResponse]
|
1241
|
+
def job_id: () -> ::String
|
1242
|
+
end
|
1243
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_label_detection-instance_method
|
1244
|
+
def start_label_detection: (
|
1245
|
+
video: {
|
1246
|
+
s3_object: {
|
1247
|
+
bucket: ::String?,
|
1248
|
+
name: ::String?,
|
1249
|
+
version: ::String?
|
1250
|
+
}?
|
1251
|
+
},
|
1252
|
+
?client_request_token: ::String,
|
1253
|
+
?min_confidence: ::Float,
|
1254
|
+
?notification_channel: {
|
1255
|
+
sns_topic_arn: ::String,
|
1256
|
+
role_arn: ::String
|
1257
|
+
},
|
1258
|
+
?job_tag: ::String,
|
1259
|
+
?features: Array[("GENERAL_LABELS")],
|
1260
|
+
?settings: {
|
1261
|
+
general_labels: {
|
1262
|
+
label_inclusion_filters: Array[::String]?,
|
1263
|
+
label_exclusion_filters: Array[::String]?,
|
1264
|
+
label_category_inclusion_filters: Array[::String]?,
|
1265
|
+
label_category_exclusion_filters: Array[::String]?
|
1266
|
+
}?
|
1267
|
+
}
|
1268
|
+
) -> _StartLabelDetectionResponseSuccess
|
1269
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartLabelDetectionResponseSuccess
|
1270
|
+
|
1271
|
+
interface _StartMediaAnalysisJobResponseSuccess
|
1272
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartMediaAnalysisJobResponse]
|
1273
|
+
def job_id: () -> ::String
|
1274
|
+
end
|
1275
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_media_analysis_job-instance_method
|
1276
|
+
def start_media_analysis_job: (
|
1277
|
+
?client_request_token: ::String,
|
1278
|
+
?job_name: ::String,
|
1279
|
+
operations_config: {
|
1280
|
+
detect_moderation_labels: {
|
1281
|
+
min_confidence: ::Float?,
|
1282
|
+
project_version: ::String?
|
1283
|
+
}?
|
1284
|
+
},
|
1285
|
+
input: {
|
1286
|
+
s3_object: {
|
1287
|
+
bucket: ::String?,
|
1288
|
+
name: ::String?,
|
1289
|
+
version: ::String?
|
1290
|
+
}
|
1291
|
+
},
|
1292
|
+
output_config: {
|
1293
|
+
s3_bucket: ::String,
|
1294
|
+
s3_key_prefix: ::String?
|
1295
|
+
},
|
1296
|
+
?kms_key_id: ::String
|
1297
|
+
) -> _StartMediaAnalysisJobResponseSuccess
|
1298
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartMediaAnalysisJobResponseSuccess
|
1299
|
+
|
1300
|
+
interface _StartPersonTrackingResponseSuccess
|
1301
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartPersonTrackingResponse]
|
1302
|
+
def job_id: () -> ::String
|
1303
|
+
end
|
1304
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_person_tracking-instance_method
|
1305
|
+
def start_person_tracking: (
|
1306
|
+
video: {
|
1307
|
+
s3_object: {
|
1308
|
+
bucket: ::String?,
|
1309
|
+
name: ::String?,
|
1310
|
+
version: ::String?
|
1311
|
+
}?
|
1312
|
+
},
|
1313
|
+
?client_request_token: ::String,
|
1314
|
+
?notification_channel: {
|
1315
|
+
sns_topic_arn: ::String,
|
1316
|
+
role_arn: ::String
|
1317
|
+
},
|
1318
|
+
?job_tag: ::String
|
1319
|
+
) -> _StartPersonTrackingResponseSuccess
|
1320
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartPersonTrackingResponseSuccess
|
1321
|
+
|
1322
|
+
interface _StartProjectVersionResponseSuccess
|
1323
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartProjectVersionResponse]
|
1324
|
+
def status: () -> ("TRAINING_IN_PROGRESS" | "TRAINING_COMPLETED" | "TRAINING_FAILED" | "STARTING" | "RUNNING" | "FAILED" | "STOPPING" | "STOPPED" | "DELETING" | "COPYING_IN_PROGRESS" | "COPYING_COMPLETED" | "COPYING_FAILED" | "DEPRECATED" | "EXPIRED")
|
1325
|
+
end
|
1326
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_project_version-instance_method
|
1327
|
+
def start_project_version: (
|
1328
|
+
project_version_arn: ::String,
|
1329
|
+
min_inference_units: ::Integer,
|
1330
|
+
?max_inference_units: ::Integer
|
1331
|
+
) -> _StartProjectVersionResponseSuccess
|
1332
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartProjectVersionResponseSuccess
|
1333
|
+
|
1334
|
+
interface _StartSegmentDetectionResponseSuccess
|
1335
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartSegmentDetectionResponse]
|
1336
|
+
def job_id: () -> ::String
|
1337
|
+
end
|
1338
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_segment_detection-instance_method
|
1339
|
+
def start_segment_detection: (
|
1340
|
+
video: {
|
1341
|
+
s3_object: {
|
1342
|
+
bucket: ::String?,
|
1343
|
+
name: ::String?,
|
1344
|
+
version: ::String?
|
1345
|
+
}?
|
1346
|
+
},
|
1347
|
+
?client_request_token: ::String,
|
1348
|
+
?notification_channel: {
|
1349
|
+
sns_topic_arn: ::String,
|
1350
|
+
role_arn: ::String
|
1351
|
+
},
|
1352
|
+
?job_tag: ::String,
|
1353
|
+
?filters: {
|
1354
|
+
technical_cue_filter: {
|
1355
|
+
min_segment_confidence: ::Float?,
|
1356
|
+
black_frame: {
|
1357
|
+
max_pixel_threshold: ::Float?,
|
1358
|
+
min_coverage_percentage: ::Float?
|
1359
|
+
}?
|
1360
|
+
}?,
|
1361
|
+
shot_filter: {
|
1362
|
+
min_segment_confidence: ::Float?
|
1363
|
+
}?
|
1364
|
+
},
|
1365
|
+
segment_types: Array[("TECHNICAL_CUE" | "SHOT")]
|
1366
|
+
) -> _StartSegmentDetectionResponseSuccess
|
1367
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartSegmentDetectionResponseSuccess
|
1368
|
+
|
1369
|
+
interface _StartStreamProcessorResponseSuccess
|
1370
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartStreamProcessorResponse]
|
1371
|
+
def session_id: () -> ::String
|
1372
|
+
end
|
1373
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_stream_processor-instance_method
|
1374
|
+
def start_stream_processor: (
|
1375
|
+
name: ::String,
|
1376
|
+
?start_selector: {
|
1377
|
+
kvs_stream_start_selector: {
|
1378
|
+
producer_timestamp: ::Integer?,
|
1379
|
+
fragment_number: ::String?
|
1380
|
+
}?
|
1381
|
+
},
|
1382
|
+
?stop_selector: {
|
1383
|
+
max_duration_in_seconds: ::Integer?
|
1384
|
+
}
|
1385
|
+
) -> _StartStreamProcessorResponseSuccess
|
1386
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartStreamProcessorResponseSuccess
|
1387
|
+
|
1388
|
+
interface _StartTextDetectionResponseSuccess
|
1389
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StartTextDetectionResponse]
|
1390
|
+
def job_id: () -> ::String
|
1391
|
+
end
|
1392
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#start_text_detection-instance_method
|
1393
|
+
def start_text_detection: (
|
1394
|
+
video: {
|
1395
|
+
s3_object: {
|
1396
|
+
bucket: ::String?,
|
1397
|
+
name: ::String?,
|
1398
|
+
version: ::String?
|
1399
|
+
}?
|
1400
|
+
},
|
1401
|
+
?client_request_token: ::String,
|
1402
|
+
?notification_channel: {
|
1403
|
+
sns_topic_arn: ::String,
|
1404
|
+
role_arn: ::String
|
1405
|
+
},
|
1406
|
+
?job_tag: ::String,
|
1407
|
+
?filters: {
|
1408
|
+
word_filter: {
|
1409
|
+
min_confidence: ::Float?,
|
1410
|
+
min_bounding_box_height: ::Float?,
|
1411
|
+
min_bounding_box_width: ::Float?
|
1412
|
+
}?,
|
1413
|
+
regions_of_interest: Array[
|
1414
|
+
{
|
1415
|
+
bounding_box: {
|
1416
|
+
width: ::Float?,
|
1417
|
+
height: ::Float?,
|
1418
|
+
left: ::Float?,
|
1419
|
+
top: ::Float?
|
1420
|
+
}?,
|
1421
|
+
polygon: Array[
|
1422
|
+
{
|
1423
|
+
x: ::Float?,
|
1424
|
+
y: ::Float?
|
1425
|
+
},
|
1426
|
+
]?
|
1427
|
+
},
|
1428
|
+
]?
|
1429
|
+
}
|
1430
|
+
) -> _StartTextDetectionResponseSuccess
|
1431
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StartTextDetectionResponseSuccess
|
1432
|
+
|
1433
|
+
interface _StopProjectVersionResponseSuccess
|
1434
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StopProjectVersionResponse]
|
1435
|
+
def status: () -> ("TRAINING_IN_PROGRESS" | "TRAINING_COMPLETED" | "TRAINING_FAILED" | "STARTING" | "RUNNING" | "FAILED" | "STOPPING" | "STOPPED" | "DELETING" | "COPYING_IN_PROGRESS" | "COPYING_COMPLETED" | "COPYING_FAILED" | "DEPRECATED" | "EXPIRED")
|
1436
|
+
end
|
1437
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#stop_project_version-instance_method
|
1438
|
+
def stop_project_version: (
|
1439
|
+
project_version_arn: ::String
|
1440
|
+
) -> _StopProjectVersionResponseSuccess
|
1441
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopProjectVersionResponseSuccess
|
1442
|
+
|
1443
|
+
interface _StopStreamProcessorResponseSuccess
|
1444
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::StopStreamProcessorResponse]
|
1445
|
+
end
|
1446
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#stop_stream_processor-instance_method
|
1447
|
+
def stop_stream_processor: (
|
1448
|
+
name: ::String
|
1449
|
+
) -> _StopStreamProcessorResponseSuccess
|
1450
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _StopStreamProcessorResponseSuccess
|
1451
|
+
|
1452
|
+
interface _TagResourceResponseSuccess
|
1453
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::TagResourceResponse]
|
1454
|
+
end
|
1455
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#tag_resource-instance_method
|
1456
|
+
def tag_resource: (
|
1457
|
+
resource_arn: ::String,
|
1458
|
+
tags: Hash[::String, ::String]
|
1459
|
+
) -> _TagResourceResponseSuccess
|
1460
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _TagResourceResponseSuccess
|
1461
|
+
|
1462
|
+
interface _UntagResourceResponseSuccess
|
1463
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UntagResourceResponse]
|
1464
|
+
end
|
1465
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#untag_resource-instance_method
|
1466
|
+
def untag_resource: (
|
1467
|
+
resource_arn: ::String,
|
1468
|
+
tag_keys: Array[::String]
|
1469
|
+
) -> _UntagResourceResponseSuccess
|
1470
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UntagResourceResponseSuccess
|
1471
|
+
|
1472
|
+
interface _UpdateDatasetEntriesResponseSuccess
|
1473
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateDatasetEntriesResponse]
|
1474
|
+
end
|
1475
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#update_dataset_entries-instance_method
|
1476
|
+
def update_dataset_entries: (
|
1477
|
+
dataset_arn: ::String,
|
1478
|
+
changes: {
|
1479
|
+
ground_truth: ::String
|
1480
|
+
}
|
1481
|
+
) -> _UpdateDatasetEntriesResponseSuccess
|
1482
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateDatasetEntriesResponseSuccess
|
1483
|
+
|
1484
|
+
interface _UpdateStreamProcessorResponseSuccess
|
1485
|
+
include ::Seahorse::Client::_ResponseSuccess[Types::UpdateStreamProcessorResponse]
|
1486
|
+
end
|
1487
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#update_stream_processor-instance_method
|
1488
|
+
def update_stream_processor: (
|
1489
|
+
name: ::String,
|
1490
|
+
?settings_for_update: {
|
1491
|
+
connected_home_for_update: {
|
1492
|
+
labels: Array[::String]?,
|
1493
|
+
min_confidence: ::Float?
|
1494
|
+
}?
|
1495
|
+
},
|
1496
|
+
?regions_of_interest_for_update: Array[
|
1497
|
+
{
|
1498
|
+
bounding_box: {
|
1499
|
+
width: ::Float?,
|
1500
|
+
height: ::Float?,
|
1501
|
+
left: ::Float?,
|
1502
|
+
top: ::Float?
|
1503
|
+
}?,
|
1504
|
+
polygon: Array[
|
1505
|
+
{
|
1506
|
+
x: ::Float?,
|
1507
|
+
y: ::Float?
|
1508
|
+
},
|
1509
|
+
]?
|
1510
|
+
},
|
1511
|
+
],
|
1512
|
+
?data_sharing_preference_for_update: {
|
1513
|
+
opt_in: bool
|
1514
|
+
},
|
1515
|
+
?parameters_to_delete: Array[("ConnectedHomeMinConfidence" | "RegionsOfInterest")]
|
1516
|
+
) -> _UpdateStreamProcessorResponseSuccess
|
1517
|
+
| (Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> _UpdateStreamProcessorResponseSuccess
|
1518
|
+
|
1519
|
+
# https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/Rekognition/Client.html#wait_until-instance_method
|
1520
|
+
def wait_until: (:project_version_running waiter_name,
|
1521
|
+
project_arn: ::String,
|
1522
|
+
?version_names: Array[::String],
|
1523
|
+
?next_token: ::String,
|
1524
|
+
?max_results: ::Integer
|
1525
|
+
) -> Client::_DescribeProjectVersionsResponseSuccess
|
1526
|
+
| (:project_version_running waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_DescribeProjectVersionsResponseSuccess
|
1527
|
+
| (:project_version_training_completed waiter_name,
|
1528
|
+
project_arn: ::String,
|
1529
|
+
?version_names: Array[::String],
|
1530
|
+
?next_token: ::String,
|
1531
|
+
?max_results: ::Integer
|
1532
|
+
) -> Client::_DescribeProjectVersionsResponseSuccess
|
1533
|
+
| (:project_version_training_completed waiter_name, Hash[Symbol, untyped] params, ?Hash[Symbol, untyped] options) -> Client::_DescribeProjectVersionsResponseSuccess
|
1534
|
+
end
|
1535
|
+
end
|
1536
|
+
end
|
1537
|
+
|