-
Notifications
You must be signed in to change notification settings - Fork 549
Expand file tree
/
Copy pathAmazonRekognition.java
More file actions
4738 lines (4656 loc) · 204 KB
/
Copy pathAmazonRekognition.java
File metadata and controls
4738 lines (4656 loc) · 204 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2010-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
package com.amazonaws.services.rekognition;
import com.amazonaws.*;
import com.amazonaws.regions.*;
import com.amazonaws.services.rekognition.model.*;
/**
* Interface for accessing Amazon Rekognition
* <p>
* This is the API Reference for <a
* href="https://docs.aws.amazon.com/rekognition/latest/dg/images.html">Amazon
* Rekognition Image</a>, <a href=
* "https://docs.aws.amazon.com/rekognition/latest/customlabels-dg/what-is.html"
* >Amazon Rekognition Custom Labels</a>, <a
* href="https://docs.aws.amazon.com/rekognition/latest/dg/video.html">Amazon
* Rekognition Stored Video</a>, <a href=
* "https://docs.aws.amazon.com/rekognition/latest/dg/streaming-video.html"
* >Amazon Rekognition Streaming Video</a>. It provides descriptions of actions,
* data types, common parameters, and common errors.
* </p>
* <p>
* <b>Amazon Rekognition Image</b>
* </p>
* <ul>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_AssociateFaces.html"
* >AssociateFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CompareFaces.html"
* >CompareFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateCollection.html"
* >CreateCollection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateUser.html"
* >CreateUser</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteCollection.html"
* >DeleteCollection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteFaces.html"
* >DeleteFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteUser.html"
* >DeleteUser</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeCollection.html"
* >DescribeCollection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectFaces.html"
* >DetectFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectLabels.html"
* >DetectLabels</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectModerationLabels.html"
* >DetectModerationLabels</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectProtectiveEquipment.html"
* >DetectProtectiveEquipment</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectText.html"
* >DetectText</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DisassociateFaces.html"
* >DisassociateFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityInfo.html"
* >GetCelebrityInfo</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetMediaAnalysisJob.html"
* >GetMediaAnalysisJob</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_IndexFaces.html"
* >IndexFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListCollections.html"
* >ListCollections</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListMediaAnalysisJob.html"
* >ListMediaAnalysisJob</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html"
* >ListFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListFaces.html"
* >ListUsers</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_RecognizeCelebrities.html"
* >RecognizeCelebrities</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFaces.html"
* >SearchFaces</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchFacesByImage.html"
* >SearchFacesByImage</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsers.html"
* >SearchUsers</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_SearchUsersByImage.html"
* >SearchUsersByImage</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartMediaAnalysisJob.html"
* >StartMediaAnalysisJob</a>
* </p>
* </li>
* </ul>
* <p>
* <b>Amazon Rekognition Custom Labels</b>
* </p>
* <ul>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CopyProjectVersion.html"
* >CopyProjectVersion</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateDataset.html"
* >CreateDataset</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProject.html"
* >CreateProject</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateProjectVersion.html"
* >CreateProjectVersion</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteDataset.html"
* >DeleteDataset</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProject.html"
* >DeleteProject</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectPolicy.html"
* >DeleteProjectPolicy</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteProjectVersion.html"
* >DeleteProjectVersion</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeDataset.html"
* >DescribeDataset</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjects.html"
* >DescribeProjects</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeProjectVersions.html"
* >DescribeProjectVersions</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DetectCustomLabels.html"
* >DetectCustomLabels</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DistributeDatasetEntries.html"
* >DistributeDatasetEntries</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetEntries.html"
* >ListDatasetEntries</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListDatasetLabels.html"
* >ListDatasetLabels</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListProjectPolicies.html"
* >ListProjectPolicies</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_PutProjectPolicy.html"
* >PutProjectPolicy</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartProjectVersion.html"
* >StartProjectVersion</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopProjectVersion.html"
* >StopProjectVersion</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateDatasetEntries.html"
* >UpdateDatasetEntries</a>
* </p>
* </li>
* </ul>
* <p>
* <b>Amazon Rekognition Video Stored Video</b>
* </p>
* <ul>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetCelebrityRecognition.html"
* >GetCelebrityRecognition</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetContentModeration.html"
* >GetContentModeration</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceDetection.html"
* >GetFaceDetection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetFaceSearch.html"
* >GetFaceSearch</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetLabelDetection.html"
* >GetLabelDetection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetPersonTracking.html"
* >GetPersonTracking</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetSegmentDetection.html"
* >GetSegmentDetection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_GetTextDetection.html"
* >GetTextDetection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartCelebrityRecognition.html"
* >StartCelebrityRecognition</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartContentModeration.html"
* >StartContentModeration</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceDetection.html"
* >StartFaceDetection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartFaceSearch.html"
* >StartFaceSearch</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartLabelDetection.html"
* >StartLabelDetection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartPersonTracking.html"
* >StartPersonTracking</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartSegmentDetection.html"
* >StartSegmentDetection</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartTextDetection.html"
* >StartTextDetection</a>
* </p>
* </li>
* </ul>
* <p>
* <b>Amazon Rekognition Video Streaming Video</b>
* </p>
* <ul>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_CreateStreamProcessor.html"
* >CreateStreamProcessor</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DeleteStreamProcessor.html"
* >DeleteStreamProcessor</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_DescribeStreamProcessor.html"
* >DescribeStreamProcessor</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_ListStreamProcessors.html"
* >ListStreamProcessors</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StartStreamProcessor.html"
* >StartStreamProcessor</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_StopStreamProcessor.html"
* >StopStreamProcessor</a>
* </p>
* </li>
* <li>
* <p>
* <a href=
* "https://docs.aws.amazon.com/rekognition/latest/APIReference/API_UpdateStreamProcessor.html"
* >UpdateStreamProcessor</a>
* </p>
* </li>
* </ul>
**/
public interface AmazonRekognition {
/**
* Overrides the default endpoint for this client
* ("https://rekognition.us-east-1.amazonaws.com"). Callers can use this
* method to control which AWS region they want to work with.
* <p>
* Callers can pass in just the endpoint (ex:
* "rekognition.us-east-1.amazonaws.com") or a full URL, including the
* protocol (ex: "https://rekognition.us-east-1.amazonaws.com"). If the
* protocol is not specified here, the default protocol from this client's
* {@link ClientConfiguration} will be used, which by default is HTTPS.
* <p>
* For more information on using AWS regions with the AWS SDK for Java, and
* a complete list of all available endpoints for all AWS services, see: <a
* href=
* "http://developer.amazonwebservices.com/connect/entry.jspa?externalID=3912"
* > http://developer.amazonwebservices.com/connect/entry.jspa?externalID=
* 3912</a>
* <p>
* <b>This method is not threadsafe. An endpoint should be configured when
* the client is created and before any service requests are made. Changing
* it afterwards creates inevitable race conditions for any service requests
* in transit or retrying.</b>
*
* @param endpoint The endpoint (ex: "rekognition.us-east-1.amazonaws.com")
* or a full URL, including the protocol (ex:
* "https://rekognition.us-east-1.amazonaws.com") of the region
* specific AWS endpoint this client will communicate with.
* @throws IllegalArgumentException If any problems are detected with the
* specified endpoint.
*/
public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException;
/**
* An alternative to {@link AmazonRekognition#setEndpoint(String)}, sets the
* regional endpoint for this client's service calls. Callers can use this
* method to control which AWS region they want to work with.
* <p>
* By default, all service endpoints in all regions use the https protocol.
* To use http instead, specify it in the {@link ClientConfiguration}
* supplied at construction.
* <p>
* <b>This method is not threadsafe. A region should be configured when the
* client is created and before any service requests are made. Changing it
* afterwards creates inevitable race conditions for any service requests in
* transit or retrying.</b>
*
* @param region The region this client will communicate with. See
* {@link Region#getRegion(com.amazonaws.regions.Regions)} for
* accessing a given region.
* @throws java.lang.IllegalArgumentException If the given region is null,
* or if this service isn't available in the given region. See
* {@link Region#isServiceSupported(String)}
* @see Region#getRegion(com.amazonaws.regions.Regions)
* @see Region#createClient(Class,
* com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
*/
public void setRegion(Region region) throws java.lang.IllegalArgumentException;
/**
* <p>
* Associates one or more faces with an existing UserID. Takes an array of
* <code>FaceIds</code>. Each <code>FaceId</code> that are present in the
* <code>FaceIds</code> list is associated with the provided UserID. The
* maximum number of total <code>FaceIds</code> per UserID is 100.
* </p>
* <p>
* The <code>UserMatchThreshold</code> parameter specifies the minimum user
* match confidence required for the face to be associated with a UserID
* that has at least one <code>FaceID</code> already associated. This
* ensures that the <code>FaceIds</code> are associated with the right
* UserID. The value ranges from 0-100 and default value is 75.
* </p>
* <p>
* If successful, an array of <code>AssociatedFace</code> objects containing
* the associated <code>FaceIds</code> is returned. If a given face is
* already associated with the given <code>UserID</code>, it will be ignored
* and will not be returned in the response. If a given face is already
* associated to a different <code>UserID</code>, isn't found in the
* collection, doesn’t meet the <code>UserMatchThreshold</code>, or there
* are already 100 faces associated with the <code>UserID</code>, it will be
* returned as part of an array of
* <code>UnsuccessfulFaceAssociations.</code>
* </p>
* <p>
* The <code>UserStatus</code> reflects the status of an operation which
* updates a UserID representation with a list of given faces. The
* <code>UserStatus</code> can be:
* </p>
* <ul>
* <li>
* <p>
* ACTIVE - All associations or disassociations of FaceID(s) for a UserID
* are complete.
* </p>
* </li>
* <li>
* <p>
* CREATED - A UserID has been created, but has no FaceID(s) associated with
* it.
* </p>
* </li>
* <li>
* <p>
* UPDATING - A UserID is being updated and there are current associations
* or disassociations of FaceID(s) taking place.
* </p>
* </li>
* </ul>
*
* @param associateFacesRequest
* @return associateFacesResult The response from the AssociateFaces service
* method, as returned by Amazon Rekognition.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ProvisionedThroughputExceededException
* @throws IdempotentParameterMismatchException
* @throws ResourceNotFoundException
* @throws ConflictException
* @throws ServiceQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Rekognition indicating either a problem with the data in the
* request, or a server side issue.
*/
AssociateFacesResult associateFaces(AssociateFacesRequest associateFacesRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Compares a face in the <i>source</i> input image with each of the 100
* largest faces detected in the <i>target</i> input image.
* </p>
* <p>
* If the source image contains multiple faces, the service detects the
* largest face and compares it with each face detected in the target image.
* </p>
* <note>
* <p>
* CompareFaces uses machine learning algorithms, which are probabilistic. A
* false negative is an incorrect prediction that a face in the target image
* has a low similarity confidence score when compared to the face in the
* source image. To reduce the probability of false negatives, we recommend
* that you compare the target image against multiple source images. If you
* plan to use <code>CompareFaces</code> to make a decision that impacts an
* individual's rights, privacy, or access to services, we recommend that
* you pass the result to a human for review and further validation before
* taking action.
* </p>
* </note>
* <p>
* You pass the input and target images either as base64-encoded image bytes
* or as references to images in an Amazon S3 bucket. If you use the AWS CLI
* to call Amazon Rekognition operations, passing image bytes isn't
* supported. The image must be formatted as a PNG or JPEG file.
* </p>
* <p>
* In response, the operation returns an array of face matches ordered by
* similarity score in descending order. For each face match, the response
* provides a bounding box of the face, facial landmarks, pose details
* (pitch, roll, and yaw), quality (brightness and sharpness), and
* confidence value (indicating the level of confidence that the bounding
* box contains a face). The response also provides a similarity score,
* which indicates how closely the faces match.
* </p>
* <note>
* <p>
* By default, only faces with a similarity score of greater than or equal
* to 80% are returned in the response. You can change this value by
* specifying the <code>SimilarityThreshold</code> parameter.
* </p>
* </note>
* <p>
* <code>CompareFaces</code> also returns an array of faces that don't match
* the source image. For each face, it returns a bounding box, confidence
* value, landmarks, pose details, and quality. The response also returns
* information about the face in the source image, including the bounding
* box of the face and confidence value.
* </p>
* <p>
* The <code>QualityFilter</code> input parameter allows you to filter out
* detected faces that don’t meet a required quality bar. The quality bar is
* based on a variety of common use cases. Use <code>QualityFilter</code> to
* set the quality bar by specifying <code>LOW</code>, <code>MEDIUM</code>,
* or <code>HIGH</code>. If you do not want to filter detected faces,
* specify <code>NONE</code>. The default value is <code>NONE</code>.
* </p>
* <p>
* If the image doesn't contain Exif metadata, <code>CompareFaces</code>
* returns orientation information for the source and target images. Use
* these values to display the images with the correct image orientation.
* </p>
* <p>
* If no faces are detected in the source or target images,
* <code>CompareFaces</code> returns an
* <code>InvalidParameterException</code> error.
* </p>
* <note>
* <p>
* This is a stateless API operation. That is, data returned by this
* operation doesn't persist.
* </p>
* </note>
* <p>
* For an example, see Comparing Faces in Images in the Amazon Rekognition
* Developer Guide.
* </p>
* <p>
* This operation requires permissions to perform the
* <code>rekognition:CompareFaces</code> action.
* </p>
*
* @param compareFacesRequest
* @return compareFacesResult The response from the CompareFaces service
* method, as returned by Amazon Rekognition.
* @throws InvalidParameterException
* @throws InvalidS3ObjectException
* @throws ImageTooLargeException
* @throws AccessDeniedException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ProvisionedThroughputExceededException
* @throws InvalidImageFormatException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Rekognition indicating either a problem with the data in the
* request, or a server side issue.
*/
CompareFacesResult compareFaces(CompareFacesRequest compareFacesRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <note>
* <p>
* This operation applies only to Amazon Rekognition Custom Labels.
* </p>
* </note>
* <p>
* Copies a version of an Amazon Rekognition Custom Labels model from a
* source project to a destination project. The source and destination
* projects can be in different AWS accounts but must be in the same AWS
* Region. You can't copy a model to another AWS service.
* </p>
* <p>
* To copy a model version to a different AWS account, you need to create a
* resource-based policy known as a <i>project policy</i>. You attach the
* project policy to the source project by calling <a>PutProjectPolicy</a>.
* The project policy gives permission to copy the model version from a
* trusting AWS account to a trusted account.
* </p>
* <p>
* For more information creating and attaching a project policy, see
* Attaching a project policy (SDK) in the <i>Amazon Rekognition Custom
* Labels Developer Guide</i>.
* </p>
* <p>
* If you are copying a model version to a project in the same AWS account,
* you don't need to create a project policy.
* </p>
* <note>
* <p>
* Copying project versions is supported only for Custom Labels models.
* </p>
* <p>
* To copy a model, the destination project, source project, and source
* model version must already exist.
* </p>
* </note>
* <p>
* Copying a model version takes a while to complete. To get the current
* status, call <a>DescribeProjectVersions</a> and check the value of
* <code>Status</code> in the <a>ProjectVersionDescription</a> object. The
* copy operation has finished when the value of <code>Status</code> is
* <code>COPYING_COMPLETED</code>.
* </p>
* <p>
* This operation requires permissions to perform the
* <code>rekognition:CopyProjectVersion</code> action.
* </p>
*
* @param copyProjectVersionRequest
* @return copyProjectVersionResult The response from the CopyProjectVersion
* service method, as returned by Amazon Rekognition.
* @throws AccessDeniedException
* @throws InternalServerErrorException
* @throws InvalidParameterException
* @throws LimitExceededException
* @throws ResourceNotFoundException
* @throws ThrottlingException
* @throws ServiceQuotaExceededException
* @throws ProvisionedThroughputExceededException
* @throws ResourceInUseException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Rekognition indicating either a problem with the data in the
* request, or a server side issue.
*/
CopyProjectVersionResult copyProjectVersion(CopyProjectVersionRequest copyProjectVersionRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* Creates a collection in an AWS Region. You can add faces to the
* collection using the <a>IndexFaces</a> operation.
* </p>
* <p>
* For example, you might create collections, one for each of your
* application users. A user can then index faces using the
* <code>IndexFaces</code> operation and persist results in a specific
* collection. Then, a user can search the collection for faces in the
* user-specific container.
* </p>
* <p>
* When you create a collection, it is associated with the latest version of
* the face model version.
* </p>
* <note>
* <p>
* Collection names are case-sensitive.
* </p>
* </note>
* <p>
* This operation requires permissions to perform the
* <code>rekognition:CreateCollection</code> action. If you want to tag your
* collection, you also require permission to perform the
* <code>rekognition:TagResource</code> operation.
* </p>
*
* @param createCollectionRequest
* @return createCollectionResult The response from the CreateCollection
* service method, as returned by Amazon Rekognition.
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ProvisionedThroughputExceededException
* @throws ResourceAlreadyExistsException
* @throws ServiceQuotaExceededException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Rekognition indicating either a problem with the data in the
* request, or a server side issue.
*/
CreateCollectionResult createCollection(CreateCollectionRequest createCollectionRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <note>
* <p>
* This operation applies only to Amazon Rekognition Custom Labels.
* </p>
* </note>
* <p>
* Creates a new Amazon Rekognition Custom Labels dataset. You can create a
* dataset by using an Amazon Sagemaker format manifest file or by copying
* an existing Amazon Rekognition Custom Labels dataset.
* </p>
* <p>
* To create a training dataset for a project, specify <code>TRAIN</code>
* for the value of <code>DatasetType</code>. To create the test dataset for
* a project, specify <code>TEST</code> for the value of
* <code>DatasetType</code>.
* </p>
* <p>
* The response from <code>CreateDataset</code> is the Amazon Resource Name
* (ARN) for the dataset. Creating a dataset takes a while to complete. Use
* <a>DescribeDataset</a> to check the current status. The dataset created
* successfully if the value of <code>Status</code> is
* <code>CREATE_COMPLETE</code>.
* </p>
* <p>
* To check if any non-terminal errors occurred, call
* <a>ListDatasetEntries</a> and check for the presence of
* <code>errors</code> lists in the JSON Lines.
* </p>
* <p>
* Dataset creation fails if a terminal error occurs (<code>Status</code> =
* <code>CREATE_FAILED</code>). Currently, you can't access the terminal
* error information.
* </p>
* <p>
* For more information, see Creating dataset in the <i>Amazon Rekognition
* Custom Labels Developer Guide</i>.
* </p>
* <p>
* This operation requires permissions to perform the
* <code>rekognition:CreateDataset</code> action. If you want to copy an
* existing dataset, you also require permission to perform the
* <code>rekognition:ListDatasetEntries</code> action.
* </p>
*
* @param createDatasetRequest
* @return createDatasetResult The response from the CreateDataset service
* method, as returned by Amazon Rekognition.
* @throws InternalServerErrorException
* @throws ThrottlingException
* @throws ProvisionedThroughputExceededException
* @throws InvalidParameterException
* @throws AccessDeniedException
* @throws LimitExceededException
* @throws InvalidS3ObjectException
* @throws ResourceAlreadyExistsException
* @throws ResourceNotFoundException
* @throws AmazonClientException If any internal errors are encountered
* inside the client while attempting to make the request or
* handle the response. For example if a network connection is
* not available.
* @throws AmazonServiceException If an error response is returned by Amazon
* Rekognition indicating either a problem with the data in the
* request, or a server side issue.
*/
CreateDatasetResult createDataset(CreateDatasetRequest createDatasetRequest)
throws AmazonClientException, AmazonServiceException;
/**
* <p>
* This API operation initiates a Face Liveness session. It returns a
* <code>SessionId</code>, which you can use to start streaming Face
* Liveness video and get the results for a Face Liveness session.
* </p>
* <p>
* You can use the <code>OutputConfig</code> option in the Settings
* parameter to provide an Amazon S3 bucket location. The Amazon S3 bucket
* stores reference images and audit images. If no Amazon S3 bucket is
* defined, raw bytes are sent instead.
* </p>
* <p>
* You can use <code>AuditImagesLimit</code> to limit the number of audit
* images returned when <code>GetFaceLivenessSessionResults</code> is
* called. This number is between 0 and 4. By default, it is set to 0. The
* limit is best effort and based on the duration of the selfie-video.
* </p>
*
* @param createFaceLivenessSessionRequest
* @return createFaceLivenessSessionResult The response from the
* CreateFaceLivenessSession service method, as returned by Amazon
* Rekognition.
* @throws AccessDeniedException
* @throws InternalServerErrorException